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

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
bgpProperties	object	The set of bgp properties.
etag	string	A unique read-only string that changes whenever the resource is updated.
fqdn	string	FQDN of vpn-site-link.
ipAddress	string	The ip-address for the vpn-site-link.
linkProperties	object	The link provider properties.
provisioningState	string	The provisioning state of the VPN site link resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
type	string	Resource type.

list_by_vpn_site

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
bgpProperties	object	The set of bgp properties.
etag	string	A unique read-only string that changes whenever the resource is updated.
fqdn	string	FQDN of vpn-site-link.
ipAddress	string	The ip-address for the vpn-site-link.
linkProperties	object	The link provider properties.
provisioningState	string	The provisioning state of the VPN site link resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, vpn_site_name, vpn_site_link_name, subscription_id		Retrieves the details of a VPN site link.
list_by_vpn_site	select	resource_group_name, vpn_site_name, subscription_id		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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
vpn_site_link_name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource. Required.
vpn_site_name	string	The name of the VpnSite being retrieved. Required.

SELECT examples

get

Retrieves the details of a VPN site link.

SELECT
id,
name,
bgpProperties,
etag,
fqdn,
ipAddress,
linkProperties,
provisioningState,
type
FROM azure.network.vpn_site_links
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vpn_site_name = '{{ vpn_site_name }}' -- required
AND vpn_site_link_name = '{{ vpn_site_link_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_vpn_site

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

SELECT
id,
name,
bgpProperties,
etag,
fqdn,
ipAddress,
linkProperties,
provisioningState,
type
FROM azure.network.vpn_site_links
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vpn_site_name = '{{ vpn_site_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;