Microsoft.Network expressRouteGateways 2018-10-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@2018-10-01' = {
  location: 'string'
  name: 'string'
  properties: {
    autoScaleConfiguration: {
      bounds: {
        max: int
        min: int
      }
    }
    virtualHub: {
      id: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

ExpressRouteGatewayProperties

ExpressRouteGatewayPropertiesAutoScaleConfiguration

ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds

Microsoft.Network/expressRouteGateways

ResourceTags

VirtualHubId

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

Property values

ExpressRouteGatewayProperties

ExpressRouteGatewayPropertiesAutoScaleConfiguration

ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds

Microsoft.Network/expressRouteGateways

ResourceTags

VirtualHubId

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.

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@2018-10-01"
  name = "string"
  location = "string"
  body = jsonencode({
    properties = {
      autoScaleConfiguration = {
        bounds = {
          max = int
          min = int
        }
      }
      virtualHub = {
        id = "string"
      }
    }
  })
  tags = {
    {customized property} = "string"
  }
}

Property values

ExpressRouteGatewayProperties

ExpressRouteGatewayPropertiesAutoScaleConfiguration

ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds

Microsoft.Network/expressRouteGateways

ResourceTags

VirtualHubId