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:

get

Request successful. Returns the details of the Bgp Connection retrieved.

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	The properties of the Bgp connections.
type	string	Connection type.

list

Request successful. Returns the details of all the VirtualHubBgpConnections for the VirtualHub.

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	The properties of the Bgp connections.
type	string	Connection type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, virtualHubName, connectionName		Retrieves the details of a Virtual Hub Bgp Connection.
list	select	subscriptionId, resourceGroupName, virtualHubName		Retrieves the details of all VirtualHubBgpConnections.
create_or_update	insert	subscriptionId, resourceGroupName, virtualHubName, connectionName		Creates a VirtualHubBgpConnection resource if it doesn't exist else updates the existing VirtualHubBgpConnection.
delete	delete	subscriptionId, resourceGroupName, virtualHubName, connectionName		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
connectionName	string	The name of the connection.
resourceGroupName	string	The resource group name of the VirtualHubBgpConnection.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
virtualHubName	string	The name of the VirtualHub.

SELECT examples

get

Retrieves the details of a Virtual Hub Bgp Connection.

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

list

Retrieves the details of all VirtualHubBgpConnections.

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.virtual_hub_bgp_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualHubName = '{{ virtualHubName }}' -- 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_connections (
data__properties,
data__name,
data__id,
subscriptionId,
resourceGroupName,
virtualHubName,
connectionName
)
SELECT 
'{{ properties }}',
'{{ name }}',
'{{ id }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ virtualHubName }}',
'{{ connectionName }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_hub_bgp_connections
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the virtual_hub_bgp_connections resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the virtual_hub_bgp_connections resource.
    - name: virtualHubName
      value: string
      description: Required parameter for the virtual_hub_bgp_connections resource.
    - name: connectionName
      value: string
      description: Required parameter for the virtual_hub_bgp_connections resource.
    - name: properties
      value: object
      description: |
        The properties of the Bgp connections.
    - name: name
      value: string
      description: |
        Name of the connection.
    - name: id
      value: string
      description: |
        Resource ID.

DELETE examples

delete

Deletes a VirtualHubBgpConnection.

DELETE FROM azure.network.virtual_hub_bgp_connections
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND virtualHubName = '{{ virtualHubName }}' --required
AND connectionName = '{{ connectionName }}' --required
;