virtual_hub_bgp_connection

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

Overview

Name	virtual_hub_bgp_connection
Type	Resource
Id	azure.network.virtual_hub_bgp_connection

Fields

The following fields are returned by SELECT queries:

get

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
get	select	resource_group_name, virtual_hub_name, connection_name, subscription_id		Retrieves the details of a Virtual Hub Bgp Connection.
create_or_update	insert	resource_group_name, virtual_hub_name, connection_name, subscription_id		Creates a VirtualHubBgpConnection resource if it doesn't exist else updates the existing VirtualHubBgpConnection.
create_or_update	replace	resource_group_name, virtual_hub_name, connection_name, subscription_id		Creates a VirtualHubBgpConnection resource if it doesn't exist else updates the existing VirtualHubBgpConnection.
delete	delete	resource_group_name, virtual_hub_name, connection_name, subscription_id		Deletes a VirtualHubBgpConnection.

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 connection. 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

get

Retrieves the details of a Virtual Hub Bgp Connection.

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

INSERT examples

create_or_update

Creates a VirtualHubBgpConnection resource if it doesn't exist else updates the existing VirtualHubBgpConnection.

INSERT INTO azure.network.virtual_hub_bgp_connection (
id,
name,
properties,
resource_group_name,
virtual_hub_name,
connection_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ name }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ virtual_hub_name }}',
'{{ connection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_hub_bgp_connection
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the virtual_hub_bgp_connection resource.
  - name: virtual_hub_name
    value: "{{ virtual_hub_name }}"
    description: Required parameter for the virtual_hub_bgp_connection resource.
  - name: connection_name
    value: "{{ connection_name }}"
    description: Required parameter for the virtual_hub_bgp_connection resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the virtual_hub_bgp_connection resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource.
  - name: properties
    description: |
      The properties of the Bgp connections.
    value:
      peerAsn: {{ peerAsn }}
      peerIp: "{{ peerIp }}"
      hubVirtualNetworkConnection:
        id: "{{ id }}"
      provisioningState: "{{ provisioningState }}"
      connectionState: "{{ connectionState }}"
      routingConfiguration:
        associatedRouteTable:
          id: "{{ id }}"
        propagatedRouteTables:
          labels:
            - "{{ labels }}"
          ids:
            - id: "{{ id }}"
        vnetRoutes:
          staticRoutesConfig:
            propagateStaticRoutes: {{ propagateStaticRoutes }}
            vnetLocalRouteOverrideCriteria: "{{ vnetLocalRouteOverrideCriteria }}"
          staticRoutes:
            - name: "{{ name }}"
              addressPrefixes: "{{ addressPrefixes }}"
              nextHopIpAddress: "{{ nextHopIpAddress }}"
          bgpConnections:
            - id: "{{ id }}"
        inboundRouteMap:
          id: "{{ id }}"
        outboundRouteMap:
          id: "{{ id }}"

REPLACE examples

create_or_update

Creates a VirtualHubBgpConnection resource if it doesn't exist else updates the existing VirtualHubBgpConnection.

REPLACE azure.network.virtual_hub_bgp_connection
SET 
id = '{{ id }}',
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND virtual_hub_name = '{{ virtual_hub_name }}' --required
AND connection_name = '{{ connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
type;

DELETE examples

delete

Deletes a VirtualHubBgpConnection.

DELETE FROM azure.network.virtual_hub_bgp_connection
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND virtual_hub_name = '{{ virtual_hub_name }}' --required
AND connection_name = '{{ connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;