vpn_site_links

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

Overview

Name	vpn_site_links
Type	Resource
Id	azure.network.vpn_site_links

Fields

The following fields are returned by SELECT queries:

get

Request successful. Returns the details of the VpnSiteLink retrieved.

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

list_by_vpn_site

Request successful. Returns the details of all the vpnSites in the resource group.

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.
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, vpnSiteName, vpnSiteLinkName		Retrieves the details of a VPN site link.
list_by_vpn_site	select	subscriptionId, resourceGroupName, vpnSiteName		Lists all the vpnSiteLinks in a resource group for a vpn site.

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 resource group name of the VpnSite.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
vpnSiteLinkName	string	The name of the VpnSiteLink being retrieved.
vpnSiteName	string	The name of the VpnSite.

SELECT examples

get

Retrieves the details of a VPN site link.

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

list_by_vpn_site

Lists all the vpnSiteLinks in a resource group for a vpn site.

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