virtual_network_gateways_advertised_routes

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

Overview

Name	virtual_network_gateways_advertised_routes
Type	Resource
Id	azure.network.virtual_network_gateways_advertised_routes

Fields

The following fields are returned by SELECT queries:

get

List of learned BGP routes.

Name	Datatype	Description
asPath	string	The route's AS path sequence.
localAddress	string	The gateway's local address.
network	string	The route's network prefix.
nextHop	string	The route's next hop.
origin	string	The source this route was learned from.
sourcePeer	string	The peer this route was learned from.
weight	integer (int32)	The route's weight.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, virtualNetworkGatewayName, peer, subscriptionId		This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.

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
peer	string	The IP address of the peer.
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.

SELECT examples

get

This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.

SELECT
asPath,
localAddress,
network,
nextHop,
origin,
sourcePeer,
weight
FROM azure.network.virtual_network_gateways_advertised_routes
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualNetworkGatewayName = '{{ virtualNetworkGatewayName }}' -- required
AND peer = '{{ peer }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;