p2s_vpn_gateways

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

Overview

Name	p2s_vpn_gateways
Type	Resource
Id	azure.network.p2s_vpn_gateways

Fields

The following fields are returned by SELECT queries:

get

Request successful. Returns the details of the virtual wan p2s 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 P2SVpnGateway.
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 P2SVpnGateways 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 P2SVpnGateway.
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 P2SVpnGateways 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 P2SVpnGateway.
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 p2s vpn gateway.
list_by_resource_group	select	subscriptionId, resourceGroupName		Lists all the P2SVpnGateways in a resource group.
list	select	subscriptionId		Lists all the P2SVpnGateways in a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, gatewayName, data__location		Creates a virtual wan p2s vpn gateway if it doesn't exist else updates the existing gateway.
delete	delete	subscriptionId, resourceGroupName, gatewayName		Deletes a virtual wan p2s vpn gateway.
update_tags	exec	subscriptionId, resourceGroupName, gatewayName		Updates virtual wan p2s vpn gateway tags.
reset	exec	resourceGroupName, gatewayName, subscriptionId		Resets the primary of the p2s vpn gateway in the specified resource group.
generate_vpn_profile	exec	resourceGroupName, gatewayName, subscriptionId		Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group.
disconnect_p2s_vpn_connections	exec	subscriptionId, resourceGroupName, p2sVpnGatewayName		Disconnect P2S vpn connections of the virtual wan P2SVpnGateway 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 P2SVpnGateway.
p2sVpnGatewayName	string	The name of the P2S Vpn Gateway.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Retrieves the details of a virtual wan p2s vpn gateway.

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

list_by_resource_group

Lists all the P2SVpnGateways in a resource group.

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

list

Lists all the P2SVpnGateways in a subscription.

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

INSERT examples

create_or_update

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

INSERT INTO azure.network.p2s_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: p2s_vpn_gateways
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the p2s_vpn_gateways resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the p2s_vpn_gateways resource.
    - name: gatewayName
      value: string
      description: Required parameter for the p2s_vpn_gateways resource.
    - name: properties
      value: object
      description: |
        Properties of the P2SVpnGateway.

DELETE examples

delete

Deletes a virtual wan p2s vpn gateway.

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

Lifecycle Methods

update_tags

Updates virtual wan p2s vpn gateway tags.

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

reset

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

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

generate_vpn_profile

Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group.

EXEC azure.network.p2s_vpn_gateways.generate_vpn_profile 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@gatewayName='{{ gatewayName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"authenticationMethod": "{{ authenticationMethod }}"
}'
;

disconnect_p2s_vpn_connections

Disconnect P2S vpn connections of the virtual wan P2SVpnGateway in the specified resource group.

EXEC azure.network.p2s_vpn_gateways.disconnect_p2s_vpn_connections 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@p2sVpnGatewayName='{{ p2sVpnGatewayName }}' --required 
@@json=
'{
"vpnConnectionIds": "{{ vpnConnectionIds }}"
}'
;