Microsoft.Network expressRouteGateways 2020-11-01

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

resource symbolicname 'Microsoft.Network/expressRouteGateways@2020-11-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    autoScaleConfiguration: {
      bounds: {
        max: int
        min: int
      }
    }
    virtualHub: {
      id: 'string'
    }
  }
}

Property values

expressRouteGateways

Name Description Value
type The resource type

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

For Bicep, set this value in the resource declaration.
'2020-11-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 ExpressRoute gateway resource properties. ExpressRouteGatewayProperties

ExpressRouteGatewayProperties

Name Description Value
autoScaleConfiguration Configuration for auto scaling. ExpressRouteGatewayPropertiesAutoScaleConfiguration
virtualHub Virtual Hub identifier. VirtualHubId (required)

ExpressRouteGatewayPropertiesAutoScaleConfiguration

Name Description Value
bounds Minimum and maximum number of scale units to deploy. ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds

ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds

Name Description Value
max Maximum number of scale units deployed for ExpressRoute gateway. int
min Minimum number of scale units deployed for ExpressRoute gateway. int

VirtualHubId

Name Description Value
id The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. string

Quickstart templates

The following quickstart templates deploy this resource type.

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