你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn 。
Microsoft.Network virtualHubs 2020-04-01
本文内容
Bicep resource definition
The virtualHubs resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.Network/virtualHubs resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Network/virtualHubs@2020-04-01' = {
location: 'string'
name: 'string'
properties: {
addressPrefix: 'string'
azureFirewall: {
id: 'string'
}
expressRouteGateway: {
id: 'string'
}
p2SVpnGateway: {
id: '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'
}
]
}
}
]
virtualNetworkConnections: [
{
id: 'string'
name: 'string'
properties: {
allowHubToRemoteVnetTransit: bool
allowRemoteVnetToUseHubVnetGateways: bool
enableInternetSecurity: bool
remoteVirtualNetwork: {
id: 'string'
}
routingConfiguration: {
associatedRouteTable: {
id: 'string'
}
propagatedRouteTables: {
ids: [
{
id: 'string'
}
]
labels: [
'string'
]
}
vnetRoutes: {
staticRoutes: [
{
addressPrefixes: [
'string'
]
name: 'string'
nextHopIpAddress: 'string'
}
]
}
}
}
}
]
virtualWan: {
id: 'string'
}
vpnGateway: {
id: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Property values
HubVirtualNetworkConnection
Name
Description
Value
id
Resource ID.
string
name
The name of the resource that is unique within a resource group. This name can be used to access the resource.
string
properties
Properties of the hub virtual network connection.
HubVirtualNetworkConnectionProperties
HubVirtualNetworkConnectionProperties
Name
Description
Value
allowHubToRemoteVnetTransit
VirtualHub to RemoteVnet transit to enabled or not.
bool
allowRemoteVnetToUseHubVnetGateways
Allow RemoteVnet to use Virtual Hub's gateways.
bool
enableInternetSecurity
Enable internet security.
bool
remoteVirtualNetwork
Reference to the remote virtual network.
SubResource
routingConfiguration
The Routing Configuration indicating the associated and propagated route tables on this connection.
RoutingConfiguration
Microsoft.Network/virtualHubs
Name
Description
Value
location
Resource location.
string
name
The resource name
string (required)
properties
Properties of the virtual hub.
VirtualHubProperties
tags
Resource tags
Dictionary of tag names and values. See Tags in templates
PropagatedRouteTable
Name
Description
Value
ids
The list of resource ids of all the RouteTables.
SubResource []
labels
The list of labels.
string[]
RoutingConfiguration
Name
Description
Value
associatedRouteTable
The resource id RouteTable associated with this RoutingConfiguration.
SubResource
propagatedRouteTables
The list of RouteTables to advertise the routes to.
PropagatedRouteTable
vnetRoutes
List of routes that control routing from VirtualHub into a virtual network connection.
VnetRoute
StaticRoute
Name
Description
Value
addressPrefixes
List of all address prefixes.
string[]
name
The name of the StaticRoute that is unique within a VnetRoute.
string
nextHopIpAddress
The ip address of the next hop.
string
SubResource
Name
Description
Value
id
Resource ID.
string
VirtualHubProperties
Name
Description
Value
addressPrefix
Address-prefix for this VirtualHub.
string
azureFirewall
The azureFirewall associated with this VirtualHub.
SubResource
expressRouteGateway
The expressRouteGateway associated with this VirtualHub.
SubResource
p2SVpnGateway
The P2SVpnGateway associated with this VirtualHub.
SubResource
routeTable
The routeTable associated with this virtual hub.
VirtualHubRouteTable
securityPartnerProvider
The securityPartnerProvider associated with this VirtualHub.
SubResource
securityProviderName
The Security Provider name.
string
sku
The sku of this VirtualHub.
string
virtualHubRouteTableV2s
List of all virtual hub route table v2s associated with this VirtualHub.
VirtualHubRouteTableV2 []
virtualNetworkConnections
List of all vnet connections with this VirtualHub.
HubVirtualNetworkConnection []
virtualWan
The VirtualWAN to which the VirtualHub belongs.
SubResource
vpnGateway
The VpnGateway associated with this VirtualHub.
SubResource
VirtualHubRoute
Name
Description
Value
addressPrefixes
List of all addressPrefixes.
string[]
nextHopIpAddress
NextHop ip address.
string
VirtualHubRouteTable
VirtualHubRouteTableV2
Name
Description
Value
id
Resource ID.
string
name
The name of the resource that is unique within a resource group. This name can be used to access the resource.
string
properties
Properties of the virtual hub route table v2.
VirtualHubRouteTableV2Properties
VirtualHubRouteTableV2Properties
Name
Description
Value
attachedConnections
List of all connections attached to this route table v2.
string[]
routes
List of all routes.
VirtualHubRouteV2 []
VirtualHubRouteV2
Name
Description
Value
destinations
List of all destinations.
string[]
destinationType
The type of destinations.
string
nextHops
NextHops ip address.
string[]
nextHopType
The type of next hops.
string
VnetRoute
Name
Description
Value
staticRoutes
List of all Static Routes.
StaticRoute []
Quickstart samples
The following quickstart samples deploy this resource type.
Bicep File
Description
Create a Route Server in a New Subnet This template deploys a Route Server into a subnet named RouteServerSubnet.
Creates Virtual WAN resources This template allows you to create virtual WAN resources including Virtual WAN, Virtual Hub, VPN Gateway, VPN Site and a VPN Connecton.
Secured virtual hubs This template creates a secured virtual hub using Azure Firewall to secure your cloud network traffic destined to the Internet.
ARM template resource definition
The virtualHubs resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.Network/virtualHubs resource, add the following JSON to your template.
{
"type": "Microsoft.Network/virtualHubs",
"apiVersion": "2020-04-01",
"name": "string",
"location": "string",
"properties": {
"addressPrefix": "string",
"azureFirewall": {
"id": "string"
},
"expressRouteGateway": {
"id": "string"
},
"p2SVpnGateway": {
"id": "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"
}
]
}
}
],
"virtualNetworkConnections": [
{
"id": "string",
"name": "string",
"properties": {
"allowHubToRemoteVnetTransit": "bool",
"allowRemoteVnetToUseHubVnetGateways": "bool",
"enableInternetSecurity": "bool",
"remoteVirtualNetwork": {
"id": "string"
},
"routingConfiguration": {
"associatedRouteTable": {
"id": "string"
},
"propagatedRouteTables": {
"ids": [
{
"id": "string"
}
],
"labels": [ "string" ]
},
"vnetRoutes": {
"staticRoutes": [
{
"addressPrefixes": [ "string" ],
"name": "string",
"nextHopIpAddress": "string"
}
]
}
}
}
}
],
"virtualWan": {
"id": "string"
},
"vpnGateway": {
"id": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Property values
HubVirtualNetworkConnection
Name
Description
Value
id
Resource ID.
string
name
The name of the resource that is unique within a resource group. This name can be used to access the resource.
string
properties
Properties of the hub virtual network connection.
HubVirtualNetworkConnectionProperties
HubVirtualNetworkConnectionProperties
Name
Description
Value
allowHubToRemoteVnetTransit
VirtualHub to RemoteVnet transit to enabled or not.
bool
allowRemoteVnetToUseHubVnetGateways
Allow RemoteVnet to use Virtual Hub's gateways.
bool
enableInternetSecurity
Enable internet security.
bool
remoteVirtualNetwork
Reference to the remote virtual network.
SubResource
routingConfiguration
The Routing Configuration indicating the associated and propagated route tables on this connection.
RoutingConfiguration
Microsoft.Network/virtualHubs
Name
Description
Value
apiVersion
The api version
'2020-04-01'
location
Resource location.
string
name
The resource name
string (required)
properties
Properties of the virtual hub.
VirtualHubProperties
tags
Resource tags
Dictionary of tag names and values. See Tags in templates
type
The resource type
'Microsoft.Network/virtualHubs'
PropagatedRouteTable
Name
Description
Value
ids
The list of resource ids of all the RouteTables.
SubResource []
labels
The list of labels.
string[]
RoutingConfiguration
Name
Description
Value
associatedRouteTable
The resource id RouteTable associated with this RoutingConfiguration.
SubResource
propagatedRouteTables
The list of RouteTables to advertise the routes to.
PropagatedRouteTable
vnetRoutes
List of routes that control routing from VirtualHub into a virtual network connection.
VnetRoute
StaticRoute
Name
Description
Value
addressPrefixes
List of all address prefixes.
string[]
name
The name of the StaticRoute that is unique within a VnetRoute.
string
nextHopIpAddress
The ip address of the next hop.
string
SubResource
Name
Description
Value
id
Resource ID.
string
VirtualHubProperties
Name
Description
Value
addressPrefix
Address-prefix for this VirtualHub.
string
azureFirewall
The azureFirewall associated with this VirtualHub.
SubResource
expressRouteGateway
The expressRouteGateway associated with this VirtualHub.
SubResource
p2SVpnGateway
The P2SVpnGateway associated with this VirtualHub.
SubResource
routeTable
The routeTable associated with this virtual hub.
VirtualHubRouteTable
securityPartnerProvider
The securityPartnerProvider associated with this VirtualHub.
SubResource
securityProviderName
The Security Provider name.
string
sku
The sku of this VirtualHub.
string
virtualHubRouteTableV2s
List of all virtual hub route table v2s associated with this VirtualHub.
VirtualHubRouteTableV2 []
virtualNetworkConnections
List of all vnet connections with this VirtualHub.
HubVirtualNetworkConnection []
virtualWan
The VirtualWAN to which the VirtualHub belongs.
SubResource
vpnGateway
The VpnGateway associated with this VirtualHub.
SubResource
VirtualHubRoute
Name
Description
Value
addressPrefixes
List of all addressPrefixes.
string[]
nextHopIpAddress
NextHop ip address.
string
VirtualHubRouteTable
VirtualHubRouteTableV2
Name
Description
Value
id
Resource ID.
string
name
The name of the resource that is unique within a resource group. This name can be used to access the resource.
string
properties
Properties of the virtual hub route table v2.
VirtualHubRouteTableV2Properties
VirtualHubRouteTableV2Properties
Name
Description
Value
attachedConnections
List of all connections attached to this route table v2.
string[]
routes
List of all routes.
VirtualHubRouteV2 []
VirtualHubRouteV2
Name
Description
Value
destinations
List of all destinations.
string[]
destinationType
The type of destinations.
string
nextHops
NextHops ip address.
string[]
nextHopType
The type of next hops.
string
VnetRoute
Name
Description
Value
staticRoutes
List of all Static Routes.
StaticRoute []
Quickstart templates
The following quickstart templates deploy this resource type.
The virtualHubs resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.Network/virtualHubs resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/virtualHubs@2020-04-01"
name = "string"
location = "string"
body = jsonencode({
properties = {
addressPrefix = "string"
azureFirewall = {
id = "string"
}
expressRouteGateway = {
id = "string"
}
p2SVpnGateway = {
id = "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"
}
]
}
}
]
virtualNetworkConnections = [
{
id = "string"
name = "string"
properties = {
allowHubToRemoteVnetTransit = bool
allowRemoteVnetToUseHubVnetGateways = bool
enableInternetSecurity = bool
remoteVirtualNetwork = {
id = "string"
}
routingConfiguration = {
associatedRouteTable = {
id = "string"
}
propagatedRouteTables = {
ids = [
{
id = "string"
}
]
labels = [
"string"
]
}
vnetRoutes = {
staticRoutes = [
{
addressPrefixes = [
"string"
]
name = "string"
nextHopIpAddress = "string"
}
]
}
}
}
}
]
virtualWan = {
id = "string"
}
vpnGateway = {
id = "string"
}
}
})
tags = {
{customized property} = "string"
}
}
Property values
HubVirtualNetworkConnection
Name
Description
Value
id
Resource ID.
string
name
The name of the resource that is unique within a resource group. This name can be used to access the resource.
string
properties
Properties of the hub virtual network connection.
HubVirtualNetworkConnectionProperties
HubVirtualNetworkConnectionProperties
Name
Description
Value
allowHubToRemoteVnetTransit
VirtualHub to RemoteVnet transit to enabled or not.
bool
allowRemoteVnetToUseHubVnetGateways
Allow RemoteVnet to use Virtual Hub's gateways.
bool
enableInternetSecurity
Enable internet security.
bool
remoteVirtualNetwork
Reference to the remote virtual network.
SubResource
routingConfiguration
The Routing Configuration indicating the associated and propagated route tables on this connection.
RoutingConfiguration
Microsoft.Network/virtualHubs
Name
Description
Value
location
Resource location.
string
name
The resource name
string (required)
properties
Properties of the virtual hub.
VirtualHubProperties
tags
Resource tags
Dictionary of tag names and values.
type
The resource type
"Microsoft.Network/virtualHubs@2020-04-01"
PropagatedRouteTable
Name
Description
Value
ids
The list of resource ids of all the RouteTables.
SubResource []
labels
The list of labels.
string[]
RoutingConfiguration
Name
Description
Value
associatedRouteTable
The resource id RouteTable associated with this RoutingConfiguration.
SubResource
propagatedRouteTables
The list of RouteTables to advertise the routes to.
PropagatedRouteTable
vnetRoutes
List of routes that control routing from VirtualHub into a virtual network connection.
VnetRoute
StaticRoute
Name
Description
Value
addressPrefixes
List of all address prefixes.
string[]
name
The name of the StaticRoute that is unique within a VnetRoute.
string
nextHopIpAddress
The ip address of the next hop.
string
SubResource
Name
Description
Value
id
Resource ID.
string
VirtualHubProperties
Name
Description
Value
addressPrefix
Address-prefix for this VirtualHub.
string
azureFirewall
The azureFirewall associated with this VirtualHub.
SubResource
expressRouteGateway
The expressRouteGateway associated with this VirtualHub.
SubResource
p2SVpnGateway
The P2SVpnGateway associated with this VirtualHub.
SubResource
routeTable
The routeTable associated with this virtual hub.
VirtualHubRouteTable
securityPartnerProvider
The securityPartnerProvider associated with this VirtualHub.
SubResource
securityProviderName
The Security Provider name.
string
sku
The sku of this VirtualHub.
string
virtualHubRouteTableV2s
List of all virtual hub route table v2s associated with this VirtualHub.
VirtualHubRouteTableV2 []
virtualNetworkConnections
List of all vnet connections with this VirtualHub.
HubVirtualNetworkConnection []
virtualWan
The VirtualWAN to which the VirtualHub belongs.
SubResource
vpnGateway
The VpnGateway associated with this VirtualHub.
SubResource
VirtualHubRoute
Name
Description
Value
addressPrefixes
List of all addressPrefixes.
string[]
nextHopIpAddress
NextHop ip address.
string
VirtualHubRouteTable
VirtualHubRouteTableV2
Name
Description
Value
id
Resource ID.
string
name
The name of the resource that is unique within a resource group. This name can be used to access the resource.
string
properties
Properties of the virtual hub route table v2.
VirtualHubRouteTableV2Properties
VirtualHubRouteTableV2Properties
Name
Description
Value
attachedConnections
List of all connections attached to this route table v2.
string[]
routes
List of all routes.
VirtualHubRouteV2 []
VirtualHubRouteV2
Name
Description
Value
destinations
List of all destinations.
string[]
destinationType
The type of destinations.
string
nextHops
NextHops ip address.
string[]
nextHopType
The type of next hops.
string
VnetRoute
Name
Description
Value
staticRoutes
List of all Static Routes.
StaticRoute []
