LoadBalancer

Manages a Load Balancer Resource.

Create a LoadBalancer Resource

new LoadBalancer(name: string, args: LoadBalancerArgs, opts?: CustomResourceOptions);

def LoadBalancer(resource_name, opts=None, frontend_ip_configurations=None, location=None, name=None, resource_group_name=None, sku=None, tags=None, __props__=None);

func NewLoadBalancer(ctx *Context, name string, args LoadBalancerArgs, opts ...ResourceOption) (*LoadBalancer, error)

public LoadBalancer(string name, LoadBalancerArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

LoadBalancer Resource Properties

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

Inputs

The LoadBalancer resource accepts the following input properties:

ResourceGroupName string: The name of the Resource Group in which to create the Load Balancer.
FrontendIpConfigurations List<LoadBalancerFrontendIpConfigurationArgs>: One or multiple frontend_ip_configuration blocks as documented below.
Location string: Specifies the supported Azure Region where the Load Balancer should be created.
Name string: Specifies the name of the Load Balancer.
Sku string: The SKU of the Azure Load Balancer. Accepted values are Basic and Standard. Defaults to Basic.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

ResourceGroupName string: The name of the Resource Group in which to create the Load Balancer.
FrontendIpConfigurations []LoadBalancerFrontendIpConfiguration: One or multiple frontend_ip_configuration blocks as documented below.
Location string: Specifies the supported Azure Region where the Load Balancer should be created.
Name string: Specifies the name of the Load Balancer.
Sku string: The SKU of the Azure Load Balancer. Accepted values are Basic and Standard. Defaults to Basic.
Tags map[string]string: A mapping of tags to assign to the resource.

resourceGroupName string: The name of the Resource Group in which to create the Load Balancer.
frontendIpConfigurations LoadBalancerFrontendIpConfiguration[]: One or multiple frontend_ip_configuration blocks as documented below.
location string: Specifies the supported Azure Region where the Load Balancer should be created.
name string: Specifies the name of the Load Balancer.
sku string: The SKU of the Azure Load Balancer. Accepted values are Basic and Standard. Defaults to Basic.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

resource_group_name str: The name of the Resource Group in which to create the Load Balancer.
frontend_ip_configurations List[LoadBalancerFrontendIpConfiguration]: One or multiple frontend_ip_configuration blocks as documented below.
location str: Specifies the supported Azure Region where the Load Balancer should be created.
name str: Specifies the name of the Load Balancer.
sku str: The SKU of the Azure Load Balancer. Accepted values are Basic and Standard. Defaults to Basic.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
PrivateIpAddress string: Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
PrivateIpAddresses List<string>: The list of private IP address assigned to the load balancer in frontend_ip_configuration blocks, if any.

Id string: The provider-assigned unique ID for this managed resource.
PrivateIpAddress string: Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
PrivateIpAddresses []string: The list of private IP address assigned to the load balancer in frontend_ip_configuration blocks, if any.

id string: The provider-assigned unique ID for this managed resource.
privateIpAddress string: Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
privateIpAddresses string[]: The list of private IP address assigned to the load balancer in frontend_ip_configuration blocks, if any.

id str: The provider-assigned unique ID for this managed resource.
private_ip_address str: Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
private_ip_addresses List[str]: The list of private IP address assigned to the load balancer in frontend_ip_configuration blocks, if any.

Look up an 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

static get(resource_name, id, opts=None, frontend_ip_configurations=None, location=None, name=None, private_ip_address=None, private_ip_addresses=None, resource_group_name=None, sku=None, tags=None, __props__=None);

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)

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.

The following state arguments are supported:

FrontendIpConfigurations List<LoadBalancerFrontendIpConfigurationArgs>: One or multiple frontend_ip_configuration blocks as documented below.
Location string: Specifies the supported Azure Region where the Load Balancer should be created.
Name string: Specifies the name of the Load Balancer.
PrivateIpAddress string: Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
PrivateIpAddresses List<string>: The list of private IP address assigned to the load balancer in frontend_ip_configuration blocks, if any.
ResourceGroupName string: The name of the Resource Group in which to create the Load Balancer.
Sku string: The SKU of the Azure Load Balancer. Accepted values are Basic and Standard. Defaults to Basic.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

FrontendIpConfigurations []LoadBalancerFrontendIpConfiguration: One or multiple frontend_ip_configuration blocks as documented below.
Location string: Specifies the supported Azure Region where the Load Balancer should be created.
Name string: Specifies the name of the Load Balancer.
PrivateIpAddress string: Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
PrivateIpAddresses []string: The list of private IP address assigned to the load balancer in frontend_ip_configuration blocks, if any.
ResourceGroupName string: The name of the Resource Group in which to create the Load Balancer.
Sku string: The SKU of the Azure Load Balancer. Accepted values are Basic and Standard. Defaults to Basic.
Tags map[string]string: A mapping of tags to assign to the resource.

frontendIpConfigurations LoadBalancerFrontendIpConfiguration[]: One or multiple frontend_ip_configuration blocks as documented below.
location string: Specifies the supported Azure Region where the Load Balancer should be created.
name string: Specifies the name of the Load Balancer.
privateIpAddress string: Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
privateIpAddresses string[]: The list of private IP address assigned to the load balancer in frontend_ip_configuration blocks, if any.
resourceGroupName string: The name of the Resource Group in which to create the Load Balancer.
sku string: The SKU of the Azure Load Balancer. Accepted values are Basic and Standard. Defaults to Basic.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

frontend_ip_configurations List[LoadBalancerFrontendIpConfiguration]: One or multiple frontend_ip_configuration blocks as documented below.
location str: Specifies the supported Azure Region where the Load Balancer should be created.
name str: Specifies the name of the Load Balancer.
private_ip_address str: Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
private_ip_addresses List[str]: The list of private IP address assigned to the load balancer in frontend_ip_configuration blocks, if any.
resource_group_name str: The name of the Resource Group in which to create the Load Balancer.
sku str: The SKU of the Azure Load Balancer. Accepted values are Basic and Standard. Defaults to Basic.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Supporting Types

LoadBalancerFrontendIpConfiguration

See the input and output API doc for this type.

Name string: Specifies the name of the frontend ip configuration.
Id string: The id of the Frontend IP Configuration.
InboundNatRules List<string>: The list of IDs of inbound rules that use this frontend IP.
LoadBalancerRules List<string>: The list of IDs of load balancing rules that use this frontend IP.
OutboundRules List<string>: The list of IDs outbound rules that use this frontend IP.
PrivateIpAddress string: Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
PrivateIpAddressAllocation string: The allocation method for the Private IP Address used by this Load Balancer. Possible values as Dynamic and Static.
PrivateIpAddressVersion string: The version of IP that the Private IP Address is. Possible values are IPv4 or IPv6.
PublicIpAddressId string: The ID of a Public IP Address which should be associated with the Load Balancer.
PublicIpPrefixId string: The ID of a Public IP Prefix which should be associated with the Load Balancer. Public IP Prefix can only be used with outbound rules.
SubnetId string: The ID of the Subnet which should be associated with the IP Configuration.
Zones string: A list of Availability Zones which the Load Balancer’s IP Addresses should be created in.

Name string: Specifies the name of the frontend ip configuration.
Id string: The id of the Frontend IP Configuration.
InboundNatRules []string: The list of IDs of inbound rules that use this frontend IP.
LoadBalancerRules []string: The list of IDs of load balancing rules that use this frontend IP.
OutboundRules []string: The list of IDs outbound rules that use this frontend IP.
PrivateIpAddress string: Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
PrivateIpAddressAllocation string: The allocation method for the Private IP Address used by this Load Balancer. Possible values as Dynamic and Static.
PrivateIpAddressVersion string: The version of IP that the Private IP Address is. Possible values are IPv4 or IPv6.
PublicIpAddressId string: The ID of a Public IP Address which should be associated with the Load Balancer.
PublicIpPrefixId string: The ID of a Public IP Prefix which should be associated with the Load Balancer. Public IP Prefix can only be used with outbound rules.
SubnetId string: The ID of the Subnet which should be associated with the IP Configuration.
Zones string: A list of Availability Zones which the Load Balancer’s IP Addresses should be created in.

name string: Specifies the name of the frontend ip configuration.
id string: The id of the Frontend IP Configuration.
inboundNatRules string[]: The list of IDs of inbound rules that use this frontend IP.
loadBalancerRules string[]: The list of IDs of load balancing rules that use this frontend IP.
outboundRules string[]: The list of IDs outbound rules that use this frontend IP.
privateIpAddress string: Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
privateIpAddressAllocation string: The allocation method for the Private IP Address used by this Load Balancer. Possible values as Dynamic and Static.
privateIpAddressVersion string: The version of IP that the Private IP Address is. Possible values are IPv4 or IPv6.
publicIpAddressId string: The ID of a Public IP Address which should be associated with the Load Balancer.
publicIpPrefixId string: The ID of a Public IP Prefix which should be associated with the Load Balancer. Public IP Prefix can only be used with outbound rules.
subnetId string: The ID of the Subnet which should be associated with the IP Configuration.
zones string: A list of Availability Zones which the Load Balancer’s IP Addresses should be created in.

name str: Specifies the name of the frontend ip configuration.
id str: The id of the Frontend IP Configuration.
inbound_nat_rules List[str]: The list of IDs of inbound rules that use this frontend IP.
load_balancer_rules List[str]: The list of IDs of load balancing rules that use this frontend IP.
outboundRules List[str]: The list of IDs outbound rules that use this frontend IP.
privateIpAddressAllocation str: The allocation method for the Private IP Address used by this Load Balancer. Possible values as Dynamic and Static.
privateIpAddressVersion str: The version of IP that the Private IP Address is. Possible values are IPv4 or IPv6.
private_ip_address str: Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.
public_ip_address_id str: The ID of a Public IP Address which should be associated with the Load Balancer.
public_ip_prefix_id str: The ID of a Public IP Prefix which should be associated with the Load Balancer. Public IP Prefix can only be used with outbound rules.
subnet_id str: The ID of the Subnet which should be associated with the IP Configuration.
zones str: A list of Availability Zones which the Load Balancer’s IP Addresses should be created in.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud