Virtual Network Gateways - Get Advertised Routes
This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getAdvertisedRoutes?peer={peer}&api-version=2023-05-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the resource group. |
subscription
|
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. |
virtual
|
path | True |
string |
The name of the virtual network gateway. |
api-version
|
query | True |
string |
Client API version. |
peer
|
query | True |
string |
The IP address of the peer. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
List of learned BGP routes. |
|
202 Accepted |
Accepted and the operation will complete asynchronously. |
|
Other Status Codes |
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
GetVirtualNetworkGatewayAdvertisedRoutes
Sample Request
Sample Response
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2023-05-01
{}
Definitions
Name | Description |
---|---|
Cloud |
An error response from the service. |
Cloud |
An error response from the service. |
Gateway |
Gateway routing details. |
Gateway |
List of virtual network gateway routes. |
CloudError
An error response from the service.
Name | Type | Description |
---|---|---|
error |
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 |
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. |
GatewayRoute
Gateway routing details.
Name | Type | Description |
---|---|---|
asPath |
string |
The route's AS path sequence. |
localAddress |
string |
The gateway's local address. |
network |
string |
The route's network prefix. |
nextHop |
string |
The route's next hop. |
origin |
string |
The source this route was learned from. |
sourcePeer |
string |
The peer this route was learned from. |
weight |
integer |
The route's weight. |
GatewayRouteListResult
List of virtual network gateway routes.
Name | Type | Description |
---|---|---|
value |
List of gateway routes. |