Microsoft.Network loadBalancers/backendAddressPools 2023-02-01

• Latest
• 2024-03-01
• 2024-01-01
• 2023-11-01
• 2023-09-01
• 2023-06-01
• 2023-05-01
• 2023-04-01
• 2023-02-01
• 2022-11-01
• 2022-09-01
• 2022-07-01
• 2022-05-01
• 2022-01-01
• 2021-08-01
• 2021-05-01
• 2021-03-01
• 2021-02-01
• 2020-11-01
• 2020-08-01
• 2020-07-01
• 2020-06-01
• 2020-05-01
• 2020-04-01
• 2020-03-01
• 2019-12-01
• 2019-11-01
• 2019-09-01
• 2019-08-01
• 2019-07-01
• 2019-06-01
• 2019-04-01
• 2019-02-01
• 2018-12-01
• 2018-11-01
• 2018-10-01
• 2018-08-01
• 2018-07-01
• 2018-06-01
• 2018-04-01
• 2018-02-01
• 2018-01-01
• 2017-11-01
• 2017-10-01
• 2017-09-01
• 2017-08-01
• 2017-06-01

Bicep resource definition

The loadBalancers/backendAddressPools resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/loadBalancers/backendAddressPools resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/loadBalancers/backendAddressPools@2023-02-01' = {
  name: 'string'
  properties: {
    drainPeriodInSeconds: int
    loadBalancerBackendAddresses: [
      {
        name: 'string'
        properties: {
          adminState: 'string'
          ipAddress: 'string'
          loadBalancerFrontendIPConfiguration: {
            id: 'string'
          }
          subnet: {
            id: 'string'
          }
          virtualNetwork: {
            id: 'string'
          }
        }
      }
    ]
    location: 'string'
    tunnelInterfaces: [
      {
        identifier: int
        port: int
        protocol: 'string'
        type: 'string'
      }
    ]
    virtualNetwork: {
      id: 'string'
    }
  }
}

Property values

BackendAddressPoolPropertiesFormat

Name	Description	Value
drainPeriodInSeconds	Amount of seconds Load Balancer waits for before sending RESET to client and backend address.	int
loadBalancerBackendAddresses	An array of backend addresses.	LoadBalancerBackendAddress[]
location	The location of the backend address pool.	string
tunnelInterfaces	An array of gateway load balancer tunnel interfaces.	GatewayLoadBalancerTunnelInterface[]
virtualNetwork	A reference to a virtual network.	SubResource

GatewayLoadBalancerTunnelInterface

Name	Description	Value
identifier	Identifier of gateway load balancer tunnel interface.	int
port	Port of gateway load balancer tunnel interface.	int
protocol	Protocol of gateway load balancer tunnel interface.	'Native' 'None' 'VXLAN'
type	Traffic type of gateway load balancer tunnel interface.	'External' 'Internal' 'None'

LoadBalancerBackendAddress

Name	Description	Value
name	Name of the backend address.	string
properties	Properties of load balancer backend address pool.	LoadBalancerBackendAddressPropertiesFormat

LoadBalancerBackendAddressPropertiesFormat

Name	Description	Value
adminState	A list of administrative states which once set can override health probe so that Load Balancer will always forward new connections to backend, or deny new connections and reset existing connections.	'Down' 'None' 'Up'
ipAddress	IP Address belonging to the referenced virtual network.	string
loadBalancerFrontendIPConfiguration	Reference to the frontend ip address configuration defined in regional loadbalancer.	SubResource
subnet	Reference to an existing subnet.	SubResource
virtualNetwork	Reference to an existing virtual network.	SubResource

Microsoft.Network/loadBalancers/backendAddressPools

