Microsoft.Network expressRouteGateways 2021-03-01

• Latest
• 2023-04-01
• 2023-02-01
• 2022-11-01
• 2022-09-01
• 2022-07-01
• 2022-05-01
• 2022-01-01
• 2021-08-01
• 2021-05-01
• 2021-03-01
• 2021-02-01
• 2020-11-01

Bicep resource definition

The expressRouteGateways resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

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

Resource format

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

resource symbolicname 'Microsoft.Network/expressRouteGateways@2021-03-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
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
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.	ExpressRouteGatewayPropertiesAutoScaleConfigurationB...

ExpressRouteGatewayPropertiesAutoScaleConfigurationB...

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 Routing Intent and Policies	This template provisions an Azure Virtual WAN with two hubs with Routing Intent and Policies feature enabled.
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.

ARM template resource definition

The expressRouteGateways resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

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

Resource format

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

{
  "type": "Microsoft.Network/expressRouteGateways",
  "apiVersion": "2021-03-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	'Microsoft.Network/expressRouteGateways'
apiVersion	The resource api version	'2021-03-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
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.	ExpressRouteGatewayPropertiesAutoScaleConfigurationB...

ExpressRouteGatewayPropertiesAutoScaleConfigurationB...

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 Routing Intent and Policies	This template provisions an Azure Virtual WAN with two hubs with Routing Intent and Policies feature enabled.
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.

Terraform (AzAPI provider) resource definition

The expressRouteGateways resource type can be deployed with operations that target:

• Resource groups

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

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/expressRouteGateways@2021-03-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      autoScaleConfiguration = {
        bounds = {
          max = int
          min = int
        }
      }
      virtualHub = {
        id = "string"
      }
    }
  })
}

Property values

expressRouteGateways

Name	Description	Value
type	The resource type	"Microsoft.Network/expressRouteGateways@2021-03-01"
name	The resource name	string (required)
location	Resource location.	string
parent_id	To deploy to a resource group, use the ID of that resource group.	string (required)
tags	Resource tags.	Dictionary of tag names and values.
properties	Properties of the express route gateway.	ExpressRouteGatewayProperties

ExpressRouteGatewayProperties

Name	Description	Value
autoScaleConfiguration	Configuration for auto scaling.	ExpressRouteGatewayPropertiesAutoScaleConfiguration
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.	ExpressRouteGatewayPropertiesAutoScaleConfigurationB...

ExpressRouteGatewayPropertiesAutoScaleConfigurationB...

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