Microsoft.Network virtualHubs 2020-05-01

The virtualHubs 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 resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Network/virtualHubs@2020-05-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    addressPrefix: 'string'
    azureFirewall: {
      id: 'string'
    }
    expressRouteGateway: {
      id: 'string'
    }
    p2SVpnGateway: {
      id: 'string'
    }
    routeTable: {
      routes: [
        {
          addressPrefixes: [ 'string' ]
          nextHopIpAddress: 'string'
        }
      ]
    }
    securityPartnerProvider: {
      id: 'string'
    }
    securityProviderName: 'string'
    sku: 'string'
    virtualHubRouteTableV2s: [
      {
        id: 'string'
        name: 'string'
        properties: {
          attachedConnections: [ 'string' ]
          routes: [
            {
              destinations: [ 'string' ]
              destinationType: 'string'
              nextHops: [ 'string' ]
              nextHopType: 'string'
            }
          ]
        }
      }
    ]
    virtualRouterAsn: int
    virtualRouterIps: [ 'string' ]
    virtualWan: {
      id: 'string'
    }
    vpnGateway: {
      id: 'string'
    }
  }
}

Property values

virtualHubs

Name Description Value
type The resource type

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

For Bicep, set this value in the resource declaration.
'2020-05-01'
name The resource name string (required)
location Resource location. string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties Parameters for VirtualHub. VirtualHubProperties

VirtualHubProperties

Name Description Value
addressPrefix Address-prefix for this VirtualHub. string
azureFirewall Reference to another subresource. SubResource
expressRouteGateway Reference to another subresource. SubResource
p2SVpnGateway Reference to another subresource. SubResource
routeTable VirtualHub route table. VirtualHubRouteTable
securityPartnerProvider Reference to another subresource. SubResource
securityProviderName The Security Provider name. string
sku The sku of this VirtualHub. string
virtualHubRouteTableV2s List of all virtual hub route table v2s associated with this VirtualHub. VirtualHubRouteTableV2[]
virtualRouterAsn VirtualRouter ASN. int
virtualRouterIps VirtualRouter IPs. string[]
virtualWan Reference to another subresource. SubResource
vpnGateway Reference to another subresource. SubResource

SubResource

Name Description Value
id Resource ID. string

VirtualHubRouteTable

Name Description Value
routes List of all routes. VirtualHubRoute[]

VirtualHubRoute

Name Description Value
addressPrefixes List of all addressPrefixes. string[]
nextHopIpAddress NextHop ip address. string

VirtualHubRouteTableV2

Name Description Value
id Resource ID. string
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
properties Parameters for VirtualHubRouteTableV2. VirtualHubRouteTableV2Properties

VirtualHubRouteTableV2Properties

Name Description Value
attachedConnections List of all connections attached to this route table v2. string[]
routes List of all routes. VirtualHubRouteV2[]

VirtualHubRouteV2

Name Description Value
destinations List of all destinations. string[]
destinationType The type of destinations. string
nextHops NextHops ip address. string[]
nextHopType The type of next hops. 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.
Create a Route Server in a New Subnet

Deploy to Azure
This template deploys a Route Server into a subnet named routeserversubnet.
Azure Route Server in BGP peering with Quagga

Deploy to Azure
This template deploys a Router Server and Ubuntu VM with Quagga. Two external BGP sessions are established between the Router Server and Quagga. Installation and configuration of Quagga is executed by Azure custom script extension for linux
Creates Virtual wan resources

Deploy to Azure
This template allows you to create virtual wan resources including virtual wan, virtual hub, vpn gateway, vpnsite and a vpn connecton.
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.