vpn_site_link_connections

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

Overview

Name	vpn_site_link_connections
Type	Resource
Id	azure.network.vpn_site_link_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 site link connection.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, gatewayName, connectionName, linkConnectionName		Retrieves the details of a vpn site link connection.

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 vpn connection.
gatewayName	string	The name of the gateway.
linkConnectionName	string	The name of the vpn 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

get

Retrieves the details of a vpn site link connection.

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