vpn_link_connections

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

Overview

Name	vpn_link_connections
Type	Resource
Id	azure.network.vpn_link_connections

Fields

The following fields are returned by SELECT queries:

list_by_vpn_connection

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 site link connection.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_vpn_connection	select	subscriptionId, resourceGroupName, gatewayName, connectionName		Retrieves all vpn site link connections for a particular virtual wan vpn gateway vpn connection.
reset_connection	exec	subscriptionId, resourceGroupName, gatewayName, connectionName, linkConnectionName		Resets the VpnLink connection specified.
set_or_init_default_shared_key	exec	subscriptionId, resourceGroupName, gatewayName, connectionName, linkConnectionName		Sets or auto generates the shared key based on the user input. If users give a shared key value, it does the set operation. If key length is given, the operation creates a random key of the pre-defined length.

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

SELECT examples

list_by_vpn_connection

Retrieves all vpn site link connections for a particular virtual wan vpn gateway vpn connection.

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

Lifecycle Methods

reset_connection

Resets the VpnLink connection specified.

EXEC azure.network.vpn_link_connections.reset_connection 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@gatewayName='{{ gatewayName }}' --required, 
@connectionName='{{ connectionName }}' --required, 
@linkConnectionName='{{ linkConnectionName }}' --required
;

set_or_init_default_shared_key

Sets or auto generates the shared key based on the user input. If users give a shared key value, it does the set operation. If key length is given, the operation creates a random key of the pre-defined length.

EXEC azure.network.vpn_link_connections.set_or_init_default_shared_key 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@gatewayName='{{ gatewayName }}' --required, 
@connectionName='{{ connectionName }}' --required, 
@linkConnectionName='{{ linkConnectionName }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"id": "{{ id }}", 
"name": "{{ name }}"
}'
;