Express Route Gateways - List By Subscription

Reference

Service:: ExpressRoute

API Version:: 2019-12-01

Lists ExpressRoute gateways under a given subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteGateways?api-version=2019-12-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client API version.

Responses

Name	Type	Description
200 OK	ExpressRouteGatewayList	Request successful.
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ExpressRouteGatewayListBySubscription

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/expressRouteGateways?api-version=2019-12-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "name": "expressRouteGatewayName",
      "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName",
      "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
      "location": "westus",
      "type": "Microsoft.Network/expressRouteGateways",
      "properties": {
        "provisioningState": "Succeeded",
        "virtualHub": {
          "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName"
        },
        "autoScaleConfiguration": {
          "bounds": {
            "min": 2
          }
        },
        "expressRouteConnections": [
          {
            "name": "connectionName",
            "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName",
            "properties": {
              "provisioningState": "Provisioned",
              "expressRouteCircuitPeering": {
                "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering"
              },
              "authorizationKey": "f28e9c99-78d8-4248-a855-c54cf6beb99d",
              "routingWeight": 1,
              "enableInternetSecurity": false
            }
          }
        ]
      }
    }
  ]
}

Definitions

Name	Description
AutoScaleConfiguration	Configuration for auto scaling.
Bounds	Minimum and maximum number of scale units to deploy.
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
ExpressRouteCircuitPeeringId	ExpressRoute circuit peering identifier.
ExpressRouteConnection	ExpressRouteConnection resource.
ExpressRouteGateway	ExpressRoute gateway resource.
ExpressRouteGatewayList	List of ExpressRoute gateways.
ProvisioningState	The current provisioning state.
VirtualHubId	Virtual Hub identifier.

AutoScaleConfiguration

Configuration for auto scaling.

Name	Type	Description
bounds	Bounds	Minimum and maximum number of scale units to deploy.

Bounds

Minimum and maximum number of scale units to deploy.

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

CloudError

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

An error response from the service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

ExpressRouteCircuitPeeringId

ExpressRoute circuit peering identifier.

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

ExpressRouteConnection

ExpressRouteConnection resource.

Name	Type	Description
id	string	Resource ID.
name	string	The name of the resource.
properties.authorizationKey	string	Authorization key to establish the connection.
properties.enableInternetSecurity	boolean	Enable internet security.
properties.expressRouteCircuitPeering	ExpressRouteCircuitPeeringId	The ExpressRoute circuit peering.
properties.provisioningState	ProvisioningState	The provisioning state of the express route connection resource.
properties.routingWeight	integer	The routing weight associated to the connection.

ExpressRouteGateway

ExpressRoute gateway resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
location	string	Resource location.
name	string	Resource name.
properties.autoScaleConfiguration	AutoScaleConfiguration	Configuration for auto scaling.
properties.expressRouteConnections	ExpressRouteConnection[]	List of ExpressRoute connections to the ExpressRoute gateway.
properties.provisioningState	ProvisioningState	The provisioning state of the express route gateway resource.
properties.virtualHub	VirtualHubId	The Virtual Hub where the ExpressRoute gateway is or will be deployed.
tags	object	Resource tags.
type	string	Resource type.

ExpressRouteGatewayList

List of ExpressRoute gateways.

Name	Type	Description
value	ExpressRouteGateway[]	List of ExpressRoute gateways.

ProvisioningState

The current provisioning state.

Name	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

VirtualHubId

Virtual Hub identifier.

Name	Type	Description
id	string	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.