Microsoft.Network loadBalancers/backendAddressPools 2020-07-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-07-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    loadBalancerBackendAddresses: [
      {
        name: 'string'
        properties: {
          ipAddress: 'string'
          loadBalancerFrontendIPConfiguration: {
            id: 'string'
          }
          virtualNetwork: {
            id: 'string'
          }
        }
      }
    ]
  }
}

Property Values

Microsoft.Network/loadBalancers/backendAddressPools

BackendAddressPoolPropertiesFormat

LoadBalancerBackendAddress

LoadBalancerBackendAddressPropertiesFormat

SubResource

Usage Examples

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

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-07-01",
  "name": "string",
  "properties": {
    "loadBalancerBackendAddresses": [
      {
        "name": "string",
        "properties": {
          "ipAddress": "string",
          "loadBalancerFrontendIPConfiguration": {
            "id": "string"
          },
          "virtualNetwork": {
            "id": "string"
          }
        }
      }
    ]
  }
}

Property Values

Microsoft.Network/loadBalancers/backendAddressPools

BackendAddressPoolPropertiesFormat

LoadBalancerBackendAddress

LoadBalancerBackendAddressPropertiesFormat

SubResource

Usage Examples

Azure Quickstart Templates

The following Azure 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:

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-07-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      loadBalancerBackendAddresses = [
        {
          name = "string"
          properties = {
            ipAddress = "string"
            loadBalancerFrontendIPConfiguration = {
              id = "string"
            }
            virtualNetwork = {
              id = "string"
            }
          }
        }
      ]
    }
  }
}

Property Values

Microsoft.Network/loadBalancers/backendAddressPools

BackendAddressPoolPropertiesFormat

LoadBalancerBackendAddress

LoadBalancerBackendAddressPropertiesFormat

SubResource

Usage Examples

Terraform Samples

A basic example of deploying Load Balancer Backend Address Pool.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "___location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  ___location = var.___location
}

resource "azapi_resource" "publicIPAddress" {
  type      = "Microsoft.Network/publicIPAddresses@2022-07-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  ___location  = var.___location
  body = {
    properties = {
      ddosSettings = {
        protectionMode = "VirtualNetworkInherited"
      }
      idleTimeoutInMinutes     = 4
      publicIPAddressVersion   = "IPv4"
      publicIPAllocationMethod = "Static"
    }
    sku = {
      name = "Standard"
      tier = "Regional"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "loadBalancer" {
  type      = "Microsoft.Network/loadBalancers@2022-07-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  ___location  = var.___location
  body = {
    properties = {
      frontendIPConfigurations = [
        {
          name = "internal"
          properties = {
            publicIPAddress = {
              id = azapi_resource.publicIPAddress.id
            }
          }
        },
      ]
    }
    sku = {
      name = "Standard"
      tier = "Regional"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "backendAddressPool" {
  type      = "Microsoft.Network/loadBalancers/backendAddressPools@2022-07-01"
  parent_id = azapi_resource.loadBalancer.id
  name      = var.resource_name
  body = {
    properties = {
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}