你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Express Route Gateways - List By Subscription

Lists给定订阅下的 ExpressRoute 网关。

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

URI 参数

名称 必需 类型 说明
subscriptionId
path True

string

可以唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True

string

客户端 API 版本。

响应

名称 类型 说明
200 OK

ExpressRouteGatewayList

请求成功。

Other Status Codes

CloudError

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

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

Scopes

名称 说明
user_impersonation 模拟用户帐户

示例

ExpressRouteGatewayListBySubscription

Sample Request

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

Sample Response

{
  "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
            }
          }
        ]
      }
    }
  ]
}

定义

名称 说明
AutoScaleConfiguration

自动缩放的配置。

Bounds

要部署的最小和最大缩放单元数。

CloudError

来自服务的错误响应。

CloudErrorBody

来自服务的错误响应。

ExpressRouteCircuitPeeringId

ExpressRoute 线路对等互连标识符。

ExpressRouteConnection

ExpressRouteConnection 资源。

ExpressRouteGateway

ExpressRoute 网关资源。

ExpressRouteGatewayList

ExpressRoute 网关列表。

ProvisioningState

当前预配状态。

VirtualHubId

虚拟中心标识符。

AutoScaleConfiguration

自动缩放的配置。

名称 类型 说明
bounds

Bounds

要部署的最小和最大缩放单元数。

Bounds

要部署的最小和最大缩放单元数。

名称 类型 说明
max

integer

为 ExpressRoute 网关部署的最大缩放单元数。

min

integer

为 ExpressRoute 网关部署的最小缩放单元数。

CloudError

来自服务的错误响应。

名称 类型 说明
error

CloudErrorBody

云错误正文。

CloudErrorBody

来自服务的错误响应。

名称 类型 说明
code

string

错误的标识符。 代码是固定的,旨在以编程方式使用。

details

CloudErrorBody[]

有关错误的其他详细信息的列表。

message

string

描述错误的消息,该消息适用于在用户界面中显示。

target

string

特定错误的目标。 例如,属性的名称出错。

ExpressRouteCircuitPeeringId

ExpressRoute 线路对等互连标识符。

名称 类型 说明
id

string

ExpressRoute 线路对等互连的 ID。

ExpressRouteConnection

ExpressRouteConnection 资源。

名称 类型 说明
id

string

资源 ID。

name

string

资源的名称。

properties.authorizationKey

string

用于建立连接的授权密钥。

properties.enableInternetSecurity

boolean

启用 Internet 安全性。

properties.expressRouteCircuitPeering

ExpressRouteCircuitPeeringId

ExpressRoute 线路对等互连。

properties.provisioningState

ProvisioningState

快速路由连接资源的预配状态。

properties.routingWeight

integer

与连接关联的路由权重。

ExpressRouteGateway

ExpressRoute 网关资源。

名称 类型 说明
etag

string

一个唯一的只读字符串,每当资源更新时都会更改。

id

string

资源 ID。

location

string

资源位置。

name

string

资源名称。

properties.autoScaleConfiguration

AutoScaleConfiguration

自动缩放的配置。

properties.expressRouteConnections

ExpressRouteConnection[]

到 ExpressRoute 网关的 ExpressRoute 连接列表。

properties.provisioningState

ProvisioningState

快速路由网关资源的预配状态。

properties.virtualHub

VirtualHubId

部署或将部署 ExpressRoute 网关的虚拟中心。

tags

object

资源标记。

type

string

资源类型。

ExpressRouteGatewayList

ExpressRoute 网关列表。

名称 类型 说明
value

ExpressRouteGateway[]

ExpressRoute 网关列表。

ProvisioningState

当前预配状态。

名称 类型 说明
Deleting

string

Failed

string

Succeeded

string

Updating

string

VirtualHubId

虚拟中心标识符。

名称 类型 说明
id

string

部署或将部署 ExpressRoute 网关的虚拟中心的资源 URI。 虚拟中心资源和 ExpressRoute 网关资源驻留在同一订阅中。