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

vw_virtual_hub_bgp_connections

Name	Datatype	Description
id	text	Resource ID.
name	text	Name of the connection.
connectionName	text	field from the properties object
connection_state	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
hub_virtual_network_connection	text	field from the properties object
peer_asn	text	field from the properties object
peer_ip	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
type	text	Connection type.
virtualHubName	text	field from the properties object

virtual_hub_bgp_connections

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the connection.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the bgp connection.
type	string	Connection type.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	connectionName, resourceGroupName, subscriptionId, virtualHubName	Retrieves the details of a Virtual Hub Bgp Connection.
list	SELECT	resourceGroupName, subscriptionId, virtualHubName	Retrieves the details of all VirtualHubBgpConnections.
create_or_update	INSERT	connectionName, resourceGroupName, subscriptionId, virtualHubName	Creates a VirtualHubBgpConnection resource if it doesn't exist else updates the existing VirtualHubBgpConnection.
delete	DELETE	connectionName, resourceGroupName, subscriptionId, virtualHubName	Deletes a VirtualHubBgpConnection.

SELECT examples

Retrieves the details of all VirtualHubBgpConnections.

vw_virtual_hub_bgp_connections

SELECT
id,
name,
connectionName,
connection_state,
etag,
hub_virtual_network_connection,
peer_asn,
peer_ip,
provisioning_state,
resourceGroupName,
subscriptionId,
type,
virtualHubName
FROM azure.network.vw_virtual_hub_bgp_connections
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND virtualHubName = '{{ virtualHubName }}';

virtual_hub_bgp_connections

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.virtual_hub_bgp_connections
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND virtualHubName = '{{ virtualHubName }}';

INSERT example

Use the following StackQL query and manifest file to create a new virtual_hub_bgp_connections resource.

All Properties

/*+ create */
INSERT INTO azure.network.virtual_hub_bgp_connections (
connectionName,
resourceGroupName,
subscriptionId,
virtualHubName,
properties,
name,
id
)
SELECT 
'{{ connectionName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ virtualHubName }}',
'{{ properties }}',
'{{ name }}',
'{{ id }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: peerAsn
          value: integer
        - name: peerIp
          value: string
        - name: hubVirtualNetworkConnection
          value:
            - name: id
              value: string
        - name: provisioningState
          value: []
        - name: connectionState
          value: string
    - name: name
      value: string
    - name: etag
      value: string
    - name: type
      value: string
    - name: id
      value: string

DELETE example

Deletes the specified virtual_hub_bgp_connections resource.

/*+ delete */
DELETE FROM azure.network.virtual_hub_bgp_connections
WHERE connectionName = '{{ connectionName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND virtualHubName = '{{ virtualHubName }}';