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

vw_hub_virtual_network_connections

Name	Datatype	Description
id	text	Resource ID.
name	text	The name of the resource that is unique within a resource group. This name can be used to access the resource.
allow_hub_to_remote_vnet_transit	text	field from the properties object
allow_remote_vnet_to_use_hub_vnet_gateways	text	field from the properties object
connectionName	text	field from the properties object
enable_internet_security	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
provisioning_state	text	field from the properties object
remote_virtual_network	text	field from the properties object
resourceGroupName	text	field from the properties object
routing_configuration	text	field from the properties object
subscriptionId	text	field from the properties object
virtualHubName	text	field from the properties object

hub_virtual_network_connections

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	Parameters for HubVirtualNetworkConnection.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	connectionName, resourceGroupName, subscriptionId, virtualHubName	Retrieves the details of a HubVirtualNetworkConnection.
list	SELECT	resourceGroupName, subscriptionId, virtualHubName	Retrieves the details of all HubVirtualNetworkConnections.
create_or_update	INSERT	connectionName, resourceGroupName, subscriptionId, virtualHubName	Creates a hub virtual network connection if it doesn't exist else updates the existing one.
delete	DELETE	connectionName, resourceGroupName, subscriptionId, virtualHubName	Deletes a HubVirtualNetworkConnection.

SELECT examples

Retrieves the details of all HubVirtualNetworkConnections.

vw_hub_virtual_network_connections

SELECT
id,
name,
allow_hub_to_remote_vnet_transit,
allow_remote_vnet_to_use_hub_vnet_gateways,
connectionName,
enable_internet_security,
etag,
provisioning_state,
remote_virtual_network,
resourceGroupName,
routing_configuration,
subscriptionId,
virtualHubName
FROM azure.network.vw_hub_virtual_network_connections
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND virtualHubName = '{{ virtualHubName }}';

hub_virtual_network_connections

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.network.hub_virtual_network_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: remoteVirtualNetwork
          value:
            - name: id
              value: string
        - name: allowHubToRemoteVnetTransit
          value: boolean
        - name: allowRemoteVnetToUseHubVnetGateways
          value: boolean
        - name: enableInternetSecurity
          value: boolean
        - name: routingConfiguration
          value:
            - name: propagatedRouteTables
              value:
                - name: labels
                  value:
                    - string
                - name: ids
                  value:
                    - - name: id
                        value: string
            - name: vnetRoutes
              value:
                - name: staticRoutesConfig
                  value:
                    - name: propagateStaticRoutes
                      value: boolean
                    - name: vnetLocalRouteOverrideCriteria
                      value: []
                - name: staticRoutes
                  value:
                    - - name: name
                        value: string
                      - name: addressPrefixes
                        value:
                          - string
                      - name: nextHopIpAddress
                        value: string
                - name: bgpConnections
                  value:
                    - - name: id
                        value: string
        - name: provisioningState
          value: []
    - name: name
      value: string
    - name: etag
      value: string
    - name: id
      value: string

DELETE example

Deletes the specified hub_virtual_network_connections resource.

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