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

Virtual Network Gateways - Get Advertised Routes

此操作检索虚拟网络网关向指定对等方播发的路由列表。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getAdvertisedRoutes?peer={peer}&api-version=2022-01-01

URI 参数

Name In Required Type Description
resourceGroupName
path True
  • string

资源组的名称。

subscriptionId
path True
  • string

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

virtualNetworkGatewayName
path True
  • string

虚拟网络网关的名称。

api-version
query True
  • string

客户端 API 版本。

peer
query True
  • string

对等方的 IP 地址。

响应

Name Type Description
200 OK

已学习的 BGP 路由列表。

202 Accepted

接受并且操作将以异步方式完成。

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

示例

GetVirtualNetworkGatewayAdvertisedRoutes

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/getAdvertisedRoutes?peer=test&api-version=2022-01-01

Sample Response

{}

定义

CloudError

服务的错误响应。

CloudErrorBody

服务的错误响应。

GatewayRoute

网关路由详细信息。

GatewayRouteListResult

虚拟网络网关路由列表。

CloudError

服务的错误响应。

Name Type Description
error

云错误正文。

CloudErrorBody

服务的错误响应。

Name Type Description
code
  • string

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

details

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

message
  • string

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

target
  • string

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

GatewayRoute

网关路由详细信息。

Name Type Description
asPath
  • string

路由的 AS 路径序列。

localAddress
  • string

网关的本地地址。

network
  • string

路由的网络前缀。

nextHop
  • string

路线的下一跃点。

origin
  • string

从中了解此路由的源。

sourcePeer
  • string

从中了解此路由的对等方。

weight
  • integer

路线的权重。

GatewayRouteListResult

虚拟网络网关路由列表。

Name Type Description
value

网关路由列表。