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

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
get	select	resource_group_name, gateway_name, connection_name, link_connection_name, subscription_id		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
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

get

Retrieves the details of a vpn site link 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_site_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
;