Microsoft.Network virtualHubs/hubVirtualNetworkConnections 2020-05-01

The virtualHubs/hubVirtualNetworkConnections resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.Network/virtualHubs/hubVirtualNetworkConnections resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Network/virtualHubs/hubVirtualNetworkConnections@2020-05-01' = {
  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'
          }
        ]
      }
    }
  }
}

Property values

virtualHubs/hubVirtualNetworkConnections

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.Network/virtualHubs/hubVirtualNetworkConnections'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2020-05-01'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
properties Parameters for HubVirtualNetworkConnection. 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 another subresource. SubResource
routingConfiguration Routing Configuration indicating the associated and propagated route tables for this connection. RoutingConfiguration

SubResource

Name Description Value
id Resource ID. string

RoutingConfiguration

Name Description Value
associatedRouteTable Reference to another subresource. 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[]

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

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
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.