Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vra Provider
  3. API Docs
  4. LoadBalancer
vra 0.12.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vra

vra.LoadBalancer

Explore with Pulumi AI

vra logo
vra 0.12.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vra

    Creates a VMware vRealize Automation load balancer resource.

    Example Usage

    S

    The following example shows how to create a load balancer resource.

    import * as pulumi from "@pulumi/pulumi";
import * as vra from "@pulumi/vra";

const _this = new vra.LoadBalancer("this", {
    projectId: vra_project["my-project"].id,
    description: "My Load Balancer",
    customProperties: {
        edgeClusterRouterStateLink: "/resources/routers/<uuid>",
        tier0LogicalRouterStateLink: "/resources/routers/<uuid>",
    },
    targets: [{
        machineId: vra_machine.my_machine.id,
    }],
    nics: [{
        networkId: data.vra_network["my-network"].id,
    }],
    routes: [{
        protocol: "TCP",
        port: "80",
        memberProtocol: "TCP",
        memberPort: "80",
        healthCheckConfigurations: [{
            protocol: "TCP",
            port: "80",
            intervalSeconds: 30,
            timeoutSeconds: 10,
            unhealthyThreshold: 2,
            healthyThreshold: 10,
        }],
    }],
});

    import pulumi
import pulumi_vra as vra

