vpn_gateways

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

Overview

Name	vpn_gateways
Type	Resource
Id	azure.network.vpn_gateways

Fields

The following fields are returned by SELECT queries:

get

Request successful. Returns the details of the virtual wan vpn gateway retrieved.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the VPN gateway.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_resource_group

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

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the VPN gateway.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

Request successful. Returns the details of all the VpnGateways in the subscription.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the VPN gateway.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, gatewayName		Retrieves the details of a virtual wan vpn gateway.
list_by_resource_group	select	subscriptionId, resourceGroupName		Lists all the VpnGateways in a resource group.
list	select	subscriptionId		Lists all the VpnGateways in a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, gatewayName, data__location		Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.
delete	delete	subscriptionId, resourceGroupName, gatewayName		Deletes a virtual wan vpn gateway.
update_tags	exec	subscriptionId, resourceGroupName, gatewayName		Updates virtual wan vpn gateway tags.
reset	exec	resourceGroupName, gatewayName, subscriptionId	ipConfigurationId	Resets the primary of the vpn gateway in the specified resource group.
start_packet_capture	exec	resourceGroupName, gatewayName, subscriptionId		Starts packet capture on vpn gateway in the specified resource group.
stop_packet_capture	exec	resourceGroupName, gatewayName, subscriptionId		Stops packet capture on vpn gateway in the specified resource group.

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
gatewayName	string	The name of the gateway.
resourceGroupName	string	The resource group name of the VpnGateway.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
ipConfigurationId	string	VpnGateway ipConfigurationId to specify the gateway instance.

SELECT examples

get

Retrieves the details of a virtual wan vpn gateway.

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

list_by_resource_group

Lists all the VpnGateways in a resource group.

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

list

Lists all the VpnGateways in a subscription.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.vpn_gateways
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.

INSERT INTO azure.network.vpn_gateways (
data__properties,
subscriptionId,
resourceGroupName,
gatewayName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ gatewayName }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: vpn_gateways
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the vpn_gateways resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the vpn_gateways resource.
    - name: gatewayName
      value: string
      description: Required parameter for the vpn_gateways resource.
    - name: properties
      value: object
      description: |
        Properties of the VPN gateway.

DELETE examples

delete

Deletes a virtual wan vpn gateway.

DELETE FROM azure.network.vpn_gateways
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND gatewayName = '{{ gatewayName }}' --required
;

Lifecycle Methods

update_tags

Updates virtual wan vpn gateway tags.

EXEC azure.network.vpn_gateways.update_tags 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@gatewayName='{{ gatewayName }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;

reset

Resets the primary of the vpn gateway in the specified resource group.

EXEC azure.network.vpn_gateways.reset 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@gatewayName='{{ gatewayName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@ipConfigurationId='{{ ipConfigurationId }}'
;

start_packet_capture

Starts packet capture on vpn gateway in the specified resource group.

EXEC azure.network.vpn_gateways.start_packet_capture 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@gatewayName='{{ gatewayName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"filterData": "{{ filterData }}"
}'
;

stop_packet_capture

Stops packet capture on vpn gateway in the specified resource group.

EXEC azure.network.vpn_gateways.stop_packet_capture 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@gatewayName='{{ gatewayName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"sasUrl": "{{ sasUrl }}"
}'
;