vpn_server_configurations

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

Overview

Name	vpn_server_configurations
Type	Resource
Id	azure.network.vpn_server_configurations

Fields

The following fields are returned by SELECT queries:

get

Request successful. Returns the details of the VpnServerConfiguration 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 P2SVpnServer configuration.
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 vpnServerConfigurations 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 P2SVpnServer configuration.
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 VpnServerConfigurations 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 P2SVpnServer configuration.
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, vpnServerConfigurationName		Retrieves the details of a VpnServerConfiguration.
list_by_resource_group	select	subscriptionId, resourceGroupName		Lists all the vpnServerConfigurations in a resource group.
list	select	subscriptionId		Lists all the VpnServerConfigurations in a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, vpnServerConfigurationName		Creates a VpnServerConfiguration resource if it doesn't exist else updates the existing VpnServerConfiguration.
delete	delete	subscriptionId, resourceGroupName, vpnServerConfigurationName		Deletes a VpnServerConfiguration.
update_tags	exec	subscriptionId, resourceGroupName, vpnServerConfigurationName		Updates VpnServerConfiguration 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 VpnServerConfiguration.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
vpnServerConfigurationName	string	The name of the VpnServerConfiguration being updated.

SELECT examples

get

Retrieves the details of a VpnServerConfiguration.

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

list_by_resource_group

Lists all the vpnServerConfigurations in a resource group.

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

list

Lists all the VpnServerConfigurations in a subscription.

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

INSERT examples

create_or_update

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

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

Manifest

# Description fields are for documentation purposes
- name: vpn_server_configurations
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the vpn_server_configurations resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the vpn_server_configurations resource.
    - name: vpnServerConfigurationName
      value: string
      description: Required parameter for the vpn_server_configurations resource.
    - name: properties
      value: object
      description: |
        Properties of the P2SVpnServer configuration.

DELETE examples

delete

Deletes a VpnServerConfiguration.

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

Lifecycle Methods

update_tags

Updates VpnServerConfiguration tags.

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