Share via

Microsoft.Network virtualHubs/hubVirtualNetworkConnections 2022-05-01

  • Article

Bicep 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.

Resource format

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

resource symbolicname 'Microsoft.Network/virtualHubs/hubVirtualNetworkConnections@2022-05-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

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

Microsoft.Network/virtualHubs/hubVirtualNetworkConnections

Name Description Value
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: virtualHubs
properties Properties of the hub virtual network connection. HubVirtualNetworkConnectionProperties

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
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

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'

SubResource

Name Description Value
id Resource ID. string

VnetRoute

Name Description Value
staticRoutes List of all Static Routes. StaticRoute[]
staticRoutesConfig Configuration for static routes on this HubVnetConnection. StaticRoutesConfig

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File Description
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/hubVirtualNetworkConnections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

{
  "type": "Microsoft.Network/virtualHubs/hubVirtualNetworkConnections",
  "apiVersion": "2022-05-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

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

Microsoft.Network/virtualHubs/hubVirtualNetworkConnections

Name Description Value
apiVersion The api version '2022-05-01'
name The resource name string (required)
properties Properties of the hub virtual network connection. HubVirtualNetworkConnectionProperties
type The resource type 'Microsoft.Network/virtualHubs/hubVirtualNetworkConnections'

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
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

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'

SubResource

Name Description Value
id Resource ID. string

VnetRoute

Name Description Value
staticRoutes List of all Static Routes. StaticRoute[]
staticRoutesConfig Configuration for static routes on this HubVnetConnection. StaticRoutesConfig

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.
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.
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.
vWAN P2S deployment with multi address pool and user groups

Deploy to Azure		 This template deploys Azure Virtual WAN (vWAN) with a P2S configured with multiple address pool and user groups

Terraform (AzAPI provider) resource definition

The virtualHubs/hubVirtualNetworkConnections resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/virtualHubs/hubVirtualNetworkConnections@2022-05-01"
  name = "string"
  body = jsonencode({
    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

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

Microsoft.Network/virtualHubs/hubVirtualNetworkConnections

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: virtualHubs
properties Properties of the hub virtual network connection. HubVirtualNetworkConnectionProperties
type The resource type "Microsoft.Network/virtualHubs/hubVirtualNetworkConnections@2022-05-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
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

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'

SubResource

Name Description Value
id Resource ID. string

VnetRoute

Name Description Value
staticRoutes List of all Static Routes. StaticRoute[]
staticRoutesConfig Configuration for static routes on this HubVnetConnection. StaticRoutesConfig