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_default_shared_key

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
provisioningState	string	The provisioning state of the SharedKey resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
sharedKey	string	The value of the shared key for the vpn link connection.
sharedKeyLength	integer	The length of the shared key for the vpn link connection.
type	string	Resource type.

list_by_vpn_connection

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
connectionBandwidth	integer	Expected bandwidth in MBPS.
connectionStatus	string	The connection status. Known values are: "Unknown", "Connecting", "Connected", and "NotConnected". (Unknown, Connecting, Connected, NotConnected)
dpdTimeoutSeconds	integer	Dead Peer Detection timeout in seconds for VpnLink connection.
egressBytesTransferred	integer	Egress bytes transferred.
egressNatRules	array	List of egress NatRules.
enableBgp	boolean	EnableBgp flag.
enableRateLimiting	boolean	EnableBgp flag.
etag	string	A unique read-only string that changes whenever the resource is updated.
ingressBytesTransferred	integer	Ingress bytes transferred.
ingressNatRules	array	List of ingress NatRules.
ipsecPolicies	array	The IPSec Policies to be considered by this connection.
provisioningState	string	The provisioning state of the VPN site link connection resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
routingWeight	integer	Routing weight for vpn connection.
sharedKey	string	SharedKey for the vpn link connection. We will no longer return sharedKey in any Create/Update/Get/List/UpdateTags VpnGateway/VpnConnection/VpnLinkConnection APIs response. Please use 'Vpn Link Connections - List Default Shared Key' API to fetch Vpn link connection sharedKey.
type	string	Resource type.
useLocalAzureIpAddress	boolean	Use local azure ip to initiate connection.
usePolicyBasedTrafficSelectors	boolean	Enable policy-based traffic selectors.
vpnConnectionProtocolType	string	Connection protocol used for this connection. Known values are: "IKEv2" and "IKEv1". (IKEv2, IKEv1)
vpnGatewayCustomBgpAddresses	array	vpnGatewayCustomBgpAddresses used by this connection.
vpnLinkConnectionMode	string	Vpn link connection mode. Known values are: "Default", "ResponderOnly", and "InitiatorOnly". (Default, ResponderOnly, InitiatorOnly)
vpnSiteLink	object	Reference to another subresource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_default_shared_key	select	resource_group_name, gateway_name, connection_name, link_connection_name, subscription_id		Gets the value of the shared key of VpnLink connection specified.
list_by_vpn_connection	select	resource_group_name, gateway_name, connection_name, subscription_id		Retrieves all vpn site link connections for a particular virtual wan vpn gateway vpn connection.
get_default_shared_key	exec	resource_group_name, gateway_name, connection_name, link_connection_name, subscription_id		Gets the shared key of VpnLink connection specified.
set_or_init_default_shared_key	exec	resource_group_name, gateway_name, connection_name, link_connection_name, subscription_id		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.
get_all_shared_keys	exec	resource_group_name, gateway_name, connection_name, link_connection_name, subscription_id		Lists all shared keys of VpnLink connection specified.
get_ike_sas	exec	resource_group_name, gateway_name, connection_name, link_connection_name, subscription_id		Lists IKE Security Associations for Vpn Site Link Connection in the specified resource group.
reset_connection	exec	resource_group_name, gateway_name, connection_name, link_connection_name, subscription_id		Resets the VpnLink 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
connection_name	string	The name of the vpn connection. Required.
gateway_name	string	The name of the vpn gateway. Required.
link_connection_name	string	The name of the vpn link connection. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

list_default_shared_key

Gets the value of the shared key of VpnLink connection specified.

SELECT
id,
name,
provisioningState,
sharedKey,
sharedKeyLength,
type
FROM azure.network.vpn_link_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND gateway_name = '{{ gateway_name }}' -- required
AND connection_name = '{{ connection_name }}' -- required
AND link_connection_name = '{{ link_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_vpn_connection

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

SELECT
id,
name,
connectionBandwidth,
connectionStatus,
dpdTimeoutSeconds,
egressBytesTransferred,
egressNatRules,
enableBgp,
enableRateLimiting,
etag,
ingressBytesTransferred,
ingressNatRules,
ipsecPolicies,
provisioningState,
routingWeight,
sharedKey,
type,
useLocalAzureIpAddress,
usePolicyBasedTrafficSelectors,
vpnConnectionProtocolType,
vpnGatewayCustomBgpAddresses,
vpnLinkConnectionMode,
vpnSiteLink
FROM azure.network.vpn_link_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND gateway_name = '{{ gateway_name }}' -- required
AND connection_name = '{{ connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

get_default_shared_key

Gets the shared key of VpnLink connection specified.

EXEC azure.network.vpn_link_connections.get_default_shared_key 
@resource_group_name='{{ resource_group_name }}' --required, 
@gateway_name='{{ gateway_name }}' --required, 
@connection_name='{{ connection_name }}' --required, 
@link_connection_name='{{ link_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --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 
@resource_group_name='{{ resource_group_name }}' --required, 
@gateway_name='{{ gateway_name }}' --required, 
@connection_name='{{ connection_name }}' --required, 
@link_connection_name='{{ link_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"id": "{{ id }}", 
"name": "{{ name }}", 
"properties": "{{ properties }}"
}'
;

get_all_shared_keys

Lists all shared keys of VpnLink connection specified.

EXEC azure.network.vpn_link_connections.get_all_shared_keys 
@resource_group_name='{{ resource_group_name }}' --required, 
@gateway_name='{{ gateway_name }}' --required, 
@connection_name='{{ connection_name }}' --required, 
@link_connection_name='{{ link_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_ike_sas

Lists IKE Security Associations for Vpn Site Link Connection in the specified resource group.

EXEC azure.network.vpn_link_connections.get_ike_sas 
@resource_group_name='{{ resource_group_name }}' --required, 
@gateway_name='{{ gateway_name }}' --required, 
@connection_name='{{ connection_name }}' --required, 
@link_connection_name='{{ link_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

reset_connection

Resets the VpnLink connection specified.

EXEC azure.network.vpn_link_connections.reset_connection 
@resource_group_name='{{ resource_group_name }}' --required, 
@gateway_name='{{ gateway_name }}' --required, 
@connection_name='{{ connection_name }}' --required, 
@link_connection_name='{{ link_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;