Microsoft.Network loadBalancers/backendAddressPools 2020-03-01

Bicep resource definition

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

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@2020-03-01' = {
  name: 'string'
}

Property values

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

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:

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": "2020-03-01",
  "name": "string"
}

Property values

Microsoft.Network/loadBalancers/backendAddressPools

Name Description Value
apiVersion The api version '2020-03-01'
name The resource name string (required)
type The resource type 'Microsoft.Network/loadBalancers/backendAddressPools'

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create a cross-region load balancer

Deploy to Azure
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

Deploy to Azure
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

Deploy to Azure
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@2020-03-01"
  name = "string"
}

Property values

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
type The resource type "Microsoft.Network/loadBalancers/backendAddressPools@2020-03-01"