Microsoft.Network virtualHubs 2023-09-01

Bicep resource definition

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

resource symbolicname 'Microsoft.Network/virtualHubs@2023-09-01' = {
  scope: resourceSymbolicName or scope
  ___location: 'string'
  name: 'string'
  properties: {
    addressPrefix: 'string'
    allowBranchToBranchTraffic: bool
    azureFirewall: {
      id: 'string'
    }
    expressRouteGateway: {
      id: 'string'
    }
    hubRoutingPreference: 'string'
    p2SVpnGateway: {
      id: 'string'
    }
    preferredRoutingGateway: '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
    virtualRouterAutoScaleConfiguration: {
      minCapacity: int
    }
    virtualRouterIps: [
      'string'
    ]
    virtualWan: {
      id: 'string'
    }
    vpnGateway: {
      id: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.Network/virtualHubs

ResourceTags

SubResource

VirtualHubProperties

VirtualHubRoute

VirtualHubRouteTable

VirtualHubRouteTableV2

VirtualHubRouteTableV2Properties

VirtualHubRouteV2

VirtualRouterAutoScaleConfiguration

Usage Examples

Azure Verified Modules

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

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

ARM template resource definition

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

{
  "type": "Microsoft.Network/virtualHubs",
  "apiVersion": "2023-09-01",
  "name": "string",
  "___location": "string",
  "properties": {
    "addressPrefix": "string",
    "allowBranchToBranchTraffic": "bool",
    "azureFirewall": {
      "id": "string"
    },
    "expressRouteGateway": {
      "id": "string"
    },
    "hubRoutingPreference": "string",
    "p2SVpnGateway": {
      "id": "string"
    },
    "preferredRoutingGateway": "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",
    "virtualRouterAutoScaleConfiguration": {
      "minCapacity": "int"
    },
    "virtualRouterIps": [ "string" ],
    "virtualWan": {
      "id": "string"
    },
    "vpnGateway": {
      "id": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Network/virtualHubs

ResourceTags

SubResource

VirtualHubProperties

VirtualHubRoute

VirtualHubRouteTable

VirtualHubRouteTableV2

VirtualHubRouteTableV2Properties

VirtualHubRouteV2

VirtualRouterAutoScaleConfiguration

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template	Description
Azure Route Server in BGP peering with Quagga	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
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.
Create a Route Server in a New Subnet	This template deploys a Route Server into a subnet named RouteServerSubnet.
Creates Virtual WAN resources	This template allows you to create virtual WAN resources including Virtual WAN, Virtual Hub, VPN Gateway, VPN Site and a VPN Connecton.
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 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 resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/virtualHubs@2023-09-01"
  name = "string"
  parent_id = "string"
  ___location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      addressPrefix = "string"
      allowBranchToBranchTraffic = bool
      azureFirewall = {
        id = "string"
      }
      expressRouteGateway = {
        id = "string"
      }
      hubRoutingPreference = "string"
      p2SVpnGateway = {
        id = "string"
      }
      preferredRoutingGateway = "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
      virtualRouterAutoScaleConfiguration = {
        minCapacity = int
      }
      virtualRouterIps = [
        "string"
      ]
      virtualWan = {
        id = "string"
      }
      vpnGateway = {
        id = "string"
      }
    }
  }
}

Property Values

Microsoft.Network/virtualHubs

ResourceTags

SubResource

VirtualHubProperties

VirtualHubRoute

VirtualHubRouteTable

VirtualHubRouteTableV2

VirtualHubRouteTableV2Properties

VirtualHubRouteV2

VirtualRouterAutoScaleConfiguration

Usage Examples

Terraform Samples

A basic example of deploying Virtual Hub within a Virtual WAN.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "___location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  ___location = var.___location
}

resource "azapi_resource" "virtualWan" {
  type      = "Microsoft.Network/virtualWans@2022-07-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  ___location  = var.___location
  body = {
    properties = {
      allowBranchToBranchTraffic     = true
      disableVpnEncryption           = false
      office365LocalBreakoutCategory = "None"
      type                           = "Standard"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "virtualHub" {
  type      = "Microsoft.Network/virtualHubs@2022-07-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  ___location  = var.___location
  body = {
    properties = {
      addressPrefix        = "10.0.0.0/24"
      hubRoutingPreference = "ExpressRoute"
      virtualRouterAutoScaleConfiguration = {
        minCapacity = 2
      }
      virtualWan = {
        id = azapi_resource.virtualWan.id
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}