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

Microsoft.Network loadBalancers/backendAddressPools 2023-05-01

• 最新
• 2024-05-01
• 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 资源定义

可以使用目标操作部署 loadBalancers/backendAddressPools 资源类型：

• 资源组 - 请参阅 资源组部署命令

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

资源格式

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

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

属性值

BackendAddressPoolPropertiesFormat

名字	描述	价值
drainPeriodInSeconds	将 RESET 发送到客户端和后端地址之前，负载均衡器等待的秒数。	int
loadBalancerBackendAddresses	后端地址数组。	LoadBalancerBackendAddress[]
位置	后端地址池的位置。	字符串
syncMode	后端池的后端地址同步模式	“Automatic” “Manual”
tunnelInterfaces	网关负载均衡器隧道接口的数组。	GatewayLoadBalancerTunnelInterface[]
virtualNetwork	对虚拟网络的引用。	SubResource

GatewayLoadBalancerTunnelInterface

名字	描述	价值
标识符	网关负载均衡器隧道接口的标识符。	int
港口	网关负载均衡器隧道接口的端口。	int
协议	网关负载均衡器隧道接口的协议。	“Native” “None” “VXLAN”
类型	网关负载均衡器隧道接口的流量类型。	“External” “Internal” “None”

LoadBalancerBackendAddress

名字	描述	价值
名字	后端地址的名称。	字符串
性能	负载均衡器后端地址池的属性。	LoadBalancerBackendAddressPropertiesFormat

LoadBalancerBackendAddressPropertiesFormat

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

Microsoft.Network/loadBalancers/backendAddressPools

名字	描述	价值
名字	资源名称	string （必需）
父母	在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源外部的子资源。	类型资源的符号名称：loadBalancers
性能	负载均衡器后端地址池的属性。	BackendAddressPoolPropertiesFormat

SubResource

名字	描述	价值
id	资源 ID。	字符串

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件	描述
创建跨区域负载均衡器	此模板创建包含两个区域负载均衡器的后端池的跨区域负载均衡器。 跨区域负载均衡器目前在有限的区域中可用。 跨区域负载均衡器后面的区域负载均衡器可以位于任何区域中。
链接到网关负载均衡器的公共负载均衡器	此模板允许你将链接的公共标准负载均衡器部署到网关负载均衡器。 从 Internet 传入的流量通过后端池中的 linux VM（NVA）路由到网关负载均衡器。

ARM 模板资源定义

可以使用目标操作部署 loadBalancers/backendAddressPools 资源类型：

• 资源组 - 请参阅 资源组部署命令

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

资源格式

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

{
  "type": "Microsoft.Network/loadBalancers/backendAddressPools",
  "apiVersion": "2023-05-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",
    "syncMode": "string",
    "tunnelInterfaces": [
      {
        "identifier": "int",
        "port": "int",
        "protocol": "string",
        "type": "string"
      }
    ],
    "virtualNetwork": {
      "id": "string"
    }
  }
}

属性值

BackendAddressPoolPropertiesFormat

名字	描述	价值
drainPeriodInSeconds	将 RESET 发送到客户端和后端地址之前，负载均衡器等待的秒数。	int
loadBalancerBackendAddresses	后端地址数组。	LoadBalancerBackendAddress[]
位置	后端地址池的位置。	字符串
syncMode	后端池的后端地址同步模式	“Automatic” “Manual”
tunnelInterfaces	网关负载均衡器隧道接口的数组。	GatewayLoadBalancerTunnelInterface[]
virtualNetwork	对虚拟网络的引用。	SubResource

GatewayLoadBalancerTunnelInterface

名字	描述	价值
标识符	网关负载均衡器隧道接口的标识符。	int
港口	网关负载均衡器隧道接口的端口。	int
协议	网关负载均衡器隧道接口的协议。	“Native” “None” “VXLAN”
类型	网关负载均衡器隧道接口的流量类型。	“External” “Internal” “None”

LoadBalancerBackendAddress

名字	描述	价值
名字	后端地址的名称。	字符串
性能	负载均衡器后端地址池的属性。	LoadBalancerBackendAddressPropertiesFormat

LoadBalancerBackendAddressPropertiesFormat

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

Microsoft.Network/loadBalancers/backendAddressPools

名字	描述	价值
apiVersion	API 版本	'2023-05-01'
名字	资源名称	string （必需）
性能	负载均衡器后端地址池的属性。	BackendAddressPoolPropertiesFormat
类型	资源类型	“Microsoft.Network/loadBalancers/backendAddressPools”

SubResource

名字	描述	价值
id	资源 ID。	字符串

快速入门模板

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

模板	描述
创建跨区域负载均衡器	此模板创建包含两个区域负载均衡器的后端池的跨区域负载均衡器。 跨区域负载均衡器目前在有限的区域中可用。 跨区域负载均衡器后面的区域负载均衡器可以位于任何区域中。
链接到网关负载均衡器的公共负载均衡器	此模板允许你将链接的公共标准负载均衡器部署到网关负载均衡器。 从 Internet 传入的流量通过后端池中的 linux VM（NVA）路由到网关负载均衡器。
按 IP 地址按 IP 地址 标准负载均衡器	此模板用于演示如何使用 ARM 模板按 IP 地址配置负载均衡器的后端池，如 后端池管理 文档中所述。

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 loadBalancers/backendAddressPools 资源类型：

• 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/loadBalancers/backendAddressPools@2023-05-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"
      syncMode = "string"
      tunnelInterfaces = [
        {
          identifier = int
          port = int
          protocol = "string"
          type = "string"
        }
      ]
      virtualNetwork = {
        id = "string"
      }
    }
  })
}

属性值

BackendAddressPoolPropertiesFormat

名字	描述	价值
drainPeriodInSeconds	将 RESET 发送到客户端和后端地址之前，负载均衡器等待的秒数。	int
loadBalancerBackendAddresses	后端地址数组。	LoadBalancerBackendAddress[]
位置	后端地址池的位置。	字符串
syncMode	后端池的后端地址同步模式	“Automatic” “Manual”
tunnelInterfaces	网关负载均衡器隧道接口的数组。	GatewayLoadBalancerTunnelInterface[]
virtualNetwork	对虚拟网络的引用。	SubResource

GatewayLoadBalancerTunnelInterface

名字	描述	价值
标识符	网关负载均衡器隧道接口的标识符。	int
港口	网关负载均衡器隧道接口的端口。	int
协议	网关负载均衡器隧道接口的协议。	“Native” “None” “VXLAN”
类型	网关负载均衡器隧道接口的流量类型。	“External” “Internal” “None”

LoadBalancerBackendAddress

名字	描述	价值
名字	后端地址的名称。	字符串
性能	负载均衡器后端地址池的属性。	LoadBalancerBackendAddressPropertiesFormat

LoadBalancerBackendAddressPropertiesFormat

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

Microsoft.Network/loadBalancers/backendAddressPools

名字	描述	价值
名字	资源名称	string （必需）
parent_id	此资源的父资源的 ID。	类型资源的 ID：loadBalancers
性能	负载均衡器后端地址池的属性。	BackendAddressPoolPropertiesFormat
类型	资源类型	“Microsoft.Network/loadBalancers/backendAddressPools@2023-05-01”

SubResource

名字	描述	价值
id	资源 ID。	字符串