Microsoft.Network virtualHubs/hubVirtualNetworkConnections 2023-06-01

Bicep resource definition

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

• Resource groups - See resource group deployment commands

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@2023-06-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

Microsoft.Network/virtualHubs/hubVirtualNetworkConnections

PropagatedRouteTable

RoutingConfiguration

StaticRoute

StaticRoutesConfig

SubResource

VnetRoute

Quickstart samples

The following quickstart samples deploy this resource type.

ARM template resource definition

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

• Resource groups - See resource group deployment commands

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": "2023-06-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

Microsoft.Network/virtualHubs/hubVirtualNetworkConnections

PropagatedRouteTable

RoutingConfiguration

StaticRoute

StaticRoutesConfig

SubResource

VnetRoute

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Azure Virtual WAN (vWAN) Multi-Hub Deployment	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	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	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	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@2023-06-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

Microsoft.Network/virtualHubs/hubVirtualNetworkConnections

PropagatedRouteTable

RoutingConfiguration

StaticRoute

StaticRoutesConfig

SubResource

VnetRoute