hub_virtual_network_connections

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

Overview

Name	hub_virtual_network_connections
Type	Resource
Id	azure.network.hub_virtual_network_connections

Fields

The following fields are returned by SELECT queries:

get

Request successful. Returns the details of the HubVirtualNetworkConnection retrieved.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the hub virtual network connection.

list

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

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the hub virtual network connection.

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 HubVirtualNetworkConnection.
list	select	subscriptionId, resourceGroupName, virtualHubName		Retrieves the details of all HubVirtualNetworkConnections.
create_or_update	insert	subscriptionId, resourceGroupName, virtualHubName, connectionName		Creates a hub virtual network connection if it doesn't exist else updates the existing one.
delete	delete	subscriptionId, resourceGroupName, virtualHubName, connectionName		Deletes a HubVirtualNetworkConnection.

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 HubVirtualNetworkConnection.
resourceGroupName	string	The resource group name of the VirtualHub.
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 HubVirtualNetworkConnection.

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

list

Retrieves the details of all HubVirtualNetworkConnections.

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

INSERT examples

create_or_update

Creates a hub virtual network connection if it doesn't exist else updates the existing one.

INSERT INTO azure.network.hub_virtual_network_connections (
data__properties,
data__name,
data__id,
subscriptionId,
resourceGroupName,
virtualHubName,
connectionName
)
SELECT 
'{{ properties }}',
'{{ name }}',
'{{ id }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ virtualHubName }}',
'{{ connectionName }}'
RETURNING
id,
name,
etag,
properties
;

Manifest

# Description fields are for documentation purposes
- name: hub_virtual_network_connections
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the hub_virtual_network_connections resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the hub_virtual_network_connections resource.
    - name: virtualHubName
      value: string
      description: Required parameter for the hub_virtual_network_connections resource.
    - name: connectionName
      value: string
      description: Required parameter for the hub_virtual_network_connections resource.
    - name: properties
      value: object
      description: |
        Properties of the hub virtual network connection.
    - name: name
      value: string
      description: |
        The name of the resource that is unique within a resource group. This name can be used to access the resource.
    - name: id
      value: string
      description: |
        Resource ID.

DELETE examples

delete

Deletes a HubVirtualNetworkConnection.

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