vpn_connections

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

Overview

Name	vpn_connections
Type	Resource
Id	azure.network.vpn_connections

Fields

vw_vpn_connections

Name	Datatype	Description
id	text	Resource ID.
name	text	The name of the resource that is unique within a resource group. This name can be used to access the resource.
connectionName	text	field from the properties object
connection_bandwidth	text	field from the properties object
connection_status	text	field from the properties object
dpd_timeout_seconds	text	field from the properties object
egress_bytes_transferred	text	field from the properties object
enable_bgp	text	field from the properties object
enable_internet_security	text	field from the properties object
enable_rate_limiting	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
gatewayName	text	field from the properties object
ingress_bytes_transferred	text	field from the properties object
ipsec_policies	text	field from the properties object
provisioning_state	text	field from the properties object
remote_vpn_site	text	field from the properties object
resourceGroupName	text	field from the properties object
routing_configuration	text	field from the properties object
routing_weight	text	field from the properties object
shared_key	text	field from the properties object
subscriptionId	text	field from the properties object
traffic_selector_policies	text	field from the properties object
use_local_azure_ip_address	text	field from the properties object
use_policy_based_traffic_selectors	text	field from the properties object
vpn_connection_protocol_type	text	field from the properties object
vpn_link_connections	text	field from the properties object

vpn_connections

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	Parameters for VpnConnection.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	connectionName, gatewayName, resourceGroupName, subscriptionId	Retrieves the details of a vpn connection.
list_by_vpn_gateway	SELECT	gatewayName, resourceGroupName, subscriptionId	Retrieves all vpn connections for a particular virtual wan vpn gateway.
create_or_update	INSERT	connectionName, gatewayName, resourceGroupName, subscriptionId	Creates a vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection.
delete	DELETE	connectionName, gatewayName, resourceGroupName, subscriptionId	Deletes a vpn connection.
start_packet_capture	EXEC	gatewayName, resourceGroupName, subscriptionId, vpnConnectionName	Starts packet capture on Vpn connection in the specified resource group.
stop_packet_capture	EXEC	gatewayName, resourceGroupName, subscriptionId, vpnConnectionName	Stops packet capture on Vpn connection in the specified resource group.

SELECT examples

Retrieves all vpn connections for a particular virtual wan vpn gateway.

vw_vpn_connections

SELECT
id,
name,
connectionName,
connection_bandwidth,
connection_status,
dpd_timeout_seconds,
egress_bytes_transferred,
enable_bgp,
enable_internet_security,
enable_rate_limiting,
etag,
gatewayName,
ingress_bytes_transferred,
ipsec_policies,
provisioning_state,
remote_vpn_site,
resourceGroupName,
routing_configuration,
routing_weight,
shared_key,
subscriptionId,
traffic_selector_policies,
use_local_azure_ip_address,
use_policy_based_traffic_selectors,
vpn_connection_protocol_type,
vpn_link_connections
FROM azure.network.vw_vpn_connections
WHERE gatewayName = '{{ gatewayName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

vpn_connections

SELECT
id,
name,
etag,
properties
FROM azure.network.vpn_connections
WHERE gatewayName = '{{ gatewayName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new vpn_connections resource.

All Properties

/*+ create */
INSERT INTO azure.network.vpn_connections (
connectionName,
gatewayName,
resourceGroupName,
subscriptionId,
properties,
name,
id
)
SELECT 
'{{ connectionName }}',
'{{ gatewayName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}',
'{{ name }}',
'{{ id }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: remoteVpnSite
          value:
            - name: id
              value: string
        - name: routingWeight
          value: integer
        - name: dpdTimeoutSeconds
          value: integer
        - name: connectionStatus
          value: []
        - name: vpnConnectionProtocolType
          value: []
        - name: ingressBytesTransferred
          value: integer
        - name: egressBytesTransferred
          value: integer
        - name: connectionBandwidth
          value: integer
        - name: sharedKey
          value: string
        - name: enableBgp
          value: boolean
        - name: usePolicyBasedTrafficSelectors
          value: boolean
        - name: ipsecPolicies
          value:
            - - name: saLifeTimeSeconds
                value: integer
              - name: saDataSizeKilobytes
                value: integer
              - name: ipsecEncryption
                value: []
              - name: ipsecIntegrity
                value: []
              - name: ikeEncryption
                value: []
              - name: ikeIntegrity
                value: []
              - name: dhGroup
                value: []
              - name: pfsGroup
                value: []
        - name: trafficSelectorPolicies
          value:
            - - name: localAddressRanges
                value:
                  - string
              - name: remoteAddressRanges
                value:
                  - string
        - name: enableRateLimiting
          value: boolean
        - name: enableInternetSecurity
          value: boolean
        - name: useLocalAzureIpAddress
          value: boolean
        - name: provisioningState
          value: []
        - name: vpnLinkConnections
          value:
            - - name: properties
                value:
                  - name: routingWeight
                    value: integer
                  - name: vpnLinkConnectionMode
                    value: string
                  - name: ingressBytesTransferred
                    value: integer
                  - name: egressBytesTransferred
                    value: integer
                  - name: connectionBandwidth
                    value: integer
                  - name: sharedKey
                    value: string
                  - name: enableBgp
                    value: boolean
                  - name: vpnGatewayCustomBgpAddresses
                    value:
                      - - name: ipConfigurationId
                          value: string
                        - name: customBgpIpAddress
                          value: string
                  - name: usePolicyBasedTrafficSelectors
                    value: boolean
                  - name: ipsecPolicies
                    value:
                      - - name: saLifeTimeSeconds
                          value: integer
                        - name: saDataSizeKilobytes
                          value: integer
                  - name: enableRateLimiting
                    value: boolean
                  - name: useLocalAzureIpAddress
                    value: boolean
                  - name: ingressNatRules
                    value:
                      - - name: id
                          value: string
                  - name: egressNatRules
                    value:
                      - - name: id
                          value: string
                  - name: dpdTimeoutSeconds
                    value: integer
              - name: name
                value: string
              - name: etag
                value: string
              - name: type
                value: string
              - name: id
                value: string
        - name: routingConfiguration
          value:
            - name: propagatedRouteTables
              value:
                - name: labels
                  value:
                    - string
                - name: ids
                  value:
                    - - name: id
                        value: string
            - name: vnetRoutes
              value:
                - name: staticRoutesConfig
                  value:
                    - name: propagateStaticRoutes
                      value: boolean
                    - name: vnetLocalRouteOverrideCriteria
                      value: []
                - name: staticRoutes
                  value:
                    - - name: name
                        value: string
                      - name: addressPrefixes
                        value:
                          - string
                      - name: nextHopIpAddress
                        value: string
                - name: bgpConnections
                  value:
                    - - name: id
                        value: string
    - name: name
      value: string
    - name: etag
      value: string
    - name: id
      value: string

DELETE example

Deletes the specified vpn_connections resource.

/*+ delete */
DELETE FROM azure.network.vpn_connections
WHERE connectionName = '{{ connectionName }}'
AND gatewayName = '{{ gatewayName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';