Microsoft.Network virtualHubs 2020-06-01

Template format

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

{
  "name": "string",
  "type": "Microsoft.Network/virtualHubs",
  "apiVersion": "2020-06-01",
  "location": "string",
  "tags": {},
  "properties": {
    "virtualWan": {
      "id": "string"
    },
    "vpnGateway": {
      "id": "string"
    },
    "p2SVpnGateway": {
      "id": "string"
    },
    "expressRouteGateway": {
      "id": "string"
    },
    "azureFirewall": {
      "id": "string"
    },
    "securityPartnerProvider": {
      "id": "string"
    },
    "addressPrefix": "string",
    "routeTable": {
      "routes": [
        {
          "addressPrefixes": [
            "string"
          ],
          "nextHopIpAddress": "string"
        }
      ]
    },
    "securityProviderName": "string",
    "virtualHubRouteTableV2s": [
      {
        "id": "string",
        "properties": {
          "routes": [
            {
              "destinationType": "string",
              "destinations": [
                "string"
              ],
              "nextHopType": "string",
              "nextHops": [
                "string"
              ]
            }
          ],
          "attachedConnections": [
            "string"
          ]
        },
        "name": "string"
      }
    ],
    "sku": "string",
    "routingState": "string",
    "virtualRouterAsn": "integer",
    "virtualRouterIps": [
      "string"
    ],
    "enableVirtualRouterRoutePropogation": "boolean"
  },
  "resources": []
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Network/virtualHubs object

Name Type Required Value
name string Yes The name of the VirtualHub.
type enum Yes Microsoft.Network/virtualHubs
apiVersion enum Yes 2020-06-01
location string Yes Resource location.
tags object No Resource tags.
properties object Yes Properties of the virtual hub. - VirtualHubProperties object
resources array No hubRouteTables ipConfigurations bgpConnections routeTables hubVirtualNetworkConnections

VirtualHubProperties object

Name Type Required Value
virtualWan object No The VirtualWAN to which the VirtualHub belongs. - SubResource object
vpnGateway object No The VpnGateway associated with this VirtualHub. - SubResource object
p2SVpnGateway object No The P2SVpnGateway associated with this VirtualHub. - SubResource object
expressRouteGateway object No The expressRouteGateway associated with this VirtualHub. - SubResource object
azureFirewall object No The azureFirewall associated with this VirtualHub. - SubResource object
securityPartnerProvider object No The securityPartnerProvider associated with this VirtualHub. - SubResource object
addressPrefix string No Address-prefix for this VirtualHub.
routeTable object No The routeTable associated with this virtual hub. - VirtualHubRouteTable object
securityProviderName string No The Security Provider name.
virtualHubRouteTableV2s array No List of all virtual hub route table v2s associated with this VirtualHub. - VirtualHubRouteTableV2 object
sku string No The sku of this VirtualHub.
routingState enum No The routing state. - None, Provisioned, Provisioning, Failed
virtualRouterAsn integer No VirtualRouter ASN.
virtualRouterIps array No VirtualRouter IPs. - string
enableVirtualRouterRoutePropogation boolean No Flag to control route propogation for VirtualRouter hub.

SubResource object

Name Type Required Value
id string No Resource ID.

VirtualHubRouteTable object

Name Type Required Value
routes array No List of all routes. - VirtualHubRoute object

VirtualHubRouteTableV2 object

Name Type Required Value
id string No Resource ID.
properties object No Properties of the virtual hub route table v2. - VirtualHubRouteTableV2Properties object
name string No The name of the resource that is unique within a resource group. This name can be used to access the resource.

VirtualHubRoute object

Name Type Required Value
addressPrefixes array No List of all addressPrefixes. - string
nextHopIpAddress string No NextHop ip address.

VirtualHubRouteTableV2Properties object

Name Type Required Value
routes array No List of all routes. - VirtualHubRouteV2 object
attachedConnections array No List of all connections attached to this route table v2. - string

VirtualHubRouteV2 object

Name Type Required Value
destinationType string No The type of destinations.
destinations array No List of all destinations. - string
nextHopType string No The type of next hops.
nextHops array No NextHops ip address. - string

Quickstart templates

The following quickstart templates deploy this resource type.

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