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

Microsoft.Network expressRouteGateways 2022-01-01

Bicep 资源定义

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

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

资源格式

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

resource symbolicname 'Microsoft.Network/expressRouteGateways@2022-01-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    autoScaleConfiguration: {
      bounds: {
        max: int
        min: int
      }
    }
    expressRouteConnections: [
      {
        id: 'string'
        name: 'string'
        properties: {
          authorizationKey: 'string'
          enableInternetSecurity: bool
          expressRouteCircuitPeering: {
            id: 'string'
          }
          expressRouteGatewayBypass: bool
          routingConfiguration: {
            associatedRouteTable: {
              id: 'string'
            }
            propagatedRouteTables: {
              ids: [
                {
                  id: 'string'
                }
              ]
              labels: [
                'string'
              ]
            }
            vnetRoutes: {
              staticRoutes: [
                {
                  addressPrefixes: [
                    'string'
                  ]
                  name: 'string'
                  nextHopIpAddress: 'string'
                }
              ]
            }
          }
          routingWeight: int
        }
      }
    ]
    virtualHub: {
      id: 'string'
    }
  }
}

属性值

expressRouteGateways

名称 说明
name 资源名称 字符串 (必需)
location 资源位置。 string
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
properties 快速路由网关的属性。 ExpressRouteGatewayProperties

ExpressRouteGatewayProperties

名称 说明
autoScaleConfiguration 自动缩放的配置。 ExpressRouteGatewayPropertiesAutoScaleConfiguration
expressRouteConnections 到 ExpressRoute 网关的 ExpressRoute 连接列表。 ExpressRouteConnection[]
virtualHub 部署或将部署 ExpressRoute 网关的虚拟中心。 VirtualHubId (必需)

ExpressRouteGatewayPropertiesAutoScaleConfiguration

名称 说明
bounds 要部署的最小和最大缩放单元数。 ExpressRouteGatewayPropertiesAutoScaleConfigurationB...

ExpressRouteGatewayPropertiesAutoScaleConfigurationB...

名称 说明
max 为 ExpressRoute 网关部署的最大缩放单元数。 int
分钟 为 ExpressRoute 网关部署的最小缩放单元数。 int

ExpressRouteConnection

名称 说明 Value
id 资源 ID。 字符串
name 资源的名称。 字符串 (必需)
properties 快速路由连接的属性。 ExpressRouteConnectionProperties

ExpressRouteConnectionProperties

名称 说明
authorizationKey 用于建立连接的授权密钥。 字符串
enableInternetSecurity 启用 Internet 安全性。 bool
expressRouteCircuitPeering ExpressRoute 线路对等互连。 ExpressRouteCircuitPeeringId (必需)
expressRouteGatewayBypass 启用 FastPath 到 vWan 防火墙中心。 bool
routingConfiguration 路由配置,指示此连接上关联的和传播的路由表。 RoutingConfiguration
routingWeight 与连接关联的路由权重。 int

ExpressRouteCircuitPeeringId

名称 说明 Value
id ExpressRoute 线路对等互连的 ID。 字符串

RoutingConfiguration

名称 说明
associatedRouteTable 与此 RoutingConfiguration 关联的资源 ID RouteTable。 SubResource
propagatedRouteTables 要向其播发路由的 RouteTable 列表。 PropagatedRouteTable
vnetRoutes 控制从 VirtualHub 到虚拟网络连接的路由的路由列表。 VnetRoute

SubResource

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

PropagatedRouteTable

名称 说明
ids 所有 RouteTable 的资源 ID 列表。 SubResource[]
标签 标签列表。 string[]

VnetRoute

名称 说明
staticRoutes 所有静态路由的列表。 StaticRoute[]

StaticRoute

名称 说明
addressPrefixes 所有地址前缀的列表。 string[]
name 在 VnetRoute 中唯一的 StaticRoute 的名称。 字符串
nextHopIpAddress 下一跃点的 IP 地址。 string

VirtualHubId

名称 说明 Value
id 部署或将部署 ExpressRoute 网关的虚拟中心的资源 URI。 虚拟中心资源和 ExpressRoute 网关资源驻留在同一订阅中。 string

快速入门模板

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

模板 说明
Azure 虚拟 WAN路由意向和策略

部署到 Azure
此模板预配 Azure 虚拟 WAN,其中两个中心启用了路由意向和策略功能。
Azure 虚拟 WAN (vWAN) 多中心部署

部署到 Azure
使用此模板可以创建 Azure 虚拟 WAN (vWAN) 多中心部署,包括所有网关和 VNET 连接。
使用自定义路由表进行 Azure vWAN 多中心部署

部署到 Azure
使用此模板可以创建 Azure 虚拟 WAN (vWAN) 多中心部署(包括所有网关和 VNET 连接),并演示路由表用于自定义路由的用法。

ARM 模板资源定义

expressRouteGateways 资源类型可以通过针对以下操作进行部署:

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

资源格式

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

{
  "type": "Microsoft.Network/expressRouteGateways",
  "apiVersion": "2022-01-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "autoScaleConfiguration": {
      "bounds": {
        "max": "int",
        "min": "int"
      }
    },
    "expressRouteConnections": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "authorizationKey": "string",
          "enableInternetSecurity": "bool",
          "expressRouteCircuitPeering": {
            "id": "string"
          },
          "expressRouteGatewayBypass": "bool",
          "routingConfiguration": {
            "associatedRouteTable": {
              "id": "string"
            },
            "propagatedRouteTables": {
              "ids": [
                {
                  "id": "string"
                }
              ],
              "labels": [ "string" ]
            },
            "vnetRoutes": {
              "staticRoutes": [
                {
                  "addressPrefixes": [ "string" ],
                  "name": "string",
                  "nextHopIpAddress": "string"
                }
              ]
            }
          },
          "routingWeight": "int"
        }
      }
    ],
    "virtualHub": {
      "id": "string"
    }
  }
}

属性值

expressRouteGateways

名称 说明 Value
type 资源类型 “Microsoft.Network/expressRouteGateways”
apiVersion 资源 API 版本 '2022-01-01'
name 资源名称 字符串 (必需)
location 资源位置。 字符串
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
properties 快速路由网关的属性。 ExpressRouteGatewayProperties

ExpressRouteGatewayProperties

名称 说明
autoScaleConfiguration 自动缩放的配置。 ExpressRouteGatewayPropertiesAutoScaleConfiguration
expressRouteConnections 到 ExpressRoute 网关的 ExpressRoute 连接列表。 ExpressRouteConnection[]
virtualHub 部署或将部署 ExpressRoute 网关的虚拟中心。 VirtualHubId (必需)

ExpressRouteGatewayPropertiesAutoScaleConfiguration

名称 说明
bounds 要部署的最小和最大缩放单元数。 ExpressRouteGatewayPropertiesAutoScaleConfigurationB...

ExpressRouteGatewayPropertiesAutoScaleConfigurationB...

名称 说明
max 为 ExpressRoute 网关部署的最大缩放单元数。 int
分钟 为 ExpressRoute 网关部署的最小缩放单元数。 int

ExpressRouteConnection

名称 说明 Value
id 资源 ID。 字符串
name 资源的名称。 字符串 (必需)
properties 快速路由连接的属性。 ExpressRouteConnectionProperties

ExpressRouteConnectionProperties

名称 说明
authorizationKey 用于建立连接的授权密钥。 string
enableInternetSecurity 启用 Internet 安全性。 bool
expressRouteCircuitPeering ExpressRoute 线路对等互连。 ExpressRouteCircuitPeeringId (必需)
expressRouteGatewayBypass 启用 FastPath 到 vWan 防火墙中心。 bool
routingConfiguration 路由配置,指示此连接上关联的和传播的路由表。 RoutingConfiguration
routingWeight 与连接关联的路由权重。 int

ExpressRouteCircuitPeeringId

名称 说明 Value
id ExpressRoute 线路对等互连的 ID。 string

RoutingConfiguration

名称 说明
associatedRouteTable 与此 RoutingConfiguration 关联的资源 ID RouteTable。 SubResource
propagatedRouteTables 要向其播发路由的 RouteTable 列表。 PropagatedRouteTable
vnetRoutes 控制从 VirtualHub 到虚拟网络连接的路由的列表。 VnetRoute

SubResource

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

PropagatedRouteTable

名称 说明
ids 所有 RouteTable 的资源 ID 的列表。 SubResource[]
标签 标签列表。 string[]

VnetRoute

名称 说明
staticRoutes 所有静态路由的列表。 StaticRoute[]

StaticRoute

名称 说明
addressPrefixes 所有地址前缀的列表。 string[]
name 在 VnetRoute 中唯一的 StaticRoute 的名称。 字符串
nextHopIpAddress 下一跃点的 IP 地址。 字符串

VirtualHubId

名称 说明 Value
id 部署或将部署 ExpressRoute 网关的虚拟中心的资源 URI。 虚拟中心资源和 ExpressRoute 网关资源驻留在同一订阅中。 string

快速入门模板

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

模板 说明
Azure 虚拟 WAN 路由意向和策略

部署到 Azure
此模板预配 Azure 虚拟 WAN,其中包含启用了路由意向和策略功能的两个中心。
Azure 虚拟 WAN (vWAN) 多中心部署

部署到 Azure
此模板允许创建 Azure 虚拟 WAN (vWAN) 多中心部署,包括所有网关和 VNET 连接。
使用自定义路由表进行 Azure vWAN 多中心部署

部署到 Azure
使用此模板可以创建 Azure 虚拟 WAN (vWAN) 多中心部署,包括所有网关和 VNET 连接,并演示路由表用于自定义路由。

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

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

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/expressRouteGateways@2022-01-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      autoScaleConfiguration = {
        bounds = {
          max = int
          min = int
        }
      }
      expressRouteConnections = [
        {
          id = "string"
          name = "string"
          properties = {
            authorizationKey = "string"
            enableInternetSecurity = bool
            expressRouteCircuitPeering = {
              id = "string"
            }
            expressRouteGatewayBypass = bool
            routingConfiguration = {
              associatedRouteTable = {
                id = "string"
              }
              propagatedRouteTables = {
                ids = [
                  {
                    id = "string"
                  }
                ]
                labels = [
                  "string"
                ]
              }
              vnetRoutes = {
                staticRoutes = [
                  {
                    addressPrefixes = [
                      "string"
                    ]
                    name = "string"
                    nextHopIpAddress = "string"
                  }
                ]
              }
            }
            routingWeight = int
          }
        }
      ]
      virtualHub = {
        id = "string"
      }
    }
  })
}

属性值

expressRouteGateways

名称 说明 Value
type 资源类型 “Microsoft.Network/expressRouteGateways@2022-01-01”
name 资源名称 字符串 (必需)
location 资源位置。 字符串
parent_id 若要部署到资源组,请使用该资源组的 ID。 字符串 (必需)
标记 资源标记。 标记名称和值的字典。
properties 快速路由网关的属性。 ExpressRouteGatewayProperties

ExpressRouteGatewayProperties

名称 说明
autoScaleConfiguration 自动缩放的配置。 ExpressRouteGatewayPropertiesAutoScaleConfiguration
expressRouteConnections 到 ExpressRoute 网关的 ExpressRoute 连接列表。 ExpressRouteConnection[]
virtualHub 部署或将部署 ExpressRoute 网关的虚拟中心。 VirtualHubId (必需)

ExpressRouteGatewayPropertiesAutoScaleConfiguration

名称 说明
bounds 要部署的缩放单元的最小和最大数量。 ExpressRouteGatewayPropertiesAutoScaleConfigurationB...

ExpressRouteGatewayPropertiesAutoScaleConfigurationB...

名称 说明
max 为 ExpressRoute 网关部署的最大缩放单元数。 int
分钟 为 ExpressRoute 网关部署的最小缩放单元数。 int

ExpressRouteConnection

名称 说明 Value
id 资源 ID。 字符串
name 资源的名称。 字符串 (必需)
properties 快速路由连接的属性。 ExpressRouteConnectionProperties

ExpressRouteConnectionProperties

名称 说明
authorizationKey 用于建立连接的授权密钥。 字符串
enableInternetSecurity 启用 Internet 安全性。 bool
expressRouteCircuitPeering ExpressRoute 线路对等互连。 ExpressRouteCircuitPeeringId (必需)
expressRouteGatewayBypass 启用 FastPath 到 vWan 防火墙中心。 bool
routingConfiguration 路由配置,指示此连接上关联的和传播的路由表。 RoutingConfiguration
routingWeight 与连接关联的路由权重。 int

ExpressRouteCircuitPeeringId

名称 说明 Value
id ExpressRoute 线路对等互连的 ID。 字符串

RoutingConfiguration

名称 说明
associatedRouteTable 与此 RoutingConfiguration 关联的资源 ID RouteTable。 SubResource
propagatedRouteTables 要向其播发路由的 RouteTable 列表。 PropagatedRouteTable
vnetRoutes 控制从 VirtualHub 到虚拟网络连接的路由的路由列表。 VnetRoute

SubResource

名称 说明 Value
id 资源 ID。 string

PropagatedRouteTable

名称 说明
ids 所有 RouteTable 的资源 ID 列表。 SubResource[]
标签 标签列表。 string[]

VnetRoute

名称 说明
staticRoutes 所有静态路由的列表。 StaticRoute[]

StaticRoute

名称 说明
addressPrefixes 所有地址前缀的列表。 string[]
name 在 VnetRoute 中唯一的 StaticRoute 的名称。 字符串
nextHopIpAddress 下一跃点的 IP 地址。 string

VirtualHubId

名称 说明 Value
id 部署或将部署 ExpressRoute 网关的虚拟中心的资源 URI。 虚拟中心资源和 ExpressRoute 网关资源驻留在同一订阅中。 字符串