Microsoft.Network virtualHubs/hubVirtualNetworkConnections

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.

Usage Examples

Bicep Samples

A basic example of deploying Connection for a Virtual Hub.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource virtualNetwork 'Microsoft.Network/virtualNetworks@2022-07-01' = {
  name: resourceName
  location: location
  properties: {
    addressSpace: {
      addressPrefixes: [
        '10.5.0.0/16'
      ]
    }
    dhcpOptions: {
      dnsServers: []
    }
    subnets: []
  }
}

resource virtualWan 'Microsoft.Network/virtualWans@2022-07-01' = {
  name: resourceName
  location: location
  properties: {
    allowBranchToBranchTraffic: true
    disableVpnEncryption: false
    office365LocalBreakoutCategory: 'None'
    type: 'Standard'
  }
}

resource virtualHub 'Microsoft.Network/virtualHubs@2022-07-01' = {
  name: resourceName
  location: location
  properties: {
    addressPrefix: '10.0.2.0/24'
    hubRoutingPreference: 'ExpressRoute'
    virtualRouterAutoScaleConfiguration: {
      minCapacity: 2
    }
    virtualWan: {
      id: virtualWan.id
    }
  }
}

resource hubVirtualNetworkConnection 'Microsoft.Network/virtualHubs/hubVirtualNetworkConnections@2022-07-01' = {
  name: resourceName
  parent: virtualHub
  properties: {
    enableInternetSecurity: false
    remoteVirtualNetwork: {
      id: virtualNetwork.id
    }
  }
}

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module	Description
Virtual Hub - Hub Virtual Network Connection	AVM Child Module for Virtual Hub - Hub Virtual Network Connection

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying 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.

Resource format

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

resource symbolicname 'Microsoft.Network/virtualHubs/hubVirtualNetworkConnections@2026-03-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    allowHubToRemoteVnetTransit: bool
    allowRemoteVnetToUseHubVnetGateways: bool
    connectionPolicy: {
      id: 'string'
    }
    enableInternetSecurity: bool
    enableOnlyIPv6Peering: 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: {
          propagateStaticRoutes: bool
          vnetLocalRouteOverrideCriteria: 'string'
        }
      }
    }
  }
}

Property Values