Express Route Circuits - List Routes Table Summary
Gets the currently advertised routes table summary associated with the express route circuit in a resource group.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/routeTablesSummary/{devicePath}?api-version=2023-09-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
circuit
|
path | True |
string |
The name of the express route circuit. |
device
|
path | True |
string |
The path of the device. |
peering
|
path | True |
string |
The name of the peering. |
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. |
api-version
|
query | True |
string |
Client API version. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Request successful. The operation returns the resulting ExpressRouteCircuitsRoutesTableSummary resource. |
|
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
List Route Table Summary
Sample Request
Sample Response
{
"value": [
{
"neighbor": "100.65.171.1",
"v": 4,
"as": 9583,
"upDown": "never",
"statePfxRcd": "Idle"
}
]
}
Location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2023-09-01
Definitions
Name | Description |
---|---|
Cloud |
An error response from the service. |
Cloud |
An error response from the service. |
Express |
The routes table associated with the ExpressRouteCircuit. |
Express |
Response for ListRoutesTable associated with the Express Route Circuits API. |
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. |
ExpressRouteCircuitRoutesTableSummary
The routes table associated with the ExpressRouteCircuit.
Name | Type | Description |
---|---|---|
as |
integer |
Autonomous system number. |
neighbor |
string |
IP address of the neighbor. |
statePfxRcd |
string |
Current state of the BGP session, and the number of prefixes that have been received from a neighbor or peer group. |
upDown |
string |
The length of time that the BGP session has been in the Established state, or the current status if not in the Established state. |
v |
integer |
BGP version number spoken to the neighbor. |
ExpressRouteCircuitsRoutesTableSummaryListResult
Response for ListRoutesTable associated with the Express Route Circuits API.
Name | Type | Description |
---|---|---|
nextLink |
string |
The URL to get the next set of results. |
value |
A list of the routes table. |