Skip to main content

vpn_site_links

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

Overview

Namevpn_site_links
TypeResource
Idazure.network.vpn_site_links

Fields

NameDatatypeDescription
idtextResource ID.
nametextThe name of the resource that is unique within a resource group. This name can be used to access the resource.
bgp_propertiestextfield from the properties object
etagtextA unique read-only string that changes whenever the resource is updated.
fqdntextfield from the properties object
ip_addresstextfield from the properties object
link_propertiestextfield from the properties object
provisioning_statetextfield from the properties object
resourceGroupNametextfield from the properties object
subscriptionIdtextfield from the properties object
typetextResource type.
vpnSiteLinkNametextfield from the properties object
vpnSiteNametextfield from the properties object

Methods

NameAccessible byRequired ParamsDescription
getSELECTresourceGroupName, subscriptionId, vpnSiteLinkName, vpnSiteNameRetrieves the details of a VPN site link.
list_by_vpn_siteSELECTresourceGroupName, subscriptionId, vpnSiteNameLists all the vpnSiteLinks in a resource group for a vpn site.

SELECT examples

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

SELECT
id,
name,
bgp_properties,
etag,
fqdn,
ip_address,
link_properties,
provisioning_state,
resourceGroupName,
subscriptionId,
type,
vpnSiteLinkName,
vpnSiteName
FROM azure.network.vw_vpn_site_links
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND vpnSiteName = '{{ vpnSiteName }}';