Microsoft.Network expressRouteGateways

• Latest
• 2021-08-01
• 2021-05-01
• 2021-03-01
• 2021-02-01
• 2020-11-01

The expressRouteGateways resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

For a list of changed properties in each API version, see change log.

Template format

To create a Microsoft.Network/expressRouteGateways resource, add the following Bicep or JSON to your template.

Bicep

resource symbolicname 'Microsoft.Network/expressRouteGateways@2021-08-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    autoScaleConfiguration: {
      bounds: {
        max: int
        min: int
      }
    }
    expressRouteConnections: [
      {
        id: 'string'
        name: 'string'
        properties: {
          authorizationKey: 'string'
          enableInternetSecurity: bool
          expressRouteCircuitPeering: {
            id: 'string'
          }
          expressRouteGatewayBypass: bool
          routingConfiguration: {
            associatedRouteTable: {
              id: 'string'
            }
            propagatedRouteTables: {
              ids: [
                {
                  id: 'string'
                }
              ]
              labels: [
                'string'
              ]
            }
            vnetRoutes: {
              staticRoutes: [
                {
                  addressPrefixes: [
                    'string'
                  ]
                  name: 'string'
                  nextHopIpAddress: 'string'
                }
              ]
            }
          }
          routingWeight: int
        }
      }
    ]
    virtualHub: {
      id: 'string'
    }
  }
}

JSON

{
  "type": "Microsoft.Network/expressRouteGateways",
  "apiVersion": "2021-08-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "autoScaleConfiguration": {
      "bounds": {
        "max": "int",
        "min": "int"
      }
    },
    "expressRouteConnections": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "authorizationKey": "string",
          "enableInternetSecurity": "bool",
          "expressRouteCircuitPeering": {
            "id": "string"
          },
          "expressRouteGatewayBypass": "bool",
          "routingConfiguration": {
            "associatedRouteTable": {
              "id": "string"
            },
            "propagatedRouteTables": {
              "ids": [
                {
                  "id": "string"
                }
              ],
              "labels": [ "string" ]
            },
            "vnetRoutes": {
              "staticRoutes": [
                {
                  "addressPrefixes": [ "string" ],
                  "name": "string",
                  "nextHopIpAddress": "string"
                }
              ]
            }
          },
          "routingWeight": "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.	'2021-08-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	Properties of the express route gateway.	ExpressRouteGatewayProperties

ExpressRouteGatewayProperties

Name	Description	Value
autoScaleConfiguration	Configuration for auto scaling.	ExpressRouteGatewayPropertiesAutoScaleConfiguration
expressRouteConnections	List of ExpressRoute connections to the ExpressRoute gateway.	ExpressRouteConnection[]
virtualHub	The Virtual Hub where the ExpressRoute gateway is or will be deployed.	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

ExpressRouteConnection

Name	Description	Value
id	Resource ID.	string
name	The name of the resource.	string (required)
properties	Properties of the express route connection.	ExpressRouteConnectionProperties

ExpressRouteConnectionProperties

Name	Description	Value
authorizationKey	Authorization key to establish the connection.	string
enableInternetSecurity	Enable internet security.	bool
expressRouteCircuitPeering	The ExpressRoute circuit peering.	ExpressRouteCircuitPeeringId (required)
expressRouteGatewayBypass	Enable FastPath to vWan Firewall hub.	bool
routingConfiguration	The Routing Configuration indicating the associated and propagated route tables on this connection.	RoutingConfiguration
routingWeight	The routing weight associated to the connection.	int

ExpressRouteCircuitPeeringId

Name	Description	Value
id	The ID of the ExpressRoute circuit peering.	string

RoutingConfiguration

Name	Description	Value
associatedRouteTable	The resource id RouteTable associated with this RoutingConfiguration.	SubResource
propagatedRouteTables	The list of RouteTables to advertise the routes to.	PropagatedRouteTable
vnetRoutes	List of routes that control routing from VirtualHub into a virtual network connection.	VnetRoute

SubResource

Name	Description	Value
id	Resource ID.	string

PropagatedRouteTable

Name	Description	Value
ids	The list of resource ids of all the RouteTables.	SubResource[]
labels	The list of labels.	string[]

VnetRoute

Name	Description	Value
staticRoutes	List of all Static Routes.	StaticRoute[]

StaticRoute

Name	Description	Value
addressPrefixes	List of all address prefixes.	string[]
name	The name of the StaticRoute that is unique within a VnetRoute.	string
nextHopIpAddress	The ip address of the next hop.	string

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