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

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.
allowHubToRemoteVnetTransit	boolean	Deprecated: VirtualHub to RemoteVnet transit to enabled or not.
allowRemoteVnetToUseHubVnetGateways	boolean	Deprecated: Allow RemoteVnet to use Virtual Hub's gateways.
connectionPolicy	object	Reference to another subresource.
enableInternetSecurity	boolean	Enable internet security.
etag	string	A unique read-only string that changes whenever the resource is updated.
provisioningState	string	The provisioning state of the hub virtual network connection resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
remoteVirtualNetwork	object	Reference to another subresource.
routingConfiguration	object	The Routing Configuration indicating the associated and propagated route tables on this connection.

list

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.
allowHubToRemoteVnetTransit	boolean	Deprecated: VirtualHub to RemoteVnet transit to enabled or not.
allowRemoteVnetToUseHubVnetGateways	boolean	Deprecated: Allow RemoteVnet to use Virtual Hub's gateways.
connectionPolicy	object	Reference to another subresource.
enableInternetSecurity	boolean	Enable internet security.
etag	string	A unique read-only string that changes whenever the resource is updated.
provisioningState	string	The provisioning state of the hub virtual network connection resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
remoteVirtualNetwork	object	Reference to another subresource.
routingConfiguration	object	The Routing Configuration indicating the associated and propagated route tables on this connection.

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 HubVirtualNetworkConnection.
list	select	resource_group_name, virtual_hub_name, subscription_id		Retrieves the details of all HubVirtualNetworkConnections.
create_or_update	insert	resource_group_name, virtual_hub_name, connection_name, subscription_id		Creates a hub virtual network connection if it doesn't exist else updates the existing one.
create_or_update	replace	resource_group_name, virtual_hub_name, connection_name, subscription_id		Creates a hub virtual network connection if it doesn't exist else updates the existing one.
delete	delete	resource_group_name, virtual_hub_name, connection_name, subscription_id		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
connection_name	string	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 Virtual Hub. Required.

SELECT examples

get

Retrieves the details of a HubVirtualNetworkConnection.

SELECT
id,
name,
allowHubToRemoteVnetTransit,
allowRemoteVnetToUseHubVnetGateways,
connectionPolicy,
enableInternetSecurity,
etag,
provisioningState,
remoteVirtualNetwork,
routingConfiguration
FROM azure.network.hub_virtual_network_connections
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
;

list

Retrieves the details of all HubVirtualNetworkConnections.

SELECT
id,
name,
allowHubToRemoteVnetTransit,
allowRemoteVnetToUseHubVnetGateways,
connectionPolicy,
enableInternetSecurity,
etag,
provisioningState,
remoteVirtualNetwork,
routingConfiguration
FROM azure.network.hub_virtual_network_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_hub_name = '{{ virtual_hub_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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 (
id,
properties,
name,
resource_group_name,
virtual_hub_name,
connection_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ properties }}',
'{{ name }}',
'{{ resource_group_name }}',
'{{ virtual_hub_name }}',
'{{ connection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties
;

Manifest

# Description fields are for documentation purposes
- name: hub_virtual_network_connections
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the hub_virtual_network_connections resource.
  - name: virtual_hub_name
    value: "{{ virtual_hub_name }}"
    description: Required parameter for the hub_virtual_network_connections resource.
  - name: connection_name
    value: "{{ connection_name }}"
    description: Required parameter for the hub_virtual_network_connections resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the hub_virtual_network_connections resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: properties
    description: |
      Properties of the hub virtual network connection.
    value:
      remoteVirtualNetwork:
        id: "{{ id }}"
      allowHubToRemoteVnetTransit: {{ allowHubToRemoteVnetTransit }}
      allowRemoteVnetToUseHubVnetGateways: {{ allowRemoteVnetToUseHubVnetGateways }}
      connectionPolicy:
        id: "{{ id }}"
      enableInternetSecurity: {{ enableInternetSecurity }}
      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 }}"
      provisioningState: "{{ provisioningState }}"
  - name: name
    value: "{{ name }}"
    description: |
      The name of the resource that is unique within a resource group. This name can be used to access the resource.

REPLACE examples

create_or_update

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

REPLACE azure.network.hub_virtual_network_connections
SET 
id = '{{ id }}',
properties = '{{ properties }}',
name = '{{ name }}'
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;

DELETE examples

delete

Deletes a HubVirtualNetworkConnection.

DELETE FROM azure.network.hub_virtual_network_connections
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
;