this = vra.LoadBalancer("this",
    project_id=vra_project["my-project"]["id"],
    description="My Load Balancer",
    custom_properties={
        "edgeClusterRouterStateLink": "/resources/routers/<uuid>",
        "tier0LogicalRouterStateLink": "/resources/routers/<uuid>",
    },
    targets=[{
        "machine_id": vra_machine["my_machine"]["id"],
    }],
    nics=[{
        "network_id": data["vra_network"]["my-network"]["id"],
    }],
    routes=[{
        "protocol": "TCP",
        "port": "80",
        "member_protocol": "TCP",
        "member_port": "80",
        "health_check_configurations": [{
            "protocol": "TCP",
            "port": "80",
            "interval_seconds": 30,
            "timeout_seconds": 10,
            "unhealthy_threshold": 2,
            "healthy_threshold": 10,
        }],
    }])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vra/vra"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vra.NewLoadBalancer(ctx, "this", &vra.LoadBalancerArgs{
			ProjectId:   pulumi.Any(vra_project.MyProject.Id),
			Description: pulumi.String("My Load Balancer"),
			CustomProperties: pulumi.StringMap{
				"edgeClusterRouterStateLink":  pulumi.String("/resources/routers/<uuid>"),
				"tier0LogicalRouterStateLink": pulumi.String("/resources/routers/<uuid>"),
			},
			Targets: vra.LoadBalancerTargetArray{
				&vra.LoadBalancerTargetArgs{
					MachineId: pulumi.Any(vra_machine.My_machine.Id),
				},
			},
			Nics: vra.LoadBalancerNicArray{
				&vra.LoadBalancerNicArgs{
					NetworkId: pulumi.Any(data.Vra_network.MyNetwork.Id),
				},
			},
			Routes: vra.LoadBalancerRouteArray{
				&vra.LoadBalancerRouteArgs{
					Protocol:       pulumi.String("TCP"),
					Port:           pulumi.String("80"),
					MemberProtocol: pulumi.String("TCP"),
					MemberPort:     pulumi.String("80"),
					HealthCheckConfigurations: vra.LoadBalancerRouteHealthCheckConfigurationArray{
						&vra.LoadBalancerRouteHealthCheckConfigurationArgs{
							Protocol:           pulumi.String("TCP"),
							Port:               pulumi.String("80"),
							IntervalSeconds:    pulumi.Float64(30),
							TimeoutSeconds:     pulumi.Float64(10),
							UnhealthyThreshold: pulumi.Float64(2),
							HealthyThreshold:   pulumi.Float64(10),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vra = Pulumi.Vra;

return await Deployment.RunAsync(() => 
{
    var @this = new Vra.LoadBalancer("this", new()
    {
        ProjectId = vra_project.My_project.Id,
        Description = "My Load Balancer",
        CustomProperties = 
        {
            { "edgeClusterRouterStateLink", "/resources/routers/<uuid>" },
            { "tier0LogicalRouterStateLink", "/resources/routers/<uuid>" },
        },
        Targets = new[]
        {
            new Vra.Inputs.LoadBalancerTargetArgs
            {
                MachineId = vra_machine.My_machine.Id,
            },
        },
        Nics = new[]
        {
            new Vra.Inputs.LoadBalancerNicArgs
            {
                NetworkId = data.Vra_network.My_network.Id,
            },
        },
        Routes = new[]
        {
            new Vra.Inputs.LoadBalancerRouteArgs
            {
                Protocol = "TCP",
                Port = "80",
                MemberProtocol = "TCP",
                MemberPort = "80",
                HealthCheckConfigurations = new[]
                {
                    new Vra.Inputs.LoadBalancerRouteHealthCheckConfigurationArgs
                    {
                        Protocol = "TCP",
                        Port = "80",
                        IntervalSeconds = 30,
                        TimeoutSeconds = 10,
                        UnhealthyThreshold = 2,
                        HealthyThreshold = 10,
                    },
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vra.LoadBalancer;
import com.pulumi.vra.LoadBalancerArgs;
import com.pulumi.vra.inputs.LoadBalancerTargetArgs;
import com.pulumi.vra.inputs.LoadBalancerNicArgs;
import com.pulumi.vra.inputs.LoadBalancerRouteArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var this_ = new LoadBalancer("this", LoadBalancerArgs.builder()
            .projectId(vra_project.my-project().id())
            .description("My Load Balancer")
            .customProperties(Map.ofEntries(
                Map.entry("edgeClusterRouterStateLink", "/resources/routers/<uuid>"),
                Map.entry("tier0LogicalRouterStateLink", "/resources/routers/<uuid>")
            ))
            .targets(LoadBalancerTargetArgs.builder()
                .machineId(vra_machine.my_machine().id())
                .build())
            .nics(LoadBalancerNicArgs.builder()
                .networkId(data.vra_network().my-network().id())
                .build())
            .routes(LoadBalancerRouteArgs.builder()
                .protocol("TCP")
                .port("80")
                .memberProtocol("TCP")
                .memberPort("80")
                .healthCheckConfigurations(LoadBalancerRouteHealthCheckConfigurationArgs.builder()
                    .protocol("TCP")
                    .port("80")
                    .intervalSeconds(30)
                    .timeoutSeconds(10)
                    .unhealthyThreshold(2)
                    .healthyThreshold(10)
                    .build())
                .build())
            .build());

    }
}

    resources:
  this:
    type: vra:LoadBalancer
    properties:
      projectId: ${vra_project"my-project"[%!s(MISSING)].id}
      description: My Load Balancer
      customProperties:
        edgeClusterRouterStateLink: /resources/routers/<uuid>
        tier0LogicalRouterStateLink: /resources/routers/<uuid>
      targets:
        - machineId: ${vra_machine.my_machine.id}
      nics:
        - networkId: ${data.vra_network"my-network"[%!s(MISSING)].id}
      routes:
        - protocol: TCP
          port: '80'
          memberProtocol: TCP
          memberPort: '80'
          healthCheckConfigurations:
            - protocol: TCP
              port: '80'
              intervalSeconds: 30
              timeoutSeconds: 10
              unhealthyThreshold: 2
              healthyThreshold: 10

    A block device resource supports the following arguments:

    Create LoadBalancer Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new LoadBalancer(name: string, args: LoadBalancerArgs, opts?: CustomResourceOptions);
    @overload
def LoadBalancer(resource_name: str,
                 args: LoadBalancerArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def LoadBalancer(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 nics: Optional[Sequence[LoadBalancerNicArgs]] = None,
                 project_id: Optional[str] = None,
                 routes: Optional[Sequence[LoadBalancerRouteArgs]] = None,
                 custom_properties: Optional[Mapping[str, str]] = None,
                 deployment_id: Optional[str] = None,
                 description: Optional[str] = None,
                 internet_facing: Optional[bool] = None,
                 load_balancer_id: Optional[str] = None,
                 name: Optional[str] = None,
                 tags: Optional[Sequence[LoadBalancerTagArgs]] = None,
                 targets: Optional[Sequence[LoadBalancerTargetArgs]] = None)
    func NewLoadBalancer(ctx *Context, name string, args LoadBalancerArgs, opts ...ResourceOption) (*LoadBalancer, error)
    public LoadBalancer(string name, LoadBalancerArgs args, CustomResourceOptions? opts = null)
    public LoadBalancer(String name, LoadBalancerArgs args)
public LoadBalancer(String name, LoadBalancerArgs args, CustomResourceOptions options)

    type: vra:LoadBalancer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args LoadBalancerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args LoadBalancerArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args LoadBalancerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LoadBalancerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LoadBalancerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var loadBalancerResource = new Vra.LoadBalancer("loadBalancerResource", new()
{
    Nics = new[]
    {
        new Vra.Inputs.LoadBalancerNicArgs
        {
            NetworkId = "string",
            Addresses = new[]
            {
                "string",
            },
            CustomProperties = 
            {
                { "string", "string" },
            },
            Description = "string",
            DeviceIndex = 0,
            Name = "string",
            SecurityGroupIds = new[]
            {
                "string",
            },
        },
    },
    ProjectId = "string",
    Routes = new[]
    {
        new Vra.Inputs.LoadBalancerRouteArgs
        {
            MemberPort = "string",
            MemberProtocol = "string",
            Port = "string",
            Protocol = "string",
            HealthCheckConfigurations = new[]
            {
                new Vra.Inputs.LoadBalancerRouteHealthCheckConfigurationArgs
                {
                    Port = "string",
                    Protocol = "string",
                    HealthyThreshold = 0,
                    IntervalSeconds = 0,
                    TimeoutSeconds = 0,
                    UnhealthyThreshold = 0,
                    UrlPath = "string",
                },
            },
        },
    },
    CustomProperties = 
    {
        { "string", "string" },
    },
    DeploymentId = "string",
    Description = "string",
    InternetFacing = false,
    LoadBalancerId = "string",
    Name = "string",
    Tags = new[]
    {
        new Vra.Inputs.LoadBalancerTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    Targets = new[]
    {
        new Vra.Inputs.LoadBalancerTargetArgs
        {
            MachineId = "string",
            NetworkInterfaceId = "string",
        },
    },
});

    example, err := vra.NewLoadBalancer(ctx, "loadBalancerResource", &vra.LoadBalancerArgs{
	Nics: vra.LoadBalancerNicArray{
		&vra.LoadBalancerNicArgs{
			NetworkId: pulumi.String("string"),
			Addresses: pulumi.StringArray{
				pulumi.String("string"),
			},
			CustomProperties: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Description: pulumi.String("string"),
			DeviceIndex: pulumi.Float64(0),
			Name:        pulumi.String("string"),
			SecurityGroupIds: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	ProjectId: pulumi.String("string"),
	Routes: vra.LoadBalancerRouteArray{
		&vra.LoadBalancerRouteArgs{
			MemberPort:     pulumi.String("string"),
			MemberProtocol: pulumi.String("string"),
			Port:           pulumi.String("string"),
			Protocol:       pulumi.String("string"),
			HealthCheckConfigurations: vra.LoadBalancerRouteHealthCheckConfigurationArray{
				&vra.LoadBalancerRouteHealthCheckConfigurationArgs{
					Port:               pulumi.String("string"),
					Protocol:           pulumi.String("string"),
					HealthyThreshold:   pulumi.Float64(0),
					IntervalSeconds:    pulumi.Float64(0),
					TimeoutSeconds:     pulumi.Float64(0),
					UnhealthyThreshold: pulumi.Float64(0),
					UrlPath:            pulumi.String("string"),
				},
			},
		},
	},
	CustomProperties: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DeploymentId:   pulumi.String("string"),
	Description:    pulumi.String("string"),
	InternetFacing: pulumi.Bool(false),
	LoadBalancerId: pulumi.String("string"),
	Name:           pulumi.String("string"),
	Tags: vra.LoadBalancerTagArray{
		&vra.LoadBalancerTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	Targets: vra.LoadBalancerTargetArray{
		&vra.LoadBalancerTargetArgs{
			MachineId:          pulumi.String("string"),
			NetworkInterfaceId: pulumi.String("string"),
		},
	},
})

    var loadBalancerResource = new LoadBalancer("loadBalancerResource", LoadBalancerArgs.builder()
    .nics(LoadBalancerNicArgs.builder()
        .networkId("string")
        .addresses("string")
        .customProperties(Map.of("string", "string"))
        .description("string")
        .deviceIndex(0)
        .name("string")
        .securityGroupIds("string")
        .build())
    .projectId("string")
    .routes(LoadBalancerRouteArgs.builder()
        .memberPort("string")
        .memberProtocol("string")
        .port("string")
        .protocol("string")
        .healthCheckConfigurations(LoadBalancerRouteHealthCheckConfigurationArgs.builder()
            .port("string")
            .protocol("string")
            .healthyThreshold(0)
            .intervalSeconds(0)
            .timeoutSeconds(0)
            .unhealthyThreshold(0)
            .urlPath("string")
            .build())
        .build())
    .customProperties(Map.of("string", "string"))
    .deploymentId("string")
    .description("string")
    .internetFacing(false)
    .loadBalancerId("string")
    .name("string")
    .tags(LoadBalancerTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .targets(LoadBalancerTargetArgs.builder()
        .machineId("string")
        .networkInterfaceId("string")
        .build())
    .build());

    load_balancer_resource = vra.LoadBalancer("loadBalancerResource",
    nics=[{
        "network_id": "string",
        "addresses": ["string"],
        "custom_properties": {
            "string": "string",
        },
        "description": "string",
        "device_index": 0,
        "name": "string",
        "security_group_ids": ["string"],
    }],
    project_id="string",
    routes=[{
        "member_port": "string",
        "member_protocol": "string",
        "port": "string",
        "protocol": "string",
        "health_check_configurations": [{
            "port": "string",
            "protocol": "string",
            "healthy_threshold": 0,
            "interval_seconds": 0,
            "timeout_seconds": 0,
            "unhealthy_threshold": 0,
            "url_path": "string",
        }],
    }],
    custom_properties={
        "string": "string",
    },
    deployment_id="string",
    description="string",
    internet_facing=False,
    load_balancer_id="string",
    name="string",
    tags=[{
        "key": "string",
        "value": "string",
    }],
    targets=[{
        "machine_id": "string",
        "network_interface_id": "string",
    }])

    const loadBalancerResource = new vra.LoadBalancer("loadBalancerResource", {
    nics: [{
        networkId: "string",
        addresses: ["string"],
        customProperties: {
            string: "string",
        },
        description: "string",
        deviceIndex: 0,
        name: "string",
        securityGroupIds: ["string"],
    }],
    projectId: "string",
    routes: [{
        memberPort: "string",
        memberProtocol: "string",
        port: "string",
        protocol: "string",
        healthCheckConfigurations: [{
            port: "string",
            protocol: "string",
            healthyThreshold: 0,
            intervalSeconds: 0,
            timeoutSeconds: 0,
            unhealthyThreshold: 0,
            urlPath: "string",
        }],
    }],
    customProperties: {
        string: "string",
    },
    deploymentId: "string",
    description: "string",
    internetFacing: false,
    loadBalancerId: "string",
    name: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
    targets: [{
        machineId: "string",
        networkInterfaceId: "string",
    }],
});

    type: vra:LoadBalancer
properties:
    customProperties:
        string: string
    deploymentId: string
    description: string
    internetFacing: false
    loadBalancerId: string
    name: string
    nics:
        - addresses:
            - string
          customProperties:
            string: string
          description: string
          deviceIndex: 0
          name: string
          networkId: string
          securityGroupIds:
            - string
    projectId: string
    routes:
        - healthCheckConfigurations:
            - healthyThreshold: 0
              intervalSeconds: 0
              port: string
              protocol: string
              timeoutSeconds: 0
              unhealthyThreshold: 0
              urlPath: string
          memberPort: string
          memberProtocol: string
          port: string
          protocol: string
    tags:
        - key: string
          value: string
    targets:
        - machineId: string
          networkInterfaceId: string

    LoadBalancer Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The LoadBalancer resource accepts the following input properties:

    Nics List<LoadBalancerNic>
    A set of network interface specifications for this load balancer.
    ProjectId string
    The id of the project the current user belongs to.
    Routes List<LoadBalancerRoute>
    The load balancer route configuration regarding ports and protocols.
    CustomProperties Dictionary<string, string>
    Additional custom properties that may be used to extend the machine.
    DeploymentId string
    The id of the deployment that is associated with this resource.
    Description string
    Describes machine within the scope of your organization and is not propagated to the cloud.
    InternetFacing bool
    An Internet-facing load balancer has a publicly resolvable DNS name, so it can route requests from clients over the Internet to the instances that are registered with the load balancer.
    LoadBalancerId string
    Name string
    A human-friendly name used as an identifier in APIs that support this option.
    Tags List<LoadBalancerTag>
    A set of tag keys and optional values that were set on this resource instance. example: [ { "key" : "vmware.enumeration.type", "value": "nebs_block" } ]
    Targets List<LoadBalancerTarget>
    A list of links to target load balancer pool members. Links can be to either a machine or a machine's network interface.
    Nics []LoadBalancerNicArgs
    A set of network interface specifications for this load balancer.
    ProjectId string
    The id of the project the current user belongs to.
    Routes []LoadBalancerRouteArgs
    The load balancer route configuration regarding ports and protocols.
    CustomProperties map[string]string
    Additional custom properties that may be used to extend the machine.
    DeploymentId string
    The id of the deployment that is associated with this resource.
    Description string
    Describes machine within the scope of your organization and is not propagated to the cloud.
    InternetFacing bool
    An Internet-facing load balancer has a publicly resolvable DNS name, so it can route requests from clients over the Internet to the instances that are registered with the load balancer.
    LoadBalancerId string
    Name string
    A human-friendly name used as an identifier in APIs that support this option.
    Tags []LoadBalancerTagArgs
    A set of tag keys and optional values that were set on this resource instance. example: [ { "key" : "vmware.enumeration.type", "value": "nebs_block" } ]
    Targets []LoadBalancerTargetArgs
    A list of links to target load balancer pool members. Links can be to either a machine or a machine's network interface.
    nics List<LoadBalancerNic>
    A set of network interface specifications for this load balancer.
    projectId String
    The id of the project the current user belongs to.
    routes List<LoadBalancerRoute>
    The load balancer route configuration regarding ports and protocols.
    customProperties Map<String,String>
    Additional custom properties that may be used to extend the machine.
    deploymentId String
    The id of the deployment that is associated with this resource.
    description String
    Describes machine within the scope of your organization and is not propagated to the cloud.
    internetFacing Boolean
    An Internet-facing load balancer has a publicly resolvable DNS name, so it can route requests from clients over the Internet to the instances that are registered with the load balancer.
    loadBalancerId String
    name String
    A human-friendly name used as an identifier in APIs that support this option.
    tags List<LoadBalancerTag>
    A set of tag keys and optional values that were set on this resource instance. example: [ { "key" : "vmware.enumeration.type", "value": "nebs_block" } ]
    targets List<LoadBalancerTarget>
    A list of links to target load balancer pool members. Links can be to either a machine or a machine's network interface.
    nics LoadBalancerNic[]
    A set of network interface specifications for this load balancer.
    projectId string
    The id of the project the current user belongs to.
    routes LoadBalancerRoute[]
    The load balancer route configuration regarding ports and protocols.
    customProperties {[key: string]: string}
    Additional custom properties that may be used to extend the machine.
    deploymentId string
    The id of the deployment that is associated with this resource.
    description string
    Describes machine within the scope of your organization and is not propagated to the cloud.
    internetFacing boolean
    An Internet-facing load balancer has a publicly resolvable DNS name, so it can route requests from clients over the Internet to the instances that are registered with the load balancer.
    loadBalancerId string
    name string
    A human-friendly name used as an identifier in APIs that support this option.
    tags LoadBalancerTag[]
    A set of tag keys and optional values that were set on this resource instance. example: [ { "key" : "vmware.enumeration.type", "value": "nebs_block" } ]
    targets LoadBalancerTarget[]
    A list of links to target load balancer pool members. Links can be to either a machine or a machine's network interface.
    nics Sequence[LoadBalancerNicArgs]
    A set of network interface specifications for this load balancer.
    project_id str
    The id of the project the current user belongs to.
    routes Sequence[LoadBalancerRouteArgs]
    The load balancer route configuration regarding ports and protocols.
    custom_properties Mapping[str, str]
    Additional custom properties that may be used to extend the machine.
    deployment_id str
    The id of the deployment that is associated with this resource.
    description str
    Describes machine within the scope of your organization and is not propagated to the cloud.
    internet_facing bool
    An Internet-facing load balancer has a publicly resolvable DNS name, so it can route requests from clients over the Internet to the instances that are registered with the load balancer.
    load_balancer_id str
    name str
    A human-friendly name used as an identifier in APIs that support this option.
    tags Sequence[LoadBalancerTagArgs]
    A set of tag keys and optional values that were set on this resource instance. example: [ { "key" : "vmware.enumeration.type", "value": "nebs_block" } ]
    targets Sequence[LoadBalancerTargetArgs]
    A list of links to target load balancer pool members. Links can be to either a machine or a machine's network interface.
    nics List<Property Map>
    A set of network interface specifications for this load balancer.
    projectId String
    The id of the project the current user belongs to.
    routes List<Property Map>
    The load balancer route configuration regarding ports and protocols.
    customProperties Map<String>
    Additional custom properties that may be used to extend the machine.
    deploymentId String
    The id of the deployment that is associated with this resource.
    description String
    Describes machine within the scope of your organization and is not propagated to the cloud.
    internetFacing Boolean
    An Internet-facing load balancer has a publicly resolvable DNS name, so it can route requests from clients over the Internet to the instances that are registered with the load balancer.
    loadBalancerId String
    name String
    A human-friendly name used as an identifier in APIs that support this option.
    tags List<Property Map>
    A set of tag keys and optional values that were set on this resource instance. example: [ { "key" : "vmware.enumeration.type", "value": "nebs_block" } ]
    targets List<Property Map>
    A list of links to target load balancer pool members. Links can be to either a machine or a machine's network interface.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LoadBalancer resource produces the following output properties:

    Address string
    Primary address allocated or in use by this load balancer. The address could be an in the form of a publicly resolvable DNS name or an IP address.
    CreatedAt string
    Date when the entity was created. The date is in ISO 6801 and UTC.
    ExternalId string
    External entity Id on the provider side.
    ExternalRegionId string
    The external regionId of the resource.
    ExternalZoneId string
    The external regionId of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Links List<LoadBalancerLink>
    HATEOAS of the entity.
    OrganizationId string
    The id of the organization this entity belongs to.
    Owner string
    Email of the user that owns the entity.
    UpdatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    Address string
    Primary address allocated or in use by this load balancer. The address could be an in the form of a publicly resolvable DNS name or an IP address.
    CreatedAt string
    Date when the entity was created. The date is in ISO 6801 and UTC.
    ExternalId string
    External entity Id on the provider side.
    ExternalRegionId string
    The external regionId of the resource.
    ExternalZoneId string
    The external regionId of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Links []LoadBalancerLink
    HATEOAS of the entity.
    OrganizationId string
    The id of the organization this entity belongs to.
    Owner string
    Email of the user that owns the entity.
    UpdatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    address String
    Primary address allocated or in use by this load balancer. The address could be an in the form of a publicly resolvable DNS name or an IP address.
    createdAt String
    Date when the entity was created. The date is in ISO 6801 and UTC.
    externalId String
    External entity Id on the provider side.
    externalRegionId String
    The external regionId of the resource.
    externalZoneId String
    The external regionId of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    links List<LoadBalancerLink>
    HATEOAS of the entity.
    organizationId String
    The id of the organization this entity belongs to.
    owner String
    Email of the user that owns the entity.
    updatedAt String
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    address string
    Primary address allocated or in use by this load balancer. The address could be an in the form of a publicly resolvable DNS name or an IP address.
    createdAt string
    Date when the entity was created. The date is in ISO 6801 and UTC.
    externalId string
    External entity Id on the provider side.
    externalRegionId string
    The external regionId of the resource.
    externalZoneId string
    The external regionId of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    links LoadBalancerLink[]
    HATEOAS of the entity.
    organizationId string
    The id of the organization this entity belongs to.
    owner string
    Email of the user that owns the entity.
    updatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    address str
    Primary address allocated or in use by this load balancer. The address could be an in the form of a publicly resolvable DNS name or an IP address.
    created_at str
    Date when the entity was created. The date is in ISO 6801 and UTC.
    external_id str
    External entity Id on the provider side.
    external_region_id str
    The external regionId of the resource.
    external_zone_id str
    The external regionId of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    links Sequence[LoadBalancerLink]
    HATEOAS of the entity.
    organization_id str
    The id of the organization this entity belongs to.
    owner str
    Email of the user that owns the entity.
    updated_at str
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    address String
    Primary address allocated or in use by this load balancer. The address could be an in the form of a publicly resolvable DNS name or an IP address.
    createdAt String
    Date when the entity was created. The date is in ISO 6801 and UTC.
    externalId String
    External entity Id on the provider side.
    externalRegionId String
    The external regionId of the resource.
    externalZoneId String
    The external regionId of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    links List<Property Map>
    HATEOAS of the entity.
    organizationId String
    The id of the organization this entity belongs to.
    owner String
    Email of the user that owns the entity.
    updatedAt String
    Date when the entity was last updated. The date is ISO 8601 and UTC.

    Look up Existing LoadBalancer Resource

    Get an existing LoadBalancer resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: LoadBalancerState, opts?: CustomResourceOptions): LoadBalancer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address: Optional[str] = None,
        created_at: Optional[str] = None,
        custom_properties: Optional[Mapping[str, str]] = None,
        deployment_id: Optional[str] = None,
        description: Optional[str] = None,
        external_id: Optional[str] = None,
        external_region_id: Optional[str] = None,
        external_zone_id: Optional[str] = None,
        internet_facing: Optional[bool] = None,
        links: Optional[Sequence[LoadBalancerLinkArgs]] = None,
        load_balancer_id: Optional[str] = None,
        name: Optional[str] = None,
        nics: Optional[Sequence[LoadBalancerNicArgs]] = None,
        organization_id: Optional[str] = None,
        owner: Optional[str] = None,
        project_id: Optional[str] = None,
        routes: Optional[Sequence[LoadBalancerRouteArgs]] = None,
        tags: Optional[Sequence[LoadBalancerTagArgs]] = None,
        targets: Optional[Sequence[LoadBalancerTargetArgs]] = None,
        updated_at: Optional[str] = None) -> LoadBalancer
    func GetLoadBalancer(ctx *Context, name string, id IDInput, state *LoadBalancerState, opts ...ResourceOption) (*LoadBalancer, error)
    public static LoadBalancer Get(string name, Input<string> id, LoadBalancerState? state, CustomResourceOptions? opts = null)
    public static LoadBalancer get(String name, Output<String> id, LoadBalancerState state, CustomResourceOptions options)
    resources:  _:    type: vra:LoadBalancer    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Address string
    Primary address allocated or in use by this load balancer. The address could be an in the form of a publicly resolvable DNS name or an IP address.
    CreatedAt string
    Date when the entity was created. The date is in ISO 6801 and UTC.
    CustomProperties Dictionary<string, string>
    Additional custom properties that may be used to extend the machine.
    DeploymentId string
    The id of the deployment that is associated with this resource.
    Description string
    Describes machine within the scope of your organization and is not propagated to the cloud.
    ExternalId string
    External entity Id on the provider side.
    ExternalRegionId string
    The external regionId of the resource.
    ExternalZoneId string
    The external regionId of the resource.
    InternetFacing bool
    An Internet-facing load balancer has a publicly resolvable DNS name, so it can route requests from clients over the Internet to the instances that are registered with the load balancer.
    Links List<LoadBalancerLink>
    HATEOAS of the entity.
    LoadBalancerId string
    Name string
    A human-friendly name used as an identifier in APIs that support this option.
    Nics List<LoadBalancerNic>
    A set of network interface specifications for this load balancer.
    OrganizationId string
    The id of the organization this entity belongs to.
    Owner string
    Email of the user that owns the entity.
    ProjectId string
    The id of the project the current user belongs to.
    Routes List<LoadBalancerRoute>
    The load balancer route configuration regarding ports and protocols.
    Tags List<LoadBalancerTag>
    A set of tag keys and optional values that were set on this resource instance. example: [ { "key" : "vmware.enumeration.type", "value": "nebs_block" } ]
    Targets List<LoadBalancerTarget>
    A list of links to target load balancer pool members. Links can be to either a machine or a machine's network interface.
    UpdatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    Address string
    Primary address allocated or in use by this load balancer. The address could be an in the form of a publicly resolvable DNS name or an IP address.
    CreatedAt string
    Date when the entity was created. The date is in ISO 6801 and UTC.
    CustomProperties map[string]string
    Additional custom properties that may be used to extend the machine.
    DeploymentId string
    The id of the deployment that is associated with this resource.
    Description string
    Describes machine within the scope of your organization and is not propagated to the cloud.
    ExternalId string
    External entity Id on the provider side.
    ExternalRegionId string
    The external regionId of the resource.
    ExternalZoneId string
    The external regionId of the resource.
    InternetFacing bool
    An Internet-facing load balancer has a publicly resolvable DNS name, so it can route requests from clients over the Internet to the instances that are registered with the load balancer.
    Links []LoadBalancerLinkArgs
    HATEOAS of the entity.
    LoadBalancerId string
    Name string
    A human-friendly name used as an identifier in APIs that support this option.
    Nics []LoadBalancerNicArgs
    A set of network interface specifications for this load balancer.
    OrganizationId string
    The id of the organization this entity belongs to.
    Owner string
    Email of the user that owns the entity.
    ProjectId string
    The id of the project the current user belongs to.
    Routes []LoadBalancerRouteArgs
    The load balancer route configuration regarding ports and protocols.
    Tags []LoadBalancerTagArgs
    A set of tag keys and optional values that were set on this resource instance. example: [ { "key" : "vmware.enumeration.type", "value": "nebs_block" } ]
    Targets []LoadBalancerTargetArgs
    A list of links to target load balancer pool members. Links can be to either a machine or a machine's network interface.
    UpdatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    address String
    Primary address allocated or in use by this load balancer. The address could be an in the form of a publicly resolvable DNS name or an IP address.
    createdAt String
    Date when the entity was created. The date is in ISO 6801 and UTC.
    customProperties Map<String,String>
    Additional custom properties that may be used to extend the machine.
    deploymentId String
    The id of the deployment that is associated with this resource.
    description String
    Describes machine within the scope of your organization and is not propagated to the cloud.
    externalId String
    External entity Id on the provider side.
    externalRegionId String
    The external regionId of the resource.
    externalZoneId String
    The external regionId of the resource.
    internetFacing Boolean
    An Internet-facing load balancer has a publicly resolvable DNS name, so it can route requests from clients over the Internet to the instances that are registered with the load balancer.
    links List<LoadBalancerLink>
    HATEOAS of the entity.
    loadBalancerId String
    name String
    A human-friendly name used as an identifier in APIs that support this option.
    nics List<LoadBalancerNic>
    A set of network interface specifications for this load balancer.
    organizationId String
    The id of the organization this entity belongs to.
    owner String
    Email of the user that owns the entity.
    projectId String
    The id of the project the current user belongs to.
    routes List<LoadBalancerRoute>
    The load balancer route configuration regarding ports and protocols.
    tags List<LoadBalancerTag>
    A set of tag keys and optional values that were set on this resource instance. example: [ { "key" : "vmware.enumeration.type", "value": "nebs_block" } ]
    targets List<LoadBalancerTarget>
    A list of links to target load balancer pool members. Links can be to either a machine or a machine's network interface.
    updatedAt String
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    address string
    Primary address allocated or in use by this load balancer. The address could be an in the form of a publicly resolvable DNS name or an IP address.
    createdAt string
    Date when the entity was created. The date is in ISO 6801 and UTC.
    customProperties {[key: string]: string}
    Additional custom properties that may be used to extend the machine.
    deploymentId string
    The id of the deployment that is associated with this resource.
    description string
    Describes machine within the scope of your organization and is not propagated to the cloud.
    externalId string
    External entity Id on the provider side.
    externalRegionId string
    The external regionId of the resource.
    externalZoneId string
    The external regionId of the resource.
    internetFacing boolean
    An Internet-facing load balancer has a publicly resolvable DNS name, so it can route requests from clients over the Internet to the instances that are registered with the load balancer.
    links LoadBalancerLink[]
    HATEOAS of the entity.
    loadBalancerId string
    name string
    A human-friendly name used as an identifier in APIs that support this option.
    nics LoadBalancerNic[]
    A set of network interface specifications for this load balancer.
    organizationId string
    The id of the organization this entity belongs to.
    owner string
    Email of the user that owns the entity.
    projectId string
    The id of the project the current user belongs to.
    routes LoadBalancerRoute[]
    The load balancer route configuration regarding ports and protocols.
    tags LoadBalancerTag[]
    A set of tag keys and optional values that were set on this resource instance. example: [ { "key" : "vmware.enumeration.type", "value": "nebs_block" } ]
    targets LoadBalancerTarget[]
    A list of links to target load balancer pool members. Links can be to either a machine or a machine's network interface.
    updatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    address str
    Primary address allocated or in use by this load balancer. The address could be an in the form of a publicly resolvable DNS name or an IP address.
    created_at str
    Date when the entity was created. The date is in ISO 6801 and UTC.
    custom_properties Mapping[str, str]
    Additional custom properties that may be used to extend the machine.
    deployment_id str
    The id of the deployment that is associated with this resource.
    description str
    Describes machine within the scope of your organization and is not propagated to the cloud.
    external_id str
    External entity Id on the provider side.
    external_region_id str
    The external regionId of the resource.
    external_zone_id str
    The external regionId of the resource.
    internet_facing bool
    An Internet-facing load balancer has a publicly resolvable DNS name, so it can route requests from clients over the Internet to the instances that are registered with the load balancer.
    links Sequence[LoadBalancerLinkArgs]
    HATEOAS of the entity.
    load_balancer_id str
    name str
    A human-friendly name used as an identifier in APIs that support this option.
    nics Sequence[LoadBalancerNicArgs]
    A set of network interface specifications for this load balancer.
    organization_id str
    The id of the organization this entity belongs to.
    owner str
    Email of the user that owns the entity.
    project_id str
    The id of the project the current user belongs to.
    routes Sequence[LoadBalancerRouteArgs]
    The load balancer route configuration regarding ports and protocols.
    tags Sequence[LoadBalancerTagArgs]
    A set of tag keys and optional values that were set on this resource instance. example: [ { "key" : "vmware.enumeration.type", "value": "nebs_block" } ]
    targets Sequence[LoadBalancerTargetArgs]
    A list of links to target load balancer pool members. Links can be to either a machine or a machine's network interface.
    updated_at str
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    address String
    Primary address allocated or in use by this load balancer. The address could be an in the form of a publicly resolvable DNS name or an IP address.
    createdAt String
    Date when the entity was created. The date is in ISO 6801 and UTC.
    customProperties Map<String>
    Additional custom properties that may be used to extend the machine.
    deploymentId String
    The id of the deployment that is associated with this resource.
    description String
    Describes machine within the scope of your organization and is not propagated to the cloud.
    externalId String
    External entity Id on the provider side.
    externalRegionId String
    The external regionId of the resource.
    externalZoneId String
    The external regionId of the resource.
    internetFacing Boolean
    An Internet-facing load balancer has a publicly resolvable DNS name, so it can route requests from clients over the Internet to the instances that are registered with the load balancer.
    links List<Property Map>
    HATEOAS of the entity.
    loadBalancerId String
    name String
    A human-friendly name used as an identifier in APIs that support this option.
    nics List<Property Map>
    A set of network interface specifications for this load balancer.
    organizationId String
    The id of the organization this entity belongs to.
    owner String
    Email of the user that owns the entity.
    projectId String
    The id of the project the current user belongs to.
    routes List<Property Map>
    The load balancer route configuration regarding ports and protocols.
    tags List<Property Map>
    A set of tag keys and optional values that were set on this resource instance. example: [ { "key" : "vmware.enumeration.type", "value": "nebs_block" } ]
    targets List<Property Map>
    A list of links to target load balancer pool members. Links can be to either a machine or a machine's network interface.
    updatedAt String
    Date when the entity was last updated. The date is ISO 8601 and UTC.

    Supporting Types

    Href string
    Hrefs List<string>
    Rel string
    Href string
    Hrefs []string
    Rel string
    href String
    hrefs List<String>
    rel String
    href string
    hrefs string[]
    rel string
    href str
    hrefs Sequence[str]
    rel str
    href String
    hrefs List<String>
    rel String

    LoadBalancerNic, LoadBalancerNicArgs

    NetworkId string
    Addresses List<string>
    CustomProperties Dictionary<string, string>
    Additional custom properties that may be used to extend the machine.
    Description string
    Describes machine within the scope of your organization and is not propagated to the cloud.
    DeviceIndex double
    Name string
    A human-friendly name used as an identifier in APIs that support this option.
    SecurityGroupIds List<string>
    NetworkId string
    Addresses []string
    CustomProperties map[string]string
    Additional custom properties that may be used to extend the machine.
    Description string
    Describes machine within the scope of your organization and is not propagated to the cloud.
    DeviceIndex float64
    Name string
    A human-friendly name used as an identifier in APIs that support this option.
    SecurityGroupIds []string
    networkId String
    addresses List<String>
    customProperties Map<String,String>
    Additional custom properties that may be used to extend the machine.
    description String
    Describes machine within the scope of your organization and is not propagated to the cloud.
    deviceIndex Double
    name String
    A human-friendly name used as an identifier in APIs that support this option.
    securityGroupIds List<String>
    networkId string
    addresses string[]
    customProperties {[key: string]: string}
    Additional custom properties that may be used to extend the machine.
    description string
    Describes machine within the scope of your organization and is not propagated to the cloud.
    deviceIndex number
    name string
    A human-friendly name used as an identifier in APIs that support this option.
    securityGroupIds string[]
    network_id str
    addresses Sequence[str]
    custom_properties Mapping[str, str]
    Additional custom properties that may be used to extend the machine.
    description str
    Describes machine within the scope of your organization and is not propagated to the cloud.
    device_index float
    name str
    A human-friendly name used as an identifier in APIs that support this option.
    security_group_ids Sequence[str]
    networkId String
    addresses List<String>
    customProperties Map<String>
    Additional custom properties that may be used to extend the machine.
    description String
    Describes machine within the scope of your organization and is not propagated to the cloud.
    deviceIndex Number
    name String
    A human-friendly name used as an identifier in APIs that support this option.
    securityGroupIds List<String>

    LoadBalancerRoute, LoadBalancerRouteArgs

    MemberPort string
    Member port where the traffic is routed to.
    MemberProtocol string
    The protocol of the member traffic.
    Port string
    Port which the load balancer is listening to.
    Protocol string
    The protocol of the incoming load balancer requests.
    HealthCheckConfigurations List<LoadBalancerRouteHealthCheckConfiguration>
    Load balancer health check configuration.
    MemberPort string
    Member port where the traffic is routed to.
    MemberProtocol string
    The protocol of the member traffic.
    Port string
    Port which the load balancer is listening to.
    Protocol string
    The protocol of the incoming load balancer requests.
    HealthCheckConfigurations []LoadBalancerRouteHealthCheckConfiguration
    Load balancer health check configuration.
    memberPort String
    Member port where the traffic is routed to.
    memberProtocol String
    The protocol of the member traffic.
    port String
    Port which the load balancer is listening to.
    protocol String
    The protocol of the incoming load balancer requests.
    healthCheckConfigurations List<LoadBalancerRouteHealthCheckConfiguration>
    Load balancer health check configuration.
    memberPort string
    Member port where the traffic is routed to.
    memberProtocol string
    The protocol of the member traffic.
    port string
    Port which the load balancer is listening to.
    protocol string
    The protocol of the incoming load balancer requests.
    healthCheckConfigurations LoadBalancerRouteHealthCheckConfiguration[]
    Load balancer health check configuration.
    member_port str
    Member port where the traffic is routed to.
    member_protocol str
    The protocol of the member traffic.
    port str
    Port which the load balancer is listening to.
    protocol str
    The protocol of the incoming load balancer requests.
    health_check_configurations Sequence[LoadBalancerRouteHealthCheckConfiguration]
    Load balancer health check configuration.
    memberPort String
    Member port where the traffic is routed to.
    memberProtocol String
    The protocol of the member traffic.
    port String
    Port which the load balancer is listening to.
    protocol String
    The protocol of the incoming load balancer requests.
    healthCheckConfigurations List<Property Map>
    Load balancer health check configuration.

    LoadBalancerRouteHealthCheckConfiguration, LoadBalancerRouteHealthCheckConfigurationArgs

    Port string
    Port on the back-end instance machine to use for the health check.
    Protocol string
    The protocol used for the health check.
    HealthyThreshold double
    Number of consecutive successful checks before considering a particular back-end instance as healthy.
    IntervalSeconds double
    Interval (in seconds) at which the health checks will be performed.
    TimeoutSeconds double
    Timeout (in seconds) to wait for a response from the back-end instance.
    UnhealthyThreshold double
    UrlPath string
    Port string
    Port on the back-end instance machine to use for the health check.
    Protocol string
    The protocol used for the health check.
    HealthyThreshold float64
    Number of consecutive successful checks before considering a particular back-end instance as healthy.
    IntervalSeconds float64
    Interval (in seconds) at which the health checks will be performed.
    TimeoutSeconds float64
    Timeout (in seconds) to wait for a response from the back-end instance.
    UnhealthyThreshold float64
    UrlPath string
    port String
    Port on the back-end instance machine to use for the health check.
    protocol String
    The protocol used for the health check.
    healthyThreshold Double
    Number of consecutive successful checks before considering a particular back-end instance as healthy.
    intervalSeconds Double
    Interval (in seconds) at which the health checks will be performed.
    timeoutSeconds Double
    Timeout (in seconds) to wait for a response from the back-end instance.
    unhealthyThreshold Double
    urlPath String
    port string
    Port on the back-end instance machine to use for the health check.
    protocol string
    The protocol used for the health check.
    healthyThreshold number
    Number of consecutive successful checks before considering a particular back-end instance as healthy.
    intervalSeconds number
    Interval (in seconds) at which the health checks will be performed.
    timeoutSeconds number
    Timeout (in seconds) to wait for a response from the back-end instance.
    unhealthyThreshold number
    urlPath string
    port str
    Port on the back-end instance machine to use for the health check.
    protocol str
    The protocol used for the health check.
    healthy_threshold float
    Number of consecutive successful checks before considering a particular back-end instance as healthy.
    interval_seconds float
    Interval (in seconds) at which the health checks will be performed.
    timeout_seconds float
    Timeout (in seconds) to wait for a response from the back-end instance.
    unhealthy_threshold float
    url_path str
    port String
    Port on the back-end instance machine to use for the health check.
    protocol String
    The protocol used for the health check.
    healthyThreshold Number
    Number of consecutive successful checks before considering a particular back-end instance as healthy.
    intervalSeconds Number
    Interval (in seconds) at which the health checks will be performed.
    timeoutSeconds Number
    Timeout (in seconds) to wait for a response from the back-end instance.
    unhealthyThreshold Number
    urlPath String

    LoadBalancerTag, LoadBalancerTagArgs

    Key string
    Tag’s key.
    Value string
    Tag’s value.
    Key string
    Tag’s key.
    Value string
    Tag’s value.
    key String
    Tag’s key.
    value String
    Tag’s value.
    key string
    Tag’s key.
    value string
    Tag’s value.
    key str
    Tag’s key.
    value str
    Tag’s value.
    key String
    Tag’s key.
    value String
    Tag’s value.

    LoadBalancerTarget, LoadBalancerTargetArgs

    Package Details

    Repository
    vra vmware/terraform-provider-vra
    License
    Notes
    This Pulumi package is based on the vra Terraform Provider.
    vra logo
    vra 0.12.0 published on Monday, Apr 14, 2025 by vmware
    vmware/terraform-provider-vra