vpn_sites

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

Overview

Name	vpn_sites
Type	Resource
Id	azure.network.vpn_sites

Fields

The following fields are returned by SELECT queries:

get

Request successful. Returns the details of the VpnSite 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 site.
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 vpnSites 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 site.
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 VpnSites 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 site.
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, vpnSiteName		Retrieves the details of a VPN site.
list_by_resource_group	select	subscriptionId, resourceGroupName		Lists all the vpnSites in a resource group.
list	select	subscriptionId		Lists all the VpnSites in a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, vpnSiteName, data__location		Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.
delete	delete	subscriptionId, resourceGroupName, vpnSiteName		Deletes a VpnSite.
update_tags	exec	subscriptionId, resourceGroupName, vpnSiteName		Updates VpnSite tags.

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
resourceGroupName	string	The resource group name of the VpnSite.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
vpnSiteName	string	The name of the VpnSite being updated.

SELECT examples

get

Retrieves the details of a VPN site.

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

list_by_resource_group

Lists all the vpnSites in a resource group.

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

list

Lists all the VpnSites in a subscription.

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

INSERT examples

create_or_update

Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.

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

Manifest

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

DELETE examples

delete

Deletes a VpnSite.

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

Lifecycle Methods

update_tags

Updates VpnSite tags.

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