Virtual Network Gateways - Get Bgp Peer Status

Reference

Service:: Network Gateway

API Version:: 2024-05-01

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=2024-05-01

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	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.
virtualNetworkGatewayName	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	BgpPeerStatusListResult	List of BGP peer statuses.
202 Accepted		Accepted and the operation will complete asynchronously.
Other Status Codes	CloudError	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

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/getBgpPeerStatus?api-version=2024-05-01

Sample response

Status code:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-05-01

Status code:: 200

{}

Definitions

Name	Description
BgpPeerState	The BGP peer state.
BgpPeerStatus	BGP peer status details.
BgpPeerStatusListResult	Response for list BGP peer status API service call.
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.

BgpPeerState

The BGP peer state.

Name	Type	Description
Connected	string
Connecting	string
Idle	string
Stopped	string
Unknown	string

BgpPeerStatus

BGP peer status details.

Name	Type	Description
asn	integer	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	The number of BGP messages received.
messagesSent	integer	The number of BGP messages sent.
neighbor	string	The remote BGP peer.
routesReceived	integer	The number of routes learned from this peer.
state	BgpPeerState	The BGP peer state.

BgpPeerStatusListResult

Response for list BGP peer status API service call.

Name	Type	Description
value	BgpPeerStatus[]	List of BGP peers.

CloudError

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody