vpn_connections

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

Overview

Name	vpn_connections
Type	Resource
Id	azure.network.vpn_connections

Fields

The following fields are returned by SELECT queries:

get

Request successful. Returns the details of the vpn connection.

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 VPN connection.

list_by_vpn_gateway

Request successful. Returns all Vpn connections for a virtual wan vpn gateway.

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 VPN connection.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, gatewayName, connectionName		Retrieves the details of a vpn connection.
list_by_vpn_gateway	select	subscriptionId, resourceGroupName, gatewayName		Retrieves all vpn connections for a particular virtual wan vpn gateway.
create_or_update	insert	subscriptionId, resourceGroupName, gatewayName, connectionName		Creates a vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection.
delete	delete	subscriptionId, resourceGroupName, gatewayName, connectionName		Deletes a vpn connection.
start_packet_capture	exec	resourceGroupName, gatewayName, vpnConnectionName, subscriptionId		Starts packet capture on Vpn connection in the specified resource group.
stop_packet_capture	exec	resourceGroupName, gatewayName, vpnConnectionName, subscriptionId		Stops packet capture on Vpn connection in the specified resource group.

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.
gatewayName	string	The name of the gateway.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
vpnConnectionName	string	The name of the vpn connection.

SELECT examples

get

Retrieves the details of a vpn connection.

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

list_by_vpn_gateway

Retrieves all vpn connections for a particular virtual wan vpn gateway.

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

INSERT examples

create_or_update

Creates a vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection.

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

Manifest

# Description fields are for documentation purposes
- name: vpn_connections
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the vpn_connections resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the vpn_connections resource.
    - name: gatewayName
      value: string
      description: Required parameter for the vpn_connections resource.
    - name: connectionName
      value: string
      description: Required parameter for the vpn_connections resource.
    - name: properties
      value: object
      description: |
        Properties of the VPN 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 vpn connection.

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

Lifecycle Methods

start_packet_capture

Starts packet capture on Vpn connection in the specified resource group.

EXEC azure.network.vpn_connections.start_packet_capture 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@gatewayName='{{ gatewayName }}' --required, 
@vpnConnectionName='{{ vpnConnectionName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"filterData": "{{ filterData }}", 
"linkConnectionNames": "{{ linkConnectionNames }}"
}'
;

stop_packet_capture

Stops packet capture on Vpn connection in the specified resource group.

EXEC azure.network.vpn_connections.stop_packet_capture 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@gatewayName='{{ gatewayName }}' --required, 
@vpnConnectionName='{{ vpnConnectionName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"sasUrl": "{{ sasUrl }}", 
"linkConnectionNames": "{{ linkConnectionNames }}"
}'
;