Microsoft.Network virtualHubs/hubVirtualNetworkConnections

Template format

To create a Microsoft.Network/virtualHubs/hubVirtualNetworkConnections resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Network/virtualHubs/hubVirtualNetworkConnections",
  "apiVersion": "2020-07-01",
  "properties": {
    "remoteVirtualNetwork": {
      "id": "string"
    },
    "allowHubToRemoteVnetTransit": "boolean",
    "allowRemoteVnetToUseHubVnetGateways": "boolean",
    "enableInternetSecurity": "boolean",
    "routingConfiguration": {
      "associatedRouteTable": {
        "id": "string"
      },
      "propagatedRouteTables": {
        "labels": [
          "string"
        ],
        "ids": [
          {
            "id": "string"
          }
        ]
      },
      "vnetRoutes": {
        "staticRoutes": [
          {
            "name": "string",
            "addressPrefixes": [
              "string"
            ],
            "nextHopIpAddress": "string"
          }
        ]
      }
    }
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Network/virtualHubs/hubVirtualNetworkConnections object

Note

In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.

Name Type Required Value
name string Yes The name of the HubVirtualNetworkConnection.
type enum Yes For JSON -hubVirtualNetworkConnections
-or-
Microsoft.Network/virtualHubs/hubVirtualNetworkConnections

See Set name and type for child resources.
apiVersion enum Yes For JSON - 2020-07-01
properties object Yes Properties of the hub virtual network connection. - HubVirtualNetworkConnectionProperties object

HubVirtualNetworkConnectionProperties object

Name Type Required Value
remoteVirtualNetwork object No Reference to the remote virtual network. - SubResource object
allowHubToRemoteVnetTransit boolean No Deprecated: VirtualHub to RemoteVnet transit to enabled or not.
allowRemoteVnetToUseHubVnetGateways boolean No Deprecated: Allow RemoteVnet to use Virtual Hub's gateways.
enableInternetSecurity boolean No Enable internet security.
routingConfiguration object No The Routing Configuration indicating the associated and propagated route tables on this connection. - RoutingConfiguration object

SubResource object

Name Type Required Value
id string No Resource ID.

RoutingConfiguration object

Name Type Required Value
associatedRouteTable object No The resource id RouteTable associated with this RoutingConfiguration. - SubResource object
propagatedRouteTables object No The list of RouteTables to advertise the routes to. - PropagatedRouteTable object
vnetRoutes object No List of routes that control routing from VirtualHub into a virtual network connection. - VnetRoute object

PropagatedRouteTable object

Name Type Required Value
labels array No The list of labels. - string
ids array No The list of resource ids of all the RouteTables. - SubResource object

VnetRoute object

Name Type Required Value
staticRoutes array No List of all Static Routes. - StaticRoute object

StaticRoute object

Name Type Required Value
name string No The name of the StaticRoute that is unique within a VnetRoute.
addressPrefixes array No List of all address prefixes. - string
nextHopIpAddress string No The ip address of the next hop.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Azure Virtual WAN (vWAN) Multi-Hub Deployment

Deploy to Azure
This template allows you to create an Azure Virtual WAN (vWAN) multi-hub deployment including all gateways and VNET connections.
Secured virtual hubs

Deploy to Azure
This template creates a secured virtual hub using Azure Firewall to secure your cloud network traffic destined to the Internet.
Secured virtual hubs

Deploy to Azure
This template creates a secured virtual hub using Azure Firewall to secure your cloud network traffic destined to the Internet.
Azure Virtual WAN (vWAN) Multi-Hub Deployment

Deploy to Azure
This template allows you to create an Azure Virtual WAN (vWAN) multi-hub deployment including all gateways and VNET connections.
Azure vWAN Multi-Hub Deployment with Custom Routing Tables

Deploy to Azure
This template allows you to create an Azure Virtual WAN (vWAN) multi-hub deployment, including all gateways and VNET connections, and demonstrate the usage of Route Tables for custom routing.