Name	Description	Value
name	The resource name	string (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: loadBalancers
properties	Properties of load balancer backend address pool.	BackendAddressPoolPropertiesFormat

SubResource

Name	Description	Value
id	Resource ID.	string

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File	Description
Create a cross-region load balancer	This template creates a cross-region load balancer with a backend pool containing two regional load balancers. Cross-region load balancer is currently available in limited regions. The regional load balancers behind the cross-region load balancer can be in any region.
Public Load Balancer chained to a Gateway Load Balancer	This template allows you to deploy a Public Standard Load Balancer chained to a Gateway Load Balancer. The traffic incoming from internet is routed to the Gateway Load Balancer with linux VMs (NVAs) in the backend pool.

ARM template resource definition

The loadBalancers/backendAddressPools resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/loadBalancers/backendAddressPools resource, add the following JSON to your template.

{
  "type": "Microsoft.Network/loadBalancers/backendAddressPools",
  "apiVersion": "2023-02-01",
  "name": "string",
  "properties": {
    "drainPeriodInSeconds": "int",
    "loadBalancerBackendAddresses": [
      {
        "name": "string",
        "properties": {
          "adminState": "string",
          "ipAddress": "string",
          "loadBalancerFrontendIPConfiguration": {
            "id": "string"
          },
          "subnet": {
            "id": "string"
          },
          "virtualNetwork": {
            "id": "string"
          }
        }
      }
    ],
    "location": "string",
    "tunnelInterfaces": [
      {
        "identifier": "int",
        "port": "int",
        "protocol": "string",
        "type": "string"
      }
    ],
    "virtualNetwork": {
      "id": "string"
    }
  }
}

Property values

BackendAddressPoolPropertiesFormat

Name	Description	Value
drainPeriodInSeconds	Amount of seconds Load Balancer waits for before sending RESET to client and backend address.	int
loadBalancerBackendAddresses	An array of backend addresses.	LoadBalancerBackendAddress[]
location	The location of the backend address pool.	string
tunnelInterfaces	An array of gateway load balancer tunnel interfaces.	GatewayLoadBalancerTunnelInterface[]
virtualNetwork	A reference to a virtual network.	SubResource

GatewayLoadBalancerTunnelInterface

Name	Description	Value
identifier	Identifier of gateway load balancer tunnel interface.	int
port	Port of gateway load balancer tunnel interface.	int
protocol	Protocol of gateway load balancer tunnel interface.	'Native' 'None' 'VXLAN'
type	Traffic type of gateway load balancer tunnel interface.	'External' 'Internal' 'None'

LoadBalancerBackendAddress

Name	Description	Value
name	Name of the backend address.	string
properties	Properties of load balancer backend address pool.	LoadBalancerBackendAddressPropertiesFormat

LoadBalancerBackendAddressPropertiesFormat

Name	Description	Value
adminState	A list of administrative states which once set can override health probe so that Load Balancer will always forward new connections to backend, or deny new connections and reset existing connections.	'Down' 'None' 'Up'
ipAddress	IP Address belonging to the referenced virtual network.	string
loadBalancerFrontendIPConfiguration	Reference to the frontend ip address configuration defined in regional loadbalancer.	SubResource
subnet	Reference to an existing subnet.	SubResource
virtualNetwork	Reference to an existing virtual network.	SubResource

Microsoft.Network/loadBalancers/backendAddressPools

Name	Description	Value
apiVersion	The api version	'2023-02-01'
name	The resource name	string (required)
properties	Properties of load balancer backend address pool.	BackendAddressPoolPropertiesFormat
type	The resource type	'Microsoft.Network/loadBalancers/backendAddressPools'

SubResource

Name	Description	Value
id	Resource ID.	string

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create a cross-region load balancer	This template creates a cross-region load balancer with a backend pool containing two regional load balancers. Cross-region load balancer is currently available in limited regions. The regional load balancers behind the cross-region load balancer can be in any region.
Public Load Balancer chained to a Gateway Load Balancer	This template allows you to deploy a Public Standard Load Balancer chained to a Gateway Load Balancer. The traffic incoming from internet is routed to the Gateway Load Balancer with linux VMs (NVAs) in the backend pool.
Standard Load Balancer with Backend Pool by IP Addresses	This template is used to demonstrate how ARM Templates can be used to configure the Backend Pool of a Load Balancer by IP Address as outlined in the Backend Pool management document.

Terraform (AzAPI provider) resource definition

The loadBalancers/backendAddressPools resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/loadBalancers/backendAddressPools resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/loadBalancers/backendAddressPools@2023-02-01"
  name = "string"
  body = jsonencode({
    properties = {
      drainPeriodInSeconds = int
      loadBalancerBackendAddresses = [
        {
          name = "string"
          properties = {
            adminState = "string"
            ipAddress = "string"
            loadBalancerFrontendIPConfiguration = {
              id = "string"
            }
            subnet = {
              id = "string"
            }
            virtualNetwork = {
              id = "string"
            }
          }
        }
      ]
      location = "string"
      tunnelInterfaces = [
        {
          identifier = int
          port = int
          protocol = "string"
          type = "string"
        }
      ]
      virtualNetwork = {
        id = "string"
      }
    }
  })
}

Property values

BackendAddressPoolPropertiesFormat

Name	Description	Value
drainPeriodInSeconds	Amount of seconds Load Balancer waits for before sending RESET to client and backend address.	int
loadBalancerBackendAddresses	An array of backend addresses.	LoadBalancerBackendAddress[]
location	The location of the backend address pool.	string
tunnelInterfaces	An array of gateway load balancer tunnel interfaces.	GatewayLoadBalancerTunnelInterface[]
virtualNetwork	A reference to a virtual network.	SubResource

GatewayLoadBalancerTunnelInterface

Name	Description	Value
identifier	Identifier of gateway load balancer tunnel interface.	int
port	Port of gateway load balancer tunnel interface.	int
protocol	Protocol of gateway load balancer tunnel interface.	'Native' 'None' 'VXLAN'
type	Traffic type of gateway load balancer tunnel interface.	'External' 'Internal' 'None'

LoadBalancerBackendAddress

Name	Description	Value
name	Name of the backend address.	string
properties	Properties of load balancer backend address pool.	LoadBalancerBackendAddressPropertiesFormat

LoadBalancerBackendAddressPropertiesFormat

Name	Description	Value
adminState	A list of administrative states which once set can override health probe so that Load Balancer will always forward new connections to backend, or deny new connections and reset existing connections.	'Down' 'None' 'Up'
ipAddress	IP Address belonging to the referenced virtual network.	string
loadBalancerFrontendIPConfiguration	Reference to the frontend ip address configuration defined in regional loadbalancer.	SubResource
subnet	Reference to an existing subnet.	SubResource
virtualNetwork	Reference to an existing virtual network.	SubResource

Microsoft.Network/loadBalancers/backendAddressPools

Name	Description	Value
name	The resource name	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: loadBalancers
properties	Properties of load balancer backend address pool.	BackendAddressPoolPropertiesFormat
type	The resource type	"Microsoft.Network/loadBalancers/backendAddressPools@2023-02-01"

SubResource

Name	Description	Value
id	Resource ID.	string