你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Microsoft.Network loadBalancers/backendAddressPools 2022-01-01

Bicep 资源定义

可以使用面向以下操作部署 loadBalancers/backendAddressPools 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Network/loadBalancers/backendAddressPools 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Network/loadBalancers/backendAddressPools@2022-01-01' = {
  name: 'string'
  parent: resourceSymbolicName
  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'
      }
    ]
  }
}

属性值

loadBalancers/backendAddressPools

名称 说明
name 资源名称

了解如何在 Bicep 中设置子资源的名称和类型。
字符串 (必需)
父级 (parent) 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源之外的子资源
类型为 的资源的符号名称: loadBalancers
properties 负载均衡器后端地址池的属性。 BackendAddressPoolPropertiesFormat

BackendAddressPoolPropertiesFormat

名称 说明
drainPeriodInSeconds 将 RESET 发送到客户端和后端地址之前,负载均衡器等待的秒数。 int
loadBalancerBackendAddresses 后端地址数组。 LoadBalancerBackendAddress[]
location 后端地址池的位置。 字符串
tunnelInterfaces 网关负载均衡器隧道接口的数组。 GatewayLoadBalancerTunnelInterface[]

LoadBalancerBackendAddress

名称 说明
name 后端地址的名称。 string
properties 负载均衡器后端地址池的属性。 LoadBalancerBackendAddressPropertiesFormat

LoadBalancerBackendAddressPropertiesFormat

名称 说明
adminState 管理状态的列表,一旦设置这些状态即可替代运行状况探测,以便负载均衡器始终将新连接转发到后端,或拒绝新连接并重置现有连接。 “向下”
'Drain'
“None”
'Up'
ipAddress 属于所引用虚拟网络的 IP 地址。 字符串
loadBalancerFrontendIPConfiguration 对区域负载均衡器中定义的前端 IP 地址配置的引用。 SubResource
子网 对现有子网的引用。 SubResource
virtualNetwork 对现有虚拟网络的引用。 SubResource

SubResource

名称 说明 Value
id 资源 ID。 字符串

GatewayLoadBalancerTunnelInterface

名称 说明
标识符 网关负载均衡器隧道接口的标识符。 int
port 网关负载均衡器隧道接口的端口。 int
protocol 网关负载均衡器隧道接口的协议。 “Native”
“None”
“VXLAN”
类型 网关负载均衡器隧道接口的流量类型。 'External'
'Internal'
“None”

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
链接到网关负载均衡器的公共负载均衡器

部署到 Azure
此模板允许部署链接到网关负载均衡器的公共标准负载均衡器。 从 Internet 传入的流量将路由到后端池中 linux VM (NVA) 网关负载均衡器。
创建跨区域负载均衡器

部署到 Azure
此模板创建一个跨区域负载均衡器,其后端池包含两个区域负载均衡器。 跨区域负载均衡器目前在有限区域中可用。 跨区域负载均衡器后面的区域负载均衡器可以位于任何区域。
通过后端池按 IP 地址标准负载均衡器

部署到 Azure
此模板用于演示如何使用 ARM 模板按 IP 地址配置负载均衡器的后端池,如后端池管理文档中所述。

ARM 模板资源定义

可以使用面向以下操作部署 loadBalancers/backendAddressPools 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Network/loadBalancers/backendAddressPools 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Network/loadBalancers/backendAddressPools",
  "apiVersion": "2022-01-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"
      }
    ]
  }
}

属性值

loadBalancers/backendAddressPools

名称 说明 Value
type 资源类型 'Microsoft.Network/loadBalancers/backendAddressPools'
apiVersion 资源 API 版本 '2022-01-01'
name 资源名称

了解如何在 JSON ARM 模板中设置子资源的名称和类型。
字符串 (必需)
properties 负载均衡器后端地址池的属性。 BackendAddressPoolPropertiesFormat

BackendAddressPoolPropertiesFormat

名称 说明
drainPeriodInSeconds 将 RESET 发送到客户端和后端地址之前,负载均衡器等待的秒数。 int
loadBalancerBackendAddresses 后端地址数组。 LoadBalancerBackendAddress[]
location 后端地址池的位置。 字符串
tunnelInterfaces 网关负载均衡器隧道接口的数组。 GatewayLoadBalancerTunnelInterface[]

LoadBalancerBackendAddress

