Microsoft.Network expressRouteGateways template reference

  • 2 minutes to read

Template format

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

{
  "name": "string",
  "type": "Microsoft.Network/expressRouteGateways",
  "apiVersion": "2019-08-01",
  "location": "string",
  "tags": {},
  "properties": {
    "autoScaleConfiguration": {
      "bounds": {
        "min": "integer",
        "max": "integer"
      }
    },
    "virtualHub": {
      "id": "string"
    }
  },
  "resources": []
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Network/expressRouteGateways object

Name Type Required Value
name string Yes The name of the ExpressRoute gateway.
type enum Yes Microsoft.Network/expressRouteGateways
apiVersion enum Yes 2019-08-01
location string Yes Resource location.
tags object No Resource tags.
properties object Yes Properties of the express route gateway. - ExpressRouteGatewayProperties object
resources array No expressRouteConnections

ExpressRouteGatewayProperties object

Name Type Required Value
autoScaleConfiguration object No Configuration for auto scaling. - ExpressRouteGatewayPropertiesAutoScaleConfiguration object
virtualHub object Yes The Virtual Hub where the ExpressRoute gateway is or will be deployed. - VirtualHubId object

ExpressRouteGatewayPropertiesAutoScaleConfiguration object

Name Type Required Value
bounds object No Minimum and maximum number of scale units to deploy. - ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds object

VirtualHubId object

Name Type Required Value
id string No 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.

ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds object

Name Type Required Value
min integer No Minimum number of scale units deployed for ExpressRoute gateway.
max integer No Maximum number of scale units deployed for ExpressRoute gateway.