Virtual Network Gateways - Get Bgp Peer Status
The GetBgpPeerStatus operation retrieves the status of all BGP peers.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getBgpPeerStatus?api-version=2025-03-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getBgpPeerStatus?peer={peer}&api-version=2025-03-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 |
string |
The IP address of the peer to retrieve the status of. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
List of BGP peer statuses. |
|
| 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
GetVirtualNetworkGatewayBGPPeerStatus
Sample request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/getBgpPeerStatus?api-version=2025-03-01
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=2025-03-01
{}
Definitions
| Name | Description |
|---|---|
|
Bgp |
The BGP peer state. |
|
Bgp |
BGP peer status details. |
|
Bgp |
Response for list BGP peer status API service call. |
|
Cloud |
An error response from the service. |
|
Cloud |
An error response from the service. |
BgpPeerState
The BGP peer state.
| Value | Description |
|---|---|
| Unknown | |
| Stopped | |
| Idle | |
| Connecting | |
| Connected |
BgpPeerStatus
BGP peer status details.
| Name | Type | Description |
|---|---|---|
| asn |
integer (int64) minimum: 0maximum: 4294967295 |
The autonomous system number of the remote BGP peer. |
| connectedDuration |
string |
For how long the peering has been up. |
| localAddress |
string |
The virtual network gateway's local address. |
| messagesReceived |
integer (int64) |
The number of BGP messages received. |
| messagesSent |
integer (int64) |
The number of BGP messages sent. |
| neighbor |
string |
The remote BGP peer. |
| routesReceived |
integer (int64) |
The number of routes learned from this peer. |
| state |
The BGP peer state. |
BgpPeerStatusListResult
Response for list BGP peer status API service call.
| Name | Type | Description |
|---|---|---|
| value |
List of BGP peers. |
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. |