名称 说明
name 后端地址的名称。 string
properties 负载均衡器后端地址池的属性。 LoadBalancerBackendAddressPropertiesFormat

LoadBalancerBackendAddressPropertiesFormat

名称 说明
adminState 管理状态的列表,一旦设置这些状态即可替代运行状况探测,以便负载均衡器始终将新连接转发到后端,或拒绝新连接并重置现有连接。 “向下”
'Drain'
“None”
'Up'
ipAddress 属于所引用虚拟网络的 IP 地址。 字符串
loadBalancerFrontendIPConfiguration 对区域负载均衡器中定义的前端 IP 地址配置的引用。 SubResource
子网 对现有子网的引用。 SubResource
virtualNetwork 对现有虚拟网络的引用。 SubResource

SubResource

名称 说明 Value
id 资源 ID。 字符串

GatewayLoadBalancerTunnelInterface

名称 说明
标识符 网关负载均衡器隧道接口的标识符。 int
port 网关负载均衡器隧道接口的端口。 int
protocol 网关负载均衡器隧道接口的协议。 “Native”
“None”
“VXLAN”
类型 网关负载均衡器隧道接口的流量类型。 'External'
'Internal'
“None”

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
链接到网关负载均衡器的公共负载均衡器

部署到 Azure
此模板允许部署链接到网关负载均衡器的公共标准负载均衡器。 从 Internet 传入的流量将路由到后端池中 linux VM (NVA) 网关负载均衡器。
创建跨区域负载均衡器

部署到 Azure
此模板创建一个跨区域负载均衡器,其后端池包含两个区域负载均衡器。 跨区域负载均衡器目前在有限区域中可用。 跨区域负载均衡器后面的区域负载均衡器可以位于任何区域。
通过后端池按 IP 地址标准负载均衡器

部署到 Azure
此模板用于演示如何使用 ARM 模板按 IP 地址配置负载均衡器的后端池,如后端池管理文档中所述。

Terraform (AzAPI 提供程序) 资源定义

可以使用面向以下操作部署 loadBalancers/backendAddressPools 资源类型:

  • 资源组

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Network/loadBalancers/backendAddressPools 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/loadBalancers/backendAddressPools@2022-01-01"
  name = "string"
  parent_id = "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"
        }
      ]
    }
  })
}

属性值

loadBalancers/backendAddressPools

名称 说明 Value
type 资源类型 “Microsoft.Network/loadBalancers/backendAddressPools@2022-01-01”
name 资源名称 字符串 (必需)
parent_id 此资源的父资源的 ID。 类型为:loadBalancers 的资源的 ID
properties 负载均衡器后端地址池的属性。 BackendAddressPoolPropertiesFormat

BackendAddressPoolPropertiesFormat

名称 说明
drainPeriodInSeconds 将 RESET 发送到客户端和后端地址之前,负载均衡器等待的秒数。 int
loadBalancerBackendAddresses 后端地址数组。 LoadBalancerBackendAddress[]
location 后端地址池的位置。 字符串
tunnelInterfaces 网关负载均衡器隧道接口的数组。 GatewayLoadBalancerTunnelInterface[]

LoadBalancerBackendAddress

名称 说明
name 后端地址的名称。 string
properties 负载均衡器后端地址池的属性。 LoadBalancerBackendAddressPropertiesFormat

LoadBalancerBackendAddressPropertiesFormat

名称 说明
adminState 管理状态列表,一旦设置,即可覆盖运行状况探测,以便负载均衡器始终将新连接转发到后端,或拒绝新连接并重置现有连接。 “Down”
“排水”
"None"
“向上”
ipAddress 属于引用的虚拟网络的 IP 地址。 字符串
loadBalancerFrontendIPConfiguration 对区域负载均衡器中定义的前端 IP 地址配置的引用。 SubResource
子网 对现有子网的引用。 SubResource
virtualNetwork 对现有虚拟网络的引用。 SubResource

SubResource

名称 说明 Value
id 资源 ID。 字符串

GatewayLoadBalancerTunnelInterface

名称 说明
标识符 网关负载均衡器隧道接口的标识符。 int
port 网关负载均衡器隧道接口的端口。 int
protocol 网关负载均衡器隧道接口的协议。 “Native”
"None"
“VXLAN”
类型 网关负载均衡器隧道接口的流量类型。 “External”
“Internal”
"None"