ARM template resource definition
The virtualHubs/hubVirtualNetworkConnections 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/hubVirtualNetworkConnections resource, add the following JSON to your template.
{
"type": "Microsoft.Network/virtualHubs/hubVirtualNetworkConnections",
"apiVersion": "2023-04-01",
"name": "string",
"properties": {
"allowHubToRemoteVnetTransit": "bool",
"allowRemoteVnetToUseHubVnetGateways": "bool",
"enableInternetSecurity": "bool",
"remoteVirtualNetwork": {
"id": "string"
},
"routingConfiguration": {
"associatedRouteTable": {
"id": "string"
},
"inboundRouteMap": {
"id": "string"
},
"outboundRouteMap": {
"id": "string"
},
"propagatedRouteTables": {
"ids": [
{
"id": "string"
}
],
"labels": [ "string" ]
},
"vnetRoutes": {
"staticRoutes": [
{
"addressPrefixes": [ "string" ],
"name": "string",
"nextHopIpAddress": "string"
}
],
"staticRoutesConfig": {
"vnetLocalRouteOverrideCriteria": "string"
}
}
}
}
}
Property values
virtualHubs/hubVirtualNetworkConnections
Name |
Description |
Value |
type |
The resource type |
'Microsoft.Network/virtualHubs/hubVirtualNetworkConnections' |
apiVersion |
The resource api version |
'2023-04-01' |
name |
The resource name
See how to set names and types for child resources in JSON ARM templates. |
string (required) |
properties |
Properties of the hub virtual network connection. |
HubVirtualNetworkConnectionProperties |
HubVirtualNetworkConnectionProperties
Name |
Description |
Value |
allowHubToRemoteVnetTransit |
Deprecated: VirtualHub to RemoteVnet transit to enabled or not. |
bool |
allowRemoteVnetToUseHubVnetGateways |
Deprecated: 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 |
SubResource
Name |
Description |
Value |
id |
Resource ID. |
string |
RoutingConfiguration
Name |
Description |
Value |
associatedRouteTable |
The resource id RouteTable associated with this RoutingConfiguration. |
SubResource |
inboundRouteMap |
The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes. |
SubResource |
outboundRouteMap |
The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes. |
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 |
PropagatedRouteTable
Name |
Description |
Value |
ids |
The list of resource ids of all the RouteTables. |
SubResource[] |
labels |
The list of labels. |
string[] |
VnetRoute
Name |
Description |
Value |
staticRoutes |
List of all Static Routes. |
StaticRoute[] |
staticRoutesConfig |
Configuration for static routes on this HubVnetConnection. |
StaticRoutesConfig |
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 |
StaticRoutesConfig
Name |
Description |
Value |
vnetLocalRouteOverrideCriteria |
Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke. |
'Contains' 'Equal' |
Quickstart templates
The following quickstart templates deploy this resource type.