This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

lb¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.lb.AwaitableGetBackendAddressPoolResult(backend_ip_configurations=None, id=None, loadbalancer_id=None, name=None)¶

class pulumi_azure.lb.AwaitableGetLBResult(frontend_ip_configurations=None, id=None, location=None, name=None, private_ip_address=None, private_ip_addresses=None, resource_group_name=None, sku=None, tags=None)¶

class pulumi_azure.lb.BackendAddressPool(resource_name, opts=None, loadbalancer_id=None, name=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Load Balancer Backend Address Pool.

NOTE: When using this resource, the Load Balancer needs to have a FrontEnd IP Configuration Attached

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_public_ip = azure.network.PublicIp("examplePublicIp",
    location="West US",
    resource_group_name=example_resource_group.name,
    allocation_method="Static")
example_load_balancer = azure.lb.LoadBalancer("exampleLoadBalancer",
    location="West US",
    resource_group_name=example_resource_group.name,
    frontend_ip_configuration=[{
        "name": "PublicIPAddress",
        "public_ip_address_id": example_public_ip.id,
    }])
example_backend_address_pool = azure.lb.BackendAddressPool("exampleBackendAddressPool",
    resource_group_name=example_resource_group.name,
    loadbalancer_id=example_load_balancer.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
loadbalancer_id (pulumi.Input[str]) – The ID of the Load Balancer in which to create the Backend Address Pool.
name (pulumi.Input[str]) – Specifies the name of the Backend Address Pool.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the resource.

backend_ip_configurations: pulumi.Output[list] = None¶: The Backend IP Configurations associated with this Backend Address Pool.

load_balancing_rules: pulumi.Output[list] = None¶: The Load Balancing Rules associated with this Backend Address Pool.

loadbalancer_id: pulumi.Output[str] = None¶: The ID of the Load Balancer in which to create the Backend Address Pool.

name: pulumi.Output[str] = None¶: Specifies the name of the Backend Address Pool.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the resource.

static get(resource_name, id, opts=None, backend_ip_configurations=None, load_balancing_rules=None, loadbalancer_id=None, name=None, resource_group_name=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
backend_ip_configurations (pulumi.Input[list]) – The Backend IP Configurations associated with this Backend Address Pool.
load_balancing_rules (pulumi.Input[list]) – The Load Balancing Rules associated with this Backend Address Pool.
loadbalancer_id (pulumi.Input[str]) – The ID of the Load Balancer in which to create the Backend Address Pool.
name (pulumi.Input[str]) – Specifies the name of the Backend Address Pool.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.lb.GetBackendAddressPoolResult(backend_ip_configurations=None, id=None, loadbalancer_id=None, name=None)¶

A collection of values returned by getBackendAddressPool.

backend_ip_configurations = None¶: An array of references to IP addresses defined in network interfaces.

id = None¶: The provider-assigned unique ID for this managed resource.

name = None¶: The name of the Backend Address Pool.

class pulumi_azure.lb.GetLBResult(frontend_ip_configurations=None, id=None, location=None, name=None, private_ip_address=None, private_ip_addresses=None, resource_group_name=None, sku=None, tags=None)¶

A collection of values returned by getLB.

frontend_ip_configurations = None¶: (Optional) A frontend_ip_configuration block as documented below.

id = None¶: The provider-assigned unique ID for this managed resource.

location = None¶: The Azure location where the Load Balancer exists.

name = None¶: The name of the Frontend IP Configuration.

private_ip_address = None¶: Private IP Address to assign to the Load Balancer.

private_ip_addresses = None¶: The list of private IP address assigned to the load balancer in frontend_ip_configuration blocks, if any.

sku = None¶: The SKU of the Load Balancer.

tags = None¶: A mapping of tags assigned to the resource.

class pulumi_azure.lb.LoadBalancer(resource_name, opts=None, frontend_ip_configurations=None, location=None, name=None, resource_group_name=None, sku=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Load Balancer Resource.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_public_ip = azure.network.PublicIp("examplePublicIp",
    location="West US",
    resource_group_name=example_resource_group.name,
    allocation_method="Static")
example_load_balancer = azure.lb.LoadBalancer("exampleLoadBalancer",
    location="West US",
    resource_group_name=example_resource_group.name,
    frontend_ip_configuration=[{
        "name": "PublicIPAddress",
        "public_ip_address_id": example_public_ip.id,
    }])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
frontend_ip_configurations (pulumi.Input[list]) – One or multiple frontend_ip_configuration blocks as documented below.
location (pulumi.Input[str]) – Specifies the supported Azure Region where the Load Balancer should be created.
name (pulumi.Input[str]) – Specifies the name of the Load Balancer.
resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which to create the Load Balancer.
sku (pulumi.Input[str]) – The SKU of the Azure Load Balancer. Accepted values are Basic and Standard. Defaults to Basic.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The frontend_ip_configurations object supports the following:

id (pulumi.Input[str]) - The id of the Frontend IP Configuration.
inbound_nat_rules (pulumi.Input[list]) - The list of IDs of inbound rules that use this frontend IP.
load_balancer_rules (pulumi.Input[list]) - The list of IDs of load balancing rules that use this frontend IP.
name (pulumi.Input[str]) - Specifies the name of the frontend ip configuration.
outboundRules (pulumi.Input[list]) - The list of IDs outbound rules that use this frontend IP.
private_ip_address (pulumi.Input[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.
privateIpAddressAllocation (pulumi.Input[str]) - The allocation method for the Private IP Address used by this Load Balancer. Possible values as Dynamic and Static.
privateIpAddressVersion (pulumi.Input[str]) - The version of IP that the Private IP Address is. Possible values are IPv4 or IPv6.
public_ip_address_id (pulumi.Input[str]) - The ID of a Public IP Address which should be associated with the Load Balancer.
public_ip_prefix_id (pulumi.Input[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 (pulumi.Input[str]) - The ID of the Subnet which should be associated with the IP Configuration.
zones (pulumi.Input[str]) - A list of Availability Zones which the Load Balancer’s IP Addresses should be created in.

frontend_ip_configurations: pulumi.Output[list] = None¶

One or multiple frontend_ip_configuration blocks as documented below.

id (str) - The id of the Frontend IP Configuration.
inbound_nat_rules (list) - The list of IDs of inbound rules that use this frontend IP.
load_balancer_rules (list) - The list of IDs of load balancing rules that use this frontend IP.
name (str) - Specifies the name of the frontend ip configuration.
outboundRules (list) - The list of IDs outbound rules that use this frontend IP.
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.
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.
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.

location: pulumi.Output[str] = None¶: Specifies the supported Azure Region where the Load Balancer should be created.

name: pulumi.Output[str] = None¶: Specifies the name of the Load Balancer.

private_ip_address: pulumi.Output[str] = None¶: 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: pulumi.Output[list] = None¶: The list of private IP address assigned to the load balancer in frontend_ip_configuration blocks, if any.

resource_group_name: pulumi.Output[str] = None¶: The name of the Resource Group in which to create the Load Balancer.

sku: pulumi.Output[str] = None¶: The SKU of the Azure Load Balancer. Accepted values are Basic and Standard. Defaults to Basic.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

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)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
frontend_ip_configurations (pulumi.Input[list]) – One or multiple frontend_ip_configuration blocks as documented below.
location (pulumi.Input[str]) – Specifies the supported Azure Region where the Load Balancer should be created.
name (pulumi.Input[str]) – Specifies the name of the Load Balancer.
private_ip_address (pulumi.Input[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 (pulumi.Input[list]) – The list of private IP address assigned to the load balancer in frontend_ip_configuration blocks, if any.
resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which to create the Load Balancer.
sku (pulumi.Input[str]) – The SKU of the Azure Load Balancer. Accepted values are Basic and Standard. Defaults to Basic.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The frontend_ip_configurations object supports the following:

id (pulumi.Input[str]) - The id of the Frontend IP Configuration.
inbound_nat_rules (pulumi.Input[list]) - The list of IDs of inbound rules that use this frontend IP.
load_balancer_rules (pulumi.Input[list]) - The list of IDs of load balancing rules that use this frontend IP.
name (pulumi.Input[str]) - Specifies the name of the frontend ip configuration.
outboundRules (pulumi.Input[list]) - The list of IDs outbound rules that use this frontend IP.
private_ip_address (pulumi.Input[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.
privateIpAddressAllocation (pulumi.Input[str]) - The allocation method for the Private IP Address used by this Load Balancer. Possible values as Dynamic and Static.
privateIpAddressVersion (pulumi.Input[str]) - The version of IP that the Private IP Address is. Possible values are IPv4 or IPv6.
public_ip_address_id (pulumi.Input[str]) - The ID of a Public IP Address which should be associated with the Load Balancer.
public_ip_prefix_id (pulumi.Input[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 (pulumi.Input[str]) - The ID of the Subnet which should be associated with the IP Configuration.
zones (pulumi.Input[str]) - A list of Availability Zones which the Load Balancer’s IP Addresses should be created in.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.lb.NatPool(resource_name, opts=None, backend_port=None, frontend_ip_configuration_name=None, frontend_port_end=None, frontend_port_start=None, loadbalancer_id=None, name=None, protocol=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Load Balancer NAT pool.

NOTE: This resource cannot be used with with virtual machines, instead use the lb.NatRule resource.
NOTE When using this resource, the Load Balancer needs to have a FrontEnd IP Configuration Attached

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_public_ip = azure.network.PublicIp("examplePublicIp",
    location="West US",
    resource_group_name=example_resource_group.name,
    allocation_method="Static")
example_load_balancer = azure.lb.LoadBalancer("exampleLoadBalancer",
    location="West US",
    resource_group_name=example_resource_group.name,
    frontend_ip_configuration=[{
        "name": "PublicIPAddress",
        "public_ip_address_id": example_public_ip.id,
    }])
example_nat_pool = azure.lb.NatPool("exampleNatPool",
    resource_group_name=example_resource_group.name,
    loadbalancer_id=example_load_balancer.id,
    protocol="Tcp",
    frontend_port_start=80,
    frontend_port_end=81,
    backend_port=8080,
    frontend_ip_configuration_name="PublicIPAddress")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
backend_port (pulumi.Input[float]) – The port used for the internal endpoint. Possible values range between 1 and 65535, inclusive.
frontend_ip_configuration_name (pulumi.Input[str]) – The name of the frontend IP configuration exposing this rule.
frontend_port_end (pulumi.Input[float]) – The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.
frontend_port_start (pulumi.Input[float]) – The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.
loadbalancer_id (pulumi.Input[str]) – The ID of the Load Balancer in which to create the NAT pool.
name (pulumi.Input[str]) – Specifies the name of the NAT pool.
protocol (pulumi.Input[str]) – The transport protocol for the external endpoint. Possible values are Udp or Tcp.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the resource.

backend_port: pulumi.Output[float] = None¶: The port used for the internal endpoint. Possible values range between 1 and 65535, inclusive.

frontend_ip_configuration_name: pulumi.Output[str] = None¶: The name of the frontend IP configuration exposing this rule.

frontend_port_end: pulumi.Output[float] = None¶: The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.

frontend_port_start: pulumi.Output[float] = None¶: The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.

loadbalancer_id: pulumi.Output[str] = None¶: The ID of the Load Balancer in which to create the NAT pool.

name: pulumi.Output[str] = None¶: Specifies the name of the NAT pool.

protocol: pulumi.Output[str] = None¶: The transport protocol for the external endpoint. Possible values are Udp or Tcp.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the resource.

static get(resource_name, id, opts=None, backend_port=None, frontend_ip_configuration_id=None, frontend_ip_configuration_name=None, frontend_port_end=None, frontend_port_start=None, loadbalancer_id=None, name=None, protocol=None, resource_group_name=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
backend_port (pulumi.Input[float]) – The port used for the internal endpoint. Possible values range between 1 and 65535, inclusive.
frontend_ip_configuration_name (pulumi.Input[str]) – The name of the frontend IP configuration exposing this rule.
frontend_port_end (pulumi.Input[float]) – The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.
frontend_port_start (pulumi.Input[float]) – The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.
loadbalancer_id (pulumi.Input[str]) – The ID of the Load Balancer in which to create the NAT pool.
name (pulumi.Input[str]) – Specifies the name of the NAT pool.
protocol (pulumi.Input[str]) – The transport protocol for the external endpoint. Possible values are Udp or Tcp.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.lb.NatRule(resource_name, opts=None, backend_port=None, enable_floating_ip=None, enable_tcp_reset=None, frontend_ip_configuration_name=None, frontend_port=None, idle_timeout_in_minutes=None, loadbalancer_id=None, name=None, protocol=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Load Balancer NAT Rule.

NOTE: This resource cannot be used with with virtual machine scale sets, instead use the lb.NatPool resource.
NOTE When using this resource, the Load Balancer needs to have a FrontEnd IP Configuration Attached

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_public_ip = azure.network.PublicIp("examplePublicIp",
    location="West US",
    resource_group_name=example_resource_group.name,
    allocation_method="Static")
example_load_balancer = azure.lb.LoadBalancer("exampleLoadBalancer",
    location="West US",
    resource_group_name=example_resource_group.name,
    frontend_ip_configuration=[{
        "name": "PublicIPAddress",
        "public_ip_address_id": example_public_ip.id,
    }])
example_nat_rule = azure.lb.NatRule("exampleNatRule",
    resource_group_name=example_resource_group.name,
    loadbalancer_id=example_load_balancer.id,
    protocol="Tcp",
    frontend_port=3389,
    backend_port=3389,
    frontend_ip_configuration_name="PublicIPAddress")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
backend_port (pulumi.Input[float]) – The port used for internal connections on the endpoint. Possible values range between 1 and 65535, inclusive.
enable_floating_ip (pulumi.Input[bool]) – Are the Floating IPs enabled for this Load Balncer Rule? A “floating” IP is reassigned to a secondary server in case the primary server fails. Required to configure a SQL AlwaysOn Availability Group. Defaults to false.
enable_tcp_reset (pulumi.Input[bool]) – Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.
frontend_ip_configuration_name (pulumi.Input[str]) – The name of the frontend IP configuration exposing this rule.
frontend_port (pulumi.Input[float]) – The port for the external endpoint. Port numbers for each Rule must be unique within the Load Balancer. Possible values range between 1 and 65534, inclusive.
idle_timeout_in_minutes (pulumi.Input[float]) – Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.
loadbalancer_id (pulumi.Input[str]) – The ID of the Load Balancer in which to create the NAT Rule.
name (pulumi.Input[str]) – Specifies the name of the NAT Rule.
protocol (pulumi.Input[str]) – The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the resource.

backend_port: pulumi.Output[float] = None¶: The port used for internal connections on the endpoint. Possible values range between 1 and 65535, inclusive.

enable_floating_ip: pulumi.Output[bool] = None¶: Are the Floating IPs enabled for this Load Balncer Rule? A “floating” IP is reassigned to a secondary server in case the primary server fails. Required to configure a SQL AlwaysOn Availability Group. Defaults to false.

enable_tcp_reset: pulumi.Output[bool] = None¶: Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.

frontend_ip_configuration_name: pulumi.Output[str] = None¶: The name of the frontend IP configuration exposing this rule.

frontend_port: pulumi.Output[float] = None¶: The port for the external endpoint. Port numbers for each Rule must be unique within the Load Balancer. Possible values range between 1 and 65534, inclusive.

idle_timeout_in_minutes: pulumi.Output[float] = None¶: Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.

loadbalancer_id: pulumi.Output[str] = None¶: The ID of the Load Balancer in which to create the NAT Rule.

name: pulumi.Output[str] = None¶: Specifies the name of the NAT Rule.

protocol: pulumi.Output[str] = None¶: The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the resource.

static get(resource_name, id, opts=None, backend_ip_configuration_id=None, backend_port=None, enable_floating_ip=None, enable_tcp_reset=None, frontend_ip_configuration_id=None, frontend_ip_configuration_name=None, frontend_port=None, idle_timeout_in_minutes=None, loadbalancer_id=None, name=None, protocol=None, resource_group_name=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
backend_port (pulumi.Input[float]) – The port used for internal connections on the endpoint. Possible values range between 1 and 65535, inclusive.
enable_floating_ip (pulumi.Input[bool]) – Are the Floating IPs enabled for this Load Balncer Rule? A “floating” IP is reassigned to a secondary server in case the primary server fails. Required to configure a SQL AlwaysOn Availability Group. Defaults to false.
enable_tcp_reset (pulumi.Input[bool]) – Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.
frontend_ip_configuration_name (pulumi.Input[str]) – The name of the frontend IP configuration exposing this rule.
frontend_port (pulumi.Input[float]) – The port for the external endpoint. Port numbers for each Rule must be unique within the Load Balancer. Possible values range between 1 and 65534, inclusive.
idle_timeout_in_minutes (pulumi.Input[float]) – Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.
loadbalancer_id (pulumi.Input[str]) – The ID of the Load Balancer in which to create the NAT Rule.
name (pulumi.Input[str]) – Specifies the name of the NAT Rule.
protocol (pulumi.Input[str]) – The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.lb.OutboundRule(resource_name, opts=None, allocated_outbound_ports=None, backend_address_pool_id=None, enable_tcp_reset=None, frontend_ip_configurations=None, idle_timeout_in_minutes=None, loadbalancer_id=None, name=None, protocol=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Load Balancer Outbound Rule.

NOTE When using this resource, the Load Balancer needs to have a FrontEnd IP Configuration and a Backend Address Pool Attached.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_public_ip = azure.network.PublicIp("examplePublicIp",
    location="West US",
    resource_group_name=example_resource_group.name,
    allocation_method="Static")
example_load_balancer = azure.lb.LoadBalancer("exampleLoadBalancer",
    location="West US",
    resource_group_name=example_resource_group.name,
    frontend_ip_configuration=[{
        "name": "PublicIPAddress",
        "public_ip_address_id": example_public_ip.id,
    }])
example_backend_address_pool = azure.lb.BackendAddressPool("exampleBackendAddressPool",
    resource_group_name=example_resource_group.name,
    loadbalancer_id=example_load_balancer.id)
example_outbound_rule = azure.lb.OutboundRule("exampleOutboundRule",
    resource_group_name=example_resource_group.name,
    loadbalancer_id=example_load_balancer.id,
    protocol="Tcp",
    backend_address_pool_id=example_backend_address_pool.id,
    frontend_ip_configuration=[{
        "name": "PublicIPAddress",
    }])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
allocated_outbound_ports (pulumi.Input[float]) – The number of outbound ports to be used for NAT.
backend_address_pool_id (pulumi.Input[str]) – The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
enable_tcp_reset (pulumi.Input[bool]) – Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.
frontend_ip_configurations (pulumi.Input[list]) – One or more frontend_ip_configuration blocks as defined below.
idle_timeout_in_minutes (pulumi.Input[float]) – The timeout for the TCP idle connection
loadbalancer_id (pulumi.Input[str]) – The ID of the Load Balancer in which to create the Outbound Rule. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Outbound Rule. Changing this forces a new resource to be created.
protocol (pulumi.Input[str]) – The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the resource. Changing this forces a new resource to be created.

The frontend_ip_configurations object supports the following:

id (pulumi.Input[str]) - The ID of the Load Balancer Outbound Rule.
name (pulumi.Input[str]) - The name of the Frontend IP Configuration.

allocated_outbound_ports: pulumi.Output[float] = None¶: The number of outbound ports to be used for NAT.

backend_address_pool_id: pulumi.Output[str] = None¶: The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.

enable_tcp_reset: pulumi.Output[bool] = None¶: Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.

frontend_ip_configurations: pulumi.Output[list] = None¶

One or more frontend_ip_configuration blocks as defined below.

id (str) - The ID of the Load Balancer Outbound Rule.
name (str) - The name of the Frontend IP Configuration.

idle_timeout_in_minutes: pulumi.Output[float] = None¶: The timeout for the TCP idle connection

loadbalancer_id: pulumi.Output[str] = None¶: The ID of the Load Balancer in which to create the Outbound Rule. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the Outbound Rule. Changing this forces a new resource to be created.

protocol: pulumi.Output[str] = None¶: The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the resource. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, allocated_outbound_ports=None, backend_address_pool_id=None, enable_tcp_reset=None, frontend_ip_configurations=None, idle_timeout_in_minutes=None, loadbalancer_id=None, name=None, protocol=None, resource_group_name=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
allocated_outbound_ports (pulumi.Input[float]) – The number of outbound ports to be used for NAT.
backend_address_pool_id (pulumi.Input[str]) – The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
enable_tcp_reset (pulumi.Input[bool]) – Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.
frontend_ip_configurations (pulumi.Input[list]) – One or more frontend_ip_configuration blocks as defined below.
idle_timeout_in_minutes (pulumi.Input[float]) – The timeout for the TCP idle connection
loadbalancer_id (pulumi.Input[str]) – The ID of the Load Balancer in which to create the Outbound Rule. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Outbound Rule. Changing this forces a new resource to be created.
protocol (pulumi.Input[str]) – The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the resource. Changing this forces a new resource to be created.

The frontend_ip_configurations object supports the following:

id (pulumi.Input[str]) - The ID of the Load Balancer Outbound Rule.
name (pulumi.Input[str]) - The name of the Frontend IP Configuration.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.lb.Probe(resource_name, opts=None, interval_in_seconds=None, loadbalancer_id=None, name=None, number_of_probes=None, port=None, protocol=None, request_path=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)¶

Manages a LoadBalancer Probe Resource.

NOTE When using this resource, the Load Balancer needs to have a FrontEnd IP Configuration Attached

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_public_ip = azure.network.PublicIp("examplePublicIp",
    location="West US",
    resource_group_name=example_resource_group.name,
    allocation_method="Static")
example_load_balancer = azure.lb.LoadBalancer("exampleLoadBalancer",
    location="West US",
    resource_group_name=example_resource_group.name,
    frontend_ip_configuration=[{
        "name": "PublicIPAddress",
        "public_ip_address_id": example_public_ip.id,
    }])
example_probe = azure.lb.Probe("exampleProbe",
    resource_group_name=example_resource_group.name,
    loadbalancer_id=example_load_balancer.id,
    port=22)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
interval_in_seconds (pulumi.Input[float]) – The interval, in seconds between probes to the backend endpoint for health status. The default value is 15, the minimum value is 5.
loadbalancer_id (pulumi.Input[str]) – The ID of the LoadBalancer in which to create the NAT Rule.
name (pulumi.Input[str]) – Specifies the name of the Probe.
number_of_probes (pulumi.Input[float]) – The number of failed probe attempts after which the backend endpoint is removed from rotation. The default value is 2. NumberOfProbes multiplied by intervalInSeconds value must be greater or equal to 10.Endpoints are returned to rotation when at least one probe is successful.
port (pulumi.Input[float]) – Port on which the Probe queries the backend endpoint. Possible values range from 1 to 65535, inclusive.
protocol (pulumi.Input[str]) – Specifies the protocol of the end point. Possible values are Http, Https or Tcp. If Tcp is specified, a received ACK is required for the probe to be successful. If Http is specified, a 200 OK response from the specified URI is required for the probe to be successful.
request_path (pulumi.Input[str]) – The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http. Otherwise, it is not allowed.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the resource.

interval_in_seconds: pulumi.Output[float] = None¶: The interval, in seconds between probes to the backend endpoint for health status. The default value is 15, the minimum value is 5.

loadbalancer_id: pulumi.Output[str] = None¶: The ID of the LoadBalancer in which to create the NAT Rule.

name: pulumi.Output[str] = None¶: Specifies the name of the Probe.

number_of_probes: pulumi.Output[float] = None¶: The number of failed probe attempts after which the backend endpoint is removed from rotation. The default value is 2. NumberOfProbes multiplied by intervalInSeconds value must be greater or equal to 10.Endpoints are returned to rotation when at least one probe is successful.

port: pulumi.Output[float] = None¶: Port on which the Probe queries the backend endpoint. Possible values range from 1 to 65535, inclusive.

protocol: pulumi.Output[str] = None¶: Specifies the protocol of the end point. Possible values are Http, Https or Tcp. If Tcp is specified, a received ACK is required for the probe to be successful. If Http is specified, a 200 OK response from the specified URI is required for the probe to be successful.

request_path: pulumi.Output[str] = None¶: The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http. Otherwise, it is not allowed.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the resource.

static get(resource_name, id, opts=None, interval_in_seconds=None, load_balancer_rules=None, loadbalancer_id=None, name=None, number_of_probes=None, port=None, protocol=None, request_path=None, resource_group_name=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
interval_in_seconds (pulumi.Input[float]) – The interval, in seconds between probes to the backend endpoint for health status. The default value is 15, the minimum value is 5.
loadbalancer_id (pulumi.Input[str]) – The ID of the LoadBalancer in which to create the NAT Rule.
name (pulumi.Input[str]) – Specifies the name of the Probe.
number_of_probes (pulumi.Input[float]) – The number of failed probe attempts after which the backend endpoint is removed from rotation. The default value is 2. NumberOfProbes multiplied by intervalInSeconds value must be greater or equal to 10.Endpoints are returned to rotation when at least one probe is successful.
port (pulumi.Input[float]) – Port on which the Probe queries the backend endpoint. Possible values range from 1 to 65535, inclusive.
protocol (pulumi.Input[str]) – Specifies the protocol of the end point. Possible values are Http, Https or Tcp. If Tcp is specified, a received ACK is required for the probe to be successful. If Http is specified, a 200 OK response from the specified URI is required for the probe to be successful.
request_path (pulumi.Input[str]) – The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http. Otherwise, it is not allowed.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.lb.Rule(resource_name, opts=None, backend_address_pool_id=None, backend_port=None, disable_outbound_snat=None, enable_floating_ip=None, enable_tcp_reset=None, frontend_ip_configuration_name=None, frontend_port=None, idle_timeout_in_minutes=None, load_distribution=None, loadbalancer_id=None, name=None, probe_id=None, protocol=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Load Balancer Rule.

NOTE When using this resource, the Load Balancer needs to have a FrontEnd IP Configuration Attached

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_public_ip = azure.network.PublicIp("examplePublicIp",
    location="West US",
    resource_group_name=example_resource_group.name,
    allocation_method="Static")
example_load_balancer = azure.lb.LoadBalancer("exampleLoadBalancer",
    location="West US",
    resource_group_name=example_resource_group.name,
    frontend_ip_configuration=[{
        "name": "PublicIPAddress",
        "public_ip_address_id": example_public_ip.id,
    }])
example_rule = azure.lb.Rule("exampleRule",
    resource_group_name=example_resource_group.name,
    loadbalancer_id=example_load_balancer.id,
    protocol="Tcp",
    frontend_port=3389,
    backend_port=3389,
    frontend_ip_configuration_name="PublicIPAddress")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
backend_address_pool_id (pulumi.Input[str]) – A reference to a Backend Address Pool over which this Load Balancing Rule operates.
backend_port (pulumi.Input[float]) – The port used for internal connections on the endpoint. Possible values range between 0 and 65535, inclusive.
disable_outbound_snat (pulumi.Input[bool]) – Is snat enabled for this Load Balancer Rule? Default false.
enable_floating_ip (pulumi.Input[bool]) – Are the Floating IPs enabled for this Load Balncer Rule? A “floating” IP is reassigned to a secondary server in case the primary server fails. Required to configure a SQL AlwaysOn Availability Group. Defaults to false.
enable_tcp_reset (pulumi.Input[bool]) – Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.
frontend_ip_configuration_name (pulumi.Input[str]) – The name of the frontend IP configuration to which the rule is associated.
frontend_port (pulumi.Input[float]) – The port for the external endpoint. Port numbers for each Rule must be unique within the Load Balancer. Possible values range between 0 and 65534, inclusive.
idle_timeout_in_minutes (pulumi.Input[float]) – Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.
load_distribution (pulumi.Input[str]) – Specifies the load balancing distribution type to be used by the Load Balancer. Possible values are: Default – The load balancer is configured to use a 5 tuple hash to map traffic to available servers. SourceIP – The load balancer is configured to use a 2 tuple hash to map traffic to available servers. SourceIPProtocol – The load balancer is configured to use a 3 tuple hash to map traffic to available servers. Also known as Session Persistence, where the options are called None, Client IP and Client IP and Protocol respectively.
loadbalancer_id (pulumi.Input[str]) – The ID of the Load Balancer in which to create the Rule.
name (pulumi.Input[str]) – Specifies the name of the LB Rule.
probe_id (pulumi.Input[str]) – A reference to a Probe used by this Load Balancing Rule.
protocol (pulumi.Input[str]) – The transport protocol for the external endpoint. Possible values are Tcp, Udp or All.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the resource.

backend_address_pool_id: pulumi.Output[str] = None¶: A reference to a Backend Address Pool over which this Load Balancing Rule operates.

backend_port: pulumi.Output[float] = None¶: The port used for internal connections on the endpoint. Possible values range between 0 and 65535, inclusive.

disable_outbound_snat: pulumi.Output[bool] = None¶: Is snat enabled for this Load Balancer Rule? Default false.

enable_floating_ip: pulumi.Output[bool] = None¶: Are the Floating IPs enabled for this Load Balncer Rule? A “floating” IP is reassigned to a secondary server in case the primary server fails. Required to configure a SQL AlwaysOn Availability Group. Defaults to false.

enable_tcp_reset: pulumi.Output[bool] = None¶: Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.

frontend_ip_configuration_name: pulumi.Output[str] = None¶: The name of the frontend IP configuration to which the rule is associated.

frontend_port: pulumi.Output[float] = None¶: The port for the external endpoint. Port numbers for each Rule must be unique within the Load Balancer. Possible values range between 0 and 65534, inclusive.

idle_timeout_in_minutes: pulumi.Output[float] = None¶: Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.

load_distribution: pulumi.Output[str] = None¶: Specifies the load balancing distribution type to be used by the Load Balancer. Possible values are: Default – The load balancer is configured to use a 5 tuple hash to map traffic to available servers. SourceIP – The load balancer is configured to use a 2 tuple hash to map traffic to available servers. SourceIPProtocol – The load balancer is configured to use a 3 tuple hash to map traffic to available servers. Also known as Session Persistence, where the options are called None, Client IP and Client IP and Protocol respectively.

loadbalancer_id: pulumi.Output[str] = None¶: The ID of the Load Balancer in which to create the Rule.

name: pulumi.Output[str] = None¶: Specifies the name of the LB Rule.

probe_id: pulumi.Output[str] = None¶: A reference to a Probe used by this Load Balancing Rule.

protocol: pulumi.Output[str] = None¶: The transport protocol for the external endpoint. Possible values are Tcp, Udp or All.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the resource.

static get(resource_name, id, opts=None, backend_address_pool_id=None, backend_port=None, disable_outbound_snat=None, enable_floating_ip=None, enable_tcp_reset=None, frontend_ip_configuration_id=None, frontend_ip_configuration_name=None, frontend_port=None, idle_timeout_in_minutes=None, load_distribution=None, loadbalancer_id=None, name=None, probe_id=None, protocol=None, resource_group_name=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
backend_address_pool_id (pulumi.Input[str]) – A reference to a Backend Address Pool over which this Load Balancing Rule operates.
backend_port (pulumi.Input[float]) – The port used for internal connections on the endpoint. Possible values range between 0 and 65535, inclusive.
disable_outbound_snat (pulumi.Input[bool]) – Is snat enabled for this Load Balancer Rule? Default false.
enable_floating_ip (pulumi.Input[bool]) – Are the Floating IPs enabled for this Load Balncer Rule? A “floating” IP is reassigned to a secondary server in case the primary server fails. Required to configure a SQL AlwaysOn Availability Group. Defaults to false.
enable_tcp_reset (pulumi.Input[bool]) – Is TCP Reset enabled for this Load Balancer Rule? Defaults to false.
frontend_ip_configuration_name (pulumi.Input[str]) – The name of the frontend IP configuration to which the rule is associated.
frontend_port (pulumi.Input[float]) – The port for the external endpoint. Port numbers for each Rule must be unique within the Load Balancer. Possible values range between 0 and 65534, inclusive.
idle_timeout_in_minutes (pulumi.Input[float]) – Specifies the idle timeout in minutes for TCP connections. Valid values are between 4 and 30 minutes. Defaults to 4 minutes.
load_distribution (pulumi.Input[str]) – Specifies the load balancing distribution type to be used by the Load Balancer. Possible values are: Default – The load balancer is configured to use a 5 tuple hash to map traffic to available servers. SourceIP – The load balancer is configured to use a 2 tuple hash to map traffic to available servers. SourceIPProtocol – The load balancer is configured to use a 3 tuple hash to map traffic to available servers. Also known as Session Persistence, where the options are called None, Client IP and Client IP and Protocol respectively.
loadbalancer_id (pulumi.Input[str]) – The ID of the Load Balancer in which to create the Rule.
name (pulumi.Input[str]) – Specifies the name of the LB Rule.
probe_id (pulumi.Input[str]) – A reference to a Probe used by this Load Balancing Rule.
protocol (pulumi.Input[str]) – The transport protocol for the external endpoint. Possible values are Tcp, Udp or All.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

pulumi_azure.lb.get_backend_address_pool(loadbalancer_id=None, name=None, opts=None)¶

Use this data source to access information about an existing Load Balancer’s Backend Address Pool.

import pulumi
import pulumi_azure as azure

example_lb = azure.lb.get_lb(name="example-lb",
    resource_group_name="example-resources")
example_backend_address_pool = azure.lb.get_backend_address_pool(name="first",
    loadbalancer_id=example_lb.id)
pulumi.export("backendAddressPoolId", example_backend_address_pool.id)
pulumi.export("backendIpConfigurationIds", [__item["id"] for __item in data["azurerm_lb_backend_address_pool"]["beap"]["backend_ip_configurations"]])

Parameters

loadbalancer_id (str) – The ID of the Load Balancer in which the Backend Address Pool exists.
name (str) – Specifies the name of the Backend Address Pool.

pulumi_azure.lb.get_lb(name=None, resource_group_name=None, opts=None)¶

Use this data source to access information about an existing Load Balancer

import pulumi
import pulumi_azure as azure

example = azure.lb.get_lb(name="example-lb",
    resource_group_name="example-resources")
pulumi.export("loadbalancerId", example.id)

Parameters

name (str) – Specifies the name of the Load Balancer.
resource_group_name (str) – The name of the Resource Group in which the Load Balancer exists.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

lb¶

On This Page