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

Express Route Gateways - List By Subscription

列出给定订阅下的 ExpressRoute 网关。

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

URI 参数

Name In Required Type Description
subscriptionId
path True
  • string

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

api-version
query True
  • string

客户端 API 版本。

响应

Name Type Description
200 OK

请求成功。

Other Status Codes

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

安全性

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 模拟用户帐户

示例

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

自动缩放的配置。

Name Type Description
bounds

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

Bounds

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

Name Type Description
max
  • integer

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

min
  • integer

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

CloudError

服务的错误响应。

Name Type Description
error

云错误正文。

CloudErrorBody

服务的错误响应。

Name Type Description
code
  • string

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

details

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

message
  • string

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

target
  • string

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

ExpressRouteCircuitPeeringId

ExpressRoute 线路对等互连标识符。

Name Type Description
id
  • string

ExpressRoute 线路对等互连的 ID。

ExpressRouteConnection

ExpressRouteConnection 资源。

Name Type Description
id
  • string

资源 ID。

name
  • string

资源的名称。

properties.authorizationKey
  • string

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

properties.enableInternetSecurity
  • boolean

启用 Internet 安全性。

properties.expressRouteCircuitPeering

ExpressRoute 线路对等互连。

properties.provisioningState

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

properties.routingWeight
  • integer

与连接关联的路由权重。

ExpressRouteGateway

ExpressRoute 网关资源。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

location
  • string

资源位置。

name
  • string

资源名称。

properties.autoScaleConfiguration

自动缩放的配置。

properties.expressRouteConnections

与 ExpressRoute 网关的 ExpressRoute 连接列表。

properties.provisioningState

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

properties.virtualHub

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

tags
  • object

资源标记。

type
  • string

资源类型。

ExpressRouteGatewayList

ExpressRoute 网关列表。

Name Type Description
value

ExpressRoute 网关列表。

ProvisioningState

当前预配状态。

Name Type Description
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

VirtualHubId

虚拟中心标识符。

Name Type Description
id
  • string

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