virtual_hub_bgp_connections

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

Overview

Name	virtual_hub_bgp_connections
Type	Resource
Id	azure.network.virtual_hub_bgp_connections

Fields

The following fields are returned by SELECT queries:

list_learned_routes

Name	Datatype	Description
asPath	string	The route's AS path sequence.
localAddress	string	The peer'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	The route's weight.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
connectionState	string	The current state of the VirtualHub to Peer. Known values are: "Unknown", "Connecting", "Connected", and "NotConnected". (Unknown, Connecting, Connected, NotConnected)
etag	string	A unique read-only string that changes whenever the resource is updated.
hubVirtualNetworkConnection	object	Reference to another subresource.
peerAsn	integer	Peer ASN.
peerIp	string	Peer IP.
provisioningState	string	The provisioning state of the resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
routingConfiguration	object	The routing configuration indicating the associated and propagated route tables for this connection.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_learned_routes	select	resource_group_name, hub_name, connection_name, subscription_id		Retrieves a list of routes the virtual hub bgp connection has learned.
list	select	resource_group_name, virtual_hub_name, subscription_id		Retrieves the details of all VirtualHubBgpConnections.
list_advertised_routes	exec	resource_group_name, hub_name, connection_name, subscription_id		Retrieves a list of routes the virtual hub bgp connection 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
connection_name	string	The name of the bgp connection. Required.
hub_name	string	The name of the virtual hub. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
virtual_hub_name	string	The name of the VirtualHub. Required.

SELECT examples

list_learned_routes

Retrieves a list of routes the virtual hub bgp connection has learned.

SELECT
asPath,
localAddress,
network,
nextHop,
origin,
sourcePeer,
weight
FROM azure.network.virtual_hub_bgp_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND hub_name = '{{ hub_name }}' -- required
AND connection_name = '{{ connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Retrieves the details of all VirtualHubBgpConnections.

SELECT
id,
name,
connectionState,
etag,
hubVirtualNetworkConnection,
peerAsn,
peerIp,
provisioningState,
routingConfiguration,
type
FROM azure.network.virtual_hub_bgp_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_hub_name = '{{ virtual_hub_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

list_advertised_routes

Retrieves a list of routes the virtual hub bgp connection is advertising to the specified peer.

EXEC azure.network.virtual_hub_bgp_connections.list_advertised_routes 
@resource_group_name='{{ resource_group_name }}' --required, 
@hub_name='{{ hub_name }}' --required, 
@connection_name='{{ connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;