Microsoft.Network expressRouteGateways 2020-05-01

• Latest
• 2024-07-01
• 2024-05-01
• 2024-03-01
• 2024-01-01
• 2023-11-01
• 2023-09-01
• 2023-06-01
• 2023-05-01
• 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
• 2020-08-01
• 2020-07-01
• 2020-06-01
• 2020-05-01
• 2020-04-01
• 2020-03-01
• 2019-12-01
• 2019-11-01
• 2019-09-01
• 2019-08-01
• 2019-07-01
• 2019-06-01
• 2019-04-01
• 2019-02-01
• 2018-12-01
• 2018-11-01
• 2018-10-01
• 2018-08-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@2020-05-01' = {
  location: 'string'
  name: 'string'
  properties: {
    autoScaleConfiguration: {
      bounds: {
        max: int
        min: int
      }
    }
    virtualHub: {
      id: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.Network/expressRouteGateways

Name	Description	Value
location	Resource location.	string
name	The resource name	string (required)
properties	Properties of the express route gateway.	ExpressRouteGatewayProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

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

ResourceTags

Name	Description	Value

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

Usage Examples

Azure Verified Modules

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

Module	Description
Express Route Gateway	AVM Resource Module for Express Route Gateway

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": "2020-05-01",
  "name": "string",
  "location": "string",
  "properties": {
    "autoScaleConfiguration": {
      "bounds": {
        "max": "int",
        "min": "int"
      }
    },
    "virtualHub": {
      "id": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Network/expressRouteGateways

Name	Description	Value
apiVersion	The api version	'2020-05-01'
location	Resource location.	string
name	The resource name	string (required)
properties	Properties of the express route gateway.	ExpressRouteGatewayProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.Network/expressRouteGateways'

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

ResourceTags

Name	Description	Value

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

Usage Examples

Azure Quickstart Templates

The following Azure 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.

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@2020-05-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      autoScaleConfiguration = {
        bounds = {
          max = int
          min = int
        }
      }
      virtualHub = {
        id = "string"
      }
    }
  }
}

Property Values

Microsoft.Network/expressRouteGateways

Name	Description	Value
location	Resource location.	string
name	The resource name	string (required)
properties	Properties of the express route gateway.	ExpressRouteGatewayProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.Network/expressRouteGateways@2020-05-01"

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

ResourceTags

Name	Description	Value

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