virtual_network_gateways_bgp_peer_status

Creates, updates, deletes, gets or lists a virtual_network_gateways_bgp_peer_status resource.

Overview

Name	virtual_network_gateways_bgp_peer_status
Type	Resource
Id	azure.network.virtual_network_gateways_bgp_peer_status

Fields

Name	Datatype	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	string	The BGP peer state.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, subscriptionId, virtualNetworkGatewayName	The GetBgpPeerStatus operation retrieves the status of all BGP peers.

SELECT examples

The GetBgpPeerStatus operation retrieves the status of all BGP peers.

SELECT
asn,
connectedDuration,
localAddress,
messagesReceived,
messagesSent,
neighbor,
routesReceived,
state
FROM azure.network.virtual_network_gateways_bgp_peer_status
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND virtualNetworkGatewayName = '{{ virtualNetworkGatewayName }}';