virtual_network_gateway_connections

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

Overview

Name	virtual_network_gateway_connections
Type	Resource
Id	azure.network.virtual_network_gateway_connections

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the virtual network gateway connection.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

Request successful. The operation resets the virtual network gateway connection shared key.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the virtual network gateway connection.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, virtualNetworkGatewayConnectionName, subscriptionId		Gets the specified virtual network gateway connection by resource group.
list	select	resourceGroupName, subscriptionId		The List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created.
create_or_update	insert	resourceGroupName, virtualNetworkGatewayConnectionName, subscriptionId, data__properties		Creates or updates a virtual network gateway connection in the specified resource group.
delete	delete	resourceGroupName, virtualNetworkGatewayConnectionName, subscriptionId		Deletes the specified virtual network Gateway connection.
update_tags	exec	resourceGroupName, virtualNetworkGatewayConnectionName, subscriptionId		Updates a virtual network gateway connection tags.
set_shared_key	exec	resourceGroupName, virtualNetworkGatewayConnectionName, subscriptionId, value		The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.
reset_shared_key	exec	resourceGroupName, virtualNetworkGatewayConnectionName, subscriptionId, keyLength		The VirtualNetworkGatewayConnectionResetSharedKey operation resets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.
start_packet_capture	exec	resourceGroupName, virtualNetworkGatewayConnectionName, subscriptionId		Starts packet capture on virtual network gateway connection in the specified resource group.
stop_packet_capture	exec	resourceGroupName, virtualNetworkGatewayConnectionName, subscriptionId		Stops packet capture on virtual network gateway connection in the specified resource group.
reset_connection	exec	resourceGroupName, virtualNetworkGatewayConnectionName, subscriptionId		Resets the virtual network gateway connection specified.

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
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
virtualNetworkGatewayConnectionName	string	The name of the virtual network gateway Connection.

SELECT examples

get

Gets the specified virtual network gateway connection by resource group.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.virtual_network_gateway_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualNetworkGatewayConnectionName = '{{ virtualNetworkGatewayConnectionName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

The List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created.

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

INSERT examples

create_or_update

Creates or updates a virtual network gateway connection in the specified resource group.

INSERT INTO azure.network.virtual_network_gateway_connections (
data__properties,
resourceGroupName,
virtualNetworkGatewayConnectionName,
subscriptionId
)
SELECT 
'{{ properties }}' /* required */,
'{{ resourceGroupName }}',
'{{ virtualNetworkGatewayConnectionName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_network_gateway_connections
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the virtual_network_gateway_connections resource.
    - name: virtualNetworkGatewayConnectionName
      value: string
      description: Required parameter for the virtual_network_gateway_connections resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the virtual_network_gateway_connections resource.
    - name: properties
      value: object
      description: |
        Properties of the virtual network gateway connection.

DELETE examples

delete

Deletes the specified virtual network Gateway connection.

DELETE FROM azure.network.virtual_network_gateway_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND virtualNetworkGatewayConnectionName = '{{ virtualNetworkGatewayConnectionName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

update_tags

Updates a virtual network gateway connection tags.

EXEC azure.network.virtual_network_gateway_connections.update_tags 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@virtualNetworkGatewayConnectionName='{{ virtualNetworkGatewayConnectionName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;

set_shared_key

The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.

EXEC azure.network.virtual_network_gateway_connections.set_shared_key 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@virtualNetworkGatewayConnectionName='{{ virtualNetworkGatewayConnectionName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"value": "{{ value }}", 
"id": "{{ id }}"
}'
;

reset_shared_key

The VirtualNetworkGatewayConnectionResetSharedKey operation resets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.

EXEC azure.network.virtual_network_gateway_connections.reset_shared_key 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@virtualNetworkGatewayConnectionName='{{ virtualNetworkGatewayConnectionName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"keyLength": {{ keyLength }}
}'
;

start_packet_capture

Starts packet capture on virtual network gateway connection in the specified resource group.

EXEC azure.network.virtual_network_gateway_connections.start_packet_capture 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@virtualNetworkGatewayConnectionName='{{ virtualNetworkGatewayConnectionName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"filterData": "{{ filterData }}"
}'
;

stop_packet_capture

Stops packet capture on virtual network gateway connection in the specified resource group.

EXEC azure.network.virtual_network_gateway_connections.stop_packet_capture 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@virtualNetworkGatewayConnectionName='{{ virtualNetworkGatewayConnectionName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"sasUrl": "{{ sasUrl }}"
}'
;

reset_connection

Resets the virtual network gateway connection specified.

EXEC azure.network.virtual_network_gateway_connections.reset_connection 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@virtualNetworkGatewayConnectionName='{{ virtualNetworkGatewayConnectionName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;