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

The following fields are returned by SELECT queries:

get

List of BGP peer statuses.

Name	Datatype	Description
asn	integer (int64)	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	string	The BGP peer state.

Methods

The following methods are available for this resource:

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

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
virtualNetworkGatewayName	string	The name of the virtual network gateway.
peer	string	The IP address of the peer to retrieve the status of.

SELECT examples

get

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 }}' -- required
AND virtualNetworkGatewayName = '{{ virtualNetworkGatewayName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND peer = '{{ peer }}'
;