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

Microsoft.Network virtualHubs 2024-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

Bicep 资源定义

可以使用目标操作部署 virtualHubs 资源类型：

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

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

资源格式

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

resource symbolicname 'Microsoft.Network/virtualHubs@2024-05-01' = {
  location: 'string'
  name: 'string'
  properties: {
    addressPrefix: 'string'
    allowBranchToBranchTraffic: bool
    azureFirewall: {
      id: 'string'
    }
    expressRouteGateway: {
      id: 'string'
    }
    hubRoutingPreference: 'string'
    p2SVpnGateway: {
      id: 'string'
    }
    preferredRoutingGateway: 'string'
    routeTable: {
      routes: [
        {
          addressPrefixes: [
            'string'
          ]
          nextHopIpAddress: 'string'
        }
      ]
    }
    securityPartnerProvider: {
      id: 'string'
    }
    securityProviderName: 'string'
    sku: 'string'
    virtualHubRouteTableV2s: [
      {
        id: 'string'
        name: 'string'
        properties: {
          attachedConnections: [
            'string'
          ]
          routes: [
            {
              destinations: [
                'string'
              ]
              destinationType: 'string'
              nextHops: [
                'string'
              ]
              nextHopType: 'string'
            }
          ]
        }
      }
    ]
    virtualRouterAsn: int
    virtualRouterAutoScaleConfiguration: {
      minCapacity: int
    }
    virtualRouterIps: [
      'string'
    ]
    virtualWan: {
      id: 'string'
    }
    vpnGateway: {
      id: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

Microsoft.Network/virtualHubs

名字	描述	价值
位置	资源位置。	字符串
名字	资源名称	string （必需）
性能	虚拟中心的属性。	VirtualHubProperties
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记

ResourceTags

名字	描述	价值

SubResource

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

VirtualHubProperties

名字	描述	价值
addressPrefix	此 VirtualHub 的地址前缀。	字符串
allowBranchToBranchTraffic	用于控制 VirtualRouter 中心的传输的标志。	bool
azureFirewall	与此 VirtualHub 关联的 azureFirewall。	SubResource
expressRouteGateway	与此 VirtualHub 关联的 expressRouteGateway。	SubResource
hubRoutingPreference	此 VirtualHub 的 hubRoutingPreference。	“ASPath” “ExpressRoute” “VpnGateway”
p2SVpnGateway	与此 VirtualHub 关联的 P2SVpnGateway。	SubResource
preferredRoutingGateway	用于路由本地流量的首选网关	“ExpressRoute” “None” “VpnGateway”
routeTable	与此虚拟中心关联的 routeTable。	VirtualHubRouteTable
securityPartnerProvider	与此 VirtualHub 关联的 securityPartnerProvider。	SubResource
securityProviderName	安全提供程序名称。	字符串
sku	此 VirtualHub 的 SKU。	字符串
virtualHubRouteTableV2s	与此 VirtualHub 关联的所有虚拟中心路由表 v2 的列表。	VirtualHubRouteTableV2[]
virtualRouterAsn	VirtualRouter ASN。	int 约束： 最小值 = 0 最大值 = 4294967295
virtualRouterAutoScaleConfiguration	VirtualHub 路由器自动缩放配置。	VirtualRouterAutoScaleConfiguration
virtualRouterIps	VirtualRouter IP。	string[]
virtualWan	VirtualHub 所属的 VirtualWAN。	SubResource
vpnGateway	与此 VirtualHub 关联的 VpnGateway。	SubResource

VirtualHubRoute

名字	描述	价值
addressPrefixes	所有 addressPrefixes 的列表。	string[]
nextHopIpAddress	NextHop ip 地址。	字符串

VirtualHubRouteTable

名字	描述	价值
路线	所有路由的列表。	VirtualHubRoute[]

VirtualHubRouteTableV2

名字	描述	价值
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	虚拟中心路由表 v2 的属性。	VirtualHubRouteTableV2Properties

VirtualHubRouteTableV2Properties

名字	描述	价值
attachedConnections	附加到此路由表 v2 的所有连接的列表。	string[]
路线	所有路由的列表。	VirtualHubRouteV2[]

VirtualHubRouteV2

名字	描述	价值
目的地	所有目标的列表。	string[]
destinationType	目标的类型。	字符串
nextHops	NextHops ip 地址。	string[]
nextHopType	下一跃点的类型。	字符串

VirtualRouterAutoScaleConfiguration

名字	描述	价值
minCapacity	VirtualHub 路由器的最小缩放单位数。	int 约束： 最小值 = 0

快速入门示例

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

Bicep 文件	描述
在新子网中创建路由服务器	此模板将路由服务器部署到名为 RouteServerSubnet 的子网中。
创建虚拟 WAN 资源	使用此模板可以创建虚拟 WAN 资源，包括虚拟 WAN、虚拟中心、VPN 网关、VPN 站点和 VPN Connecton。
安全虚拟中心	此模板使用 Azure 防火墙创建安全的虚拟中心，以保护发往 Internet 的云网络流量。

ARM 模板资源定义

可以使用目标操作部署 virtualHubs 资源类型：

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

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

资源格式

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

{
  "type": "Microsoft.Network/virtualHubs",
  "apiVersion": "2024-05-01",
  "name": "string",
  "location": "string",
  "properties": {
    "addressPrefix": "string",
    "allowBranchToBranchTraffic": "bool",
    "azureFirewall": {
      "id": "string"
    },
    "expressRouteGateway": {
      "id": "string"
    },
    "hubRoutingPreference": "string",
    "p2SVpnGateway": {
      "id": "string"
    },
    "preferredRoutingGateway": "string",
    "routeTable": {
      "routes": [
        {
          "addressPrefixes": [ "string" ],
          "nextHopIpAddress": "string"
        }
      ]
    },
    "securityPartnerProvider": {
      "id": "string"
    },
    "securityProviderName": "string",
    "sku": "string",
    "virtualHubRouteTableV2s": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "attachedConnections": [ "string" ],
          "routes": [
            {
              "destinations": [ "string" ],
              "destinationType": "string",
              "nextHops": [ "string" ],
              "nextHopType": "string"
            }
          ]
        }
      }
    ],
    "virtualRouterAsn": "int",
    "virtualRouterAutoScaleConfiguration": {
      "minCapacity": "int"
    },
    "virtualRouterIps": [ "string" ],
    "virtualWan": {
      "id": "string"
    },
    "vpnGateway": {
      "id": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

Microsoft.Network/virtualHubs

名字	描述	价值
apiVersion	API 版本	'2024-05-01'
位置	资源位置。	字符串
名字	资源名称	string （必需）
性能	虚拟中心的属性。	VirtualHubProperties
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记
类型	资源类型	“Microsoft.Network/virtualHubs”

ResourceTags

名字	描述	价值

SubResource

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

VirtualHubProperties

名字	描述	价值
addressPrefix	此 VirtualHub 的地址前缀。	字符串
allowBranchToBranchTraffic	用于控制 VirtualRouter 中心的传输的标志。	bool
azureFirewall	与此 VirtualHub 关联的 azureFirewall。	SubResource
expressRouteGateway	与此 VirtualHub 关联的 expressRouteGateway。	SubResource
hubRoutingPreference	此 VirtualHub 的 hubRoutingPreference。	“ASPath” “ExpressRoute” “VpnGateway”
p2SVpnGateway	与此 VirtualHub 关联的 P2SVpnGateway。	SubResource
preferredRoutingGateway	用于路由本地流量的首选网关	“ExpressRoute” “None” “VpnGateway”
routeTable	与此虚拟中心关联的 routeTable。	VirtualHubRouteTable
securityPartnerProvider	与此 VirtualHub 关联的 securityPartnerProvider。	SubResource
securityProviderName	安全提供程序名称。	字符串
sku	此 VirtualHub 的 SKU。	字符串
virtualHubRouteTableV2s	与此 VirtualHub 关联的所有虚拟中心路由表 v2 的列表。	VirtualHubRouteTableV2[]
virtualRouterAsn	VirtualRouter ASN。	int 约束： 最小值 = 0 最大值 = 4294967295
virtualRouterAutoScaleConfiguration	VirtualHub 路由器自动缩放配置。	VirtualRouterAutoScaleConfiguration
virtualRouterIps	VirtualRouter IP。	string[]
virtualWan	VirtualHub 所属的 VirtualWAN。	SubResource
vpnGateway	与此 VirtualHub 关联的 VpnGateway。	SubResource

VirtualHubRoute

名字	描述	价值
addressPrefixes	所有 addressPrefixes 的列表。	string[]
nextHopIpAddress	NextHop ip 地址。	字符串

VirtualHubRouteTable

名字	描述	价值
路线	所有路由的列表。	VirtualHubRoute[]

VirtualHubRouteTableV2

名字	描述	价值
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	虚拟中心路由表 v2 的属性。	VirtualHubRouteTableV2Properties

VirtualHubRouteTableV2Properties

名字	描述	价值
attachedConnections	附加到此路由表 v2 的所有连接的列表。	string[]
路线	所有路由的列表。	VirtualHubRouteV2[]

VirtualHubRouteV2

名字	描述	价值
目的地	所有目标的列表。	string[]
destinationType	目标的类型。	字符串
nextHops	NextHops ip 地址。	string[]
nextHopType	下一跃点的类型。	字符串

VirtualRouterAutoScaleConfiguration

名字	描述	价值
minCapacity	VirtualHub 路由器的最小缩放单位数。	int 约束： 最小值 = 0

快速入门模板

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

模板	描述
使用 Quagga 在 BGP 对等互连中 Azure 路由服务器	此模板使用 Quagga 部署路由器服务器和 Ubuntu VM。 路由器服务器和 Quagga 之间建立了两个外部 BGP 会话。 Quagga 的安装和配置由适用于 linux 的 Azure 自定义脚本扩展执行
Azure 虚拟 WAN （vWAN） 多中心部署	使用此模板可以创建 Azure 虚拟 WAN（vWAN）多中心部署，包括所有网关和 VNET 连接。
使用自定义路由表 Azure vWAN 多中心部署	使用此模板可以创建 Azure 虚拟 WAN（vWAN）多中心部署，包括所有网关和 VNET 连接，并演示路由表用于自定义路由的用法。
在新子网中创建路由服务器	此模板将路由服务器部署到名为 RouteServerSubnet 的子网中。
创建虚拟 WAN 资源	使用此模板可以创建虚拟 WAN 资源，包括虚拟 WAN、虚拟中心、VPN 网关、VPN 站点和 VPN Connecton。
安全虚拟中心	此模板使用 Azure 防火墙创建安全的虚拟中心，以保护发往 Internet 的云网络流量。
使用多地址池和用户组 vWAN P2S 部署	此模板部署具有配置多个地址池和用户组的 P2S 的 Azure 虚拟 WAN （vWAN）

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

可以使用目标操作部署 virtualHubs 资源类型：

• 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/virtualHubs@2024-05-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      addressPrefix = "string"
      allowBranchToBranchTraffic = bool
      azureFirewall = {
        id = "string"
      }
      expressRouteGateway = {
        id = "string"
      }
      hubRoutingPreference = "string"
      p2SVpnGateway = {
        id = "string"
      }
      preferredRoutingGateway = "string"
      routeTable = {
        routes = [
          {
            addressPrefixes = [
              "string"
            ]
            nextHopIpAddress = "string"
          }
        ]
      }
      securityPartnerProvider = {
        id = "string"
      }
      securityProviderName = "string"
      sku = "string"
      virtualHubRouteTableV2s = [
        {
          id = "string"
          name = "string"
          properties = {
            attachedConnections = [
              "string"
            ]
            routes = [
              {
                destinations = [
                  "string"
                ]
                destinationType = "string"
                nextHops = [
                  "string"
                ]
                nextHopType = "string"
              }
            ]
          }
        }
      ]
      virtualRouterAsn = int
      virtualRouterAutoScaleConfiguration = {
        minCapacity = int
      }
      virtualRouterIps = [
        "string"
      ]
      virtualWan = {
        id = "string"
      }
      vpnGateway = {
        id = "string"
      }
    }
  })
}

属性值

Microsoft.Network/virtualHubs

名字	描述	价值
位置	资源位置。	字符串
名字	资源名称	string （必需）
性能	虚拟中心的属性。	VirtualHubProperties
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.Network/virtualHubs@2024-05-01”

ResourceTags

名字	描述	价值

SubResource

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

VirtualHubProperties

名字	描述	价值
addressPrefix	此 VirtualHub 的地址前缀。	字符串
allowBranchToBranchTraffic	用于控制 VirtualRouter 中心的传输的标志。	bool
azureFirewall	与此 VirtualHub 关联的 azureFirewall。	SubResource
expressRouteGateway	与此 VirtualHub 关联的 expressRouteGateway。	SubResource
hubRoutingPreference	此 VirtualHub 的 hubRoutingPreference。	“ASPath” “ExpressRoute” “VpnGateway”
p2SVpnGateway	与此 VirtualHub 关联的 P2SVpnGateway。	SubResource
preferredRoutingGateway	用于路由本地流量的首选网关	“ExpressRoute” “None” “VpnGateway”
routeTable	与此虚拟中心关联的 routeTable。	VirtualHubRouteTable
securityPartnerProvider	与此 VirtualHub 关联的 securityPartnerProvider。	SubResource
securityProviderName	安全提供程序名称。	字符串
sku	此 VirtualHub 的 SKU。	字符串
virtualHubRouteTableV2s	与此 VirtualHub 关联的所有虚拟中心路由表 v2 的列表。	VirtualHubRouteTableV2[]
virtualRouterAsn	VirtualRouter ASN。	int 约束： 最小值 = 0 最大值 = 4294967295
virtualRouterAutoScaleConfiguration	VirtualHub 路由器自动缩放配置。	VirtualRouterAutoScaleConfiguration
virtualRouterIps	VirtualRouter IP。	string[]
virtualWan	VirtualHub 所属的 VirtualWAN。	SubResource
vpnGateway	与此 VirtualHub 关联的 VpnGateway。	SubResource

VirtualHubRoute

名字	描述	价值
addressPrefixes	所有 addressPrefixes 的列表。	string[]
nextHopIpAddress	NextHop ip 地址。	字符串

VirtualHubRouteTable

名字	描述	价值
路线	所有路由的列表。	VirtualHubRoute[]

VirtualHubRouteTableV2

名字	描述	价值
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	虚拟中心路由表 v2 的属性。	VirtualHubRouteTableV2Properties

VirtualHubRouteTableV2Properties

名字	描述	价值
attachedConnections	附加到此路由表 v2 的所有连接的列表。	string[]
路线	所有路由的列表。	VirtualHubRouteV2[]

VirtualHubRouteV2

名字	描述	价值
目的地	所有目标的列表。	string[]
destinationType	目标的类型。	字符串
nextHops	NextHops ip 地址。	string[]
nextHopType	下一跃点的类型。	字符串

VirtualRouterAutoScaleConfiguration

名字	描述	价值
minCapacity	VirtualHub 路由器的最小缩放单位数。	int 约束： 最小值 = 0