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

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
aadAuthenticationParameters	object	The set of aad vpn authentication parameters.
configurationPolicyGroups	array	List of all VpnServerConfigurationPolicyGroups.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
p2SVpnGateways	array	List of references to P2SVpnGateways.
provisioningState	string	The provisioning state of the VpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
radiusClientRootCertificates	array	Radius client root certificate of VpnServerConfiguration.
radiusServerAddress	string	The radius server address property of the VpnServerConfiguration resource for point to site client connection.
radiusServerRootCertificates	array	Radius Server root certificate of VpnServerConfiguration.
radiusServerSecret	string	The radius secret property of the VpnServerConfiguration resource for point to site client connection. We will no longer return radiusServerSecret in VpnServerConfiguration Create/Update/Get/List/UpdateTags APIs response. Please use VpnServerConfiguration ListRadiusSecrets API to fetch radius server secrets.
radiusServers	array	Multiple Radius Server configuration for VpnServerConfiguration.
tags	object	Resource tags.
type	string	Resource type.
vpnAuthenticationTypes	array	VPN authentication types for the VpnServerConfiguration.
vpnClientIpsecPolicies	array	VpnClientIpsecPolicies for VpnServerConfiguration.
vpnClientRevokedCertificates	array	VPN client revoked certificate of VpnServerConfiguration.
vpnClientRootCertificates	array	VPN client root certificate of VpnServerConfiguration.
vpnProtocols	array	VPN protocols for the VpnServerConfiguration.

list_by_resource_group

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
aadAuthenticationParameters	object	The set of aad vpn authentication parameters.
configurationPolicyGroups	array	List of all VpnServerConfigurationPolicyGroups.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
p2SVpnGateways	array	List of references to P2SVpnGateways.
provisioningState	string	The provisioning state of the VpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
radiusClientRootCertificates	array	Radius client root certificate of VpnServerConfiguration.
radiusServerAddress	string	The radius server address property of the VpnServerConfiguration resource for point to site client connection.
radiusServerRootCertificates	array	Radius Server root certificate of VpnServerConfiguration.
radiusServerSecret	string	The radius secret property of the VpnServerConfiguration resource for point to site client connection. We will no longer return radiusServerSecret in VpnServerConfiguration Create/Update/Get/List/UpdateTags APIs response. Please use VpnServerConfiguration ListRadiusSecrets API to fetch radius server secrets.
radiusServers	array	Multiple Radius Server configuration for VpnServerConfiguration.
tags	object	Resource tags.
type	string	Resource type.
vpnAuthenticationTypes	array	VPN authentication types for the VpnServerConfiguration.
vpnClientIpsecPolicies	array	VpnClientIpsecPolicies for VpnServerConfiguration.
vpnClientRevokedCertificates	array	VPN client revoked certificate of VpnServerConfiguration.
vpnClientRootCertificates	array	VPN client root certificate of VpnServerConfiguration.
vpnProtocols	array	VPN protocols for the VpnServerConfiguration.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
aadAuthenticationParameters	object	The set of aad vpn authentication parameters.
configurationPolicyGroups	array	List of all VpnServerConfigurationPolicyGroups.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
p2SVpnGateways	array	List of references to P2SVpnGateways.
provisioningState	string	The provisioning state of the VpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
radiusClientRootCertificates	array	Radius client root certificate of VpnServerConfiguration.
radiusServerAddress	string	The radius server address property of the VpnServerConfiguration resource for point to site client connection.
radiusServerRootCertificates	array	Radius Server root certificate of VpnServerConfiguration.
radiusServerSecret	string	The radius secret property of the VpnServerConfiguration resource for point to site client connection. We will no longer return radiusServerSecret in VpnServerConfiguration Create/Update/Get/List/UpdateTags APIs response. Please use VpnServerConfiguration ListRadiusSecrets API to fetch radius server secrets.
radiusServers	array	Multiple Radius Server configuration for VpnServerConfiguration.
tags	object	Resource tags.
type	string	Resource type.
vpnAuthenticationTypes	array	VPN authentication types for the VpnServerConfiguration.
vpnClientIpsecPolicies	array	VpnClientIpsecPolicies for VpnServerConfiguration.
vpnClientRevokedCertificates	array	VPN client revoked certificate of VpnServerConfiguration.
vpnClientRootCertificates	array	VPN client root certificate of VpnServerConfiguration.
vpnProtocols	array	VPN protocols for the VpnServerConfiguration.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, vpn_server_configuration_name, subscription_id		Retrieves the details of a VpnServerConfiguration.
list_by_resource_group	select	resource_group_name, subscription_id		Lists all the vpnServerConfigurations in a resource group.
list	select	subscription_id		Lists all the VpnServerConfigurations in a subscription.
create_or_update	insert	resource_group_name, vpn_server_configuration_name, subscription_id		Creates a VpnServerConfiguration resource if it doesn't exist else updates the existing VpnServerConfiguration.
update_tags	update	resource_group_name, vpn_server_configuration_name, subscription_id		Updates VpnServerConfiguration tags.
create_or_update	replace	resource_group_name, vpn_server_configuration_name, subscription_id		Creates a VpnServerConfiguration resource if it doesn't exist else updates the existing VpnServerConfiguration.
delete	delete	resource_group_name, vpn_server_configuration_name, subscription_id		Deletes a VpnServerConfiguration.
list_radius_secrets	exec	resource_group_name, vpn_server_configuration_name, subscription_id		List all Radius servers with respective radius secrets from VpnServerConfiguration.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
vpn_server_configuration_name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource. Required.

SELECT examples

get

Retrieves the details of a VpnServerConfiguration.

SELECT
id,
name,
aadAuthenticationParameters,
configurationPolicyGroups,
etag,
location,
p2SVpnGateways,
provisioningState,
radiusClientRootCertificates,
radiusServerAddress,
radiusServerRootCertificates,
radiusServerSecret,
radiusServers,
tags,
type,
vpnAuthenticationTypes,
vpnClientIpsecPolicies,
vpnClientRevokedCertificates,
vpnClientRootCertificates,
vpnProtocols
FROM azure.network.vpn_server_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vpn_server_configuration_name = '{{ vpn_server_configuration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all the vpnServerConfigurations in a resource group.

SELECT
id,
name,
aadAuthenticationParameters,
configurationPolicyGroups,
etag,
location,
p2SVpnGateways,
provisioningState,
radiusClientRootCertificates,
radiusServerAddress,
radiusServerRootCertificates,
radiusServerSecret,
radiusServers,
tags,
type,
vpnAuthenticationTypes,
vpnClientIpsecPolicies,
vpnClientRevokedCertificates,
vpnClientRootCertificates,
vpnProtocols
FROM azure.network.vpn_server_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all the VpnServerConfigurations in a subscription.

SELECT
id,
name,
aadAuthenticationParameters,
configurationPolicyGroups,
etag,
location,
p2SVpnGateways,
provisioningState,
radiusClientRootCertificates,
radiusServerAddress,
radiusServerRootCertificates,
radiusServerSecret,
radiusServers,
tags,
type,
vpnAuthenticationTypes,
vpnClientIpsecPolicies,
vpnClientRevokedCertificates,
vpnClientRootCertificates,
vpnProtocols
FROM azure.network.vpn_server_configurations
WHERE subscription_id = '{{ subscription_id }}' -- 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 (
id,
name,
location,
tags,
properties,
resource_group_name,
vpn_server_configuration_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ name }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ vpn_server_configuration_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: vpn_server_configurations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the vpn_server_configurations resource.
  - name: vpn_server_configuration_name
    value: "{{ vpn_server_configuration_name }}"
    description: Required parameter for the vpn_server_configurations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the vpn_server_configurations resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: name
    value: "{{ name }}"
    description: |
      Resource name.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    description: |
      Properties of the P2SVpnServer configuration.
    value:
      name: "{{ name }}"
      vpnProtocols:
        - "{{ vpnProtocols }}"
      vpnAuthenticationTypes:
        - "{{ vpnAuthenticationTypes }}"
      vpnClientRootCertificates:
        - name: "{{ name }}"
          publicCertData: "{{ publicCertData }}"
      vpnClientRevokedCertificates:
        - name: "{{ name }}"
          thumbprint: "{{ thumbprint }}"
      radiusServerRootCertificates:
        - name: "{{ name }}"
          publicCertData: "{{ publicCertData }}"
      radiusClientRootCertificates:
        - name: "{{ name }}"
          thumbprint: "{{ thumbprint }}"
      vpnClientIpsecPolicies:
        - saLifeTimeSeconds: {{ saLifeTimeSeconds }}
          saDataSizeKilobytes: {{ saDataSizeKilobytes }}
          ipsecEncryption: "{{ ipsecEncryption }}"
          ipsecIntegrity: "{{ ipsecIntegrity }}"
          ikeEncryption: "{{ ikeEncryption }}"
          ikeIntegrity: "{{ ikeIntegrity }}"
          dhGroup: "{{ dhGroup }}"
          pfsGroup: "{{ pfsGroup }}"
      radiusServerAddress: "{{ radiusServerAddress }}"
      radiusServerSecret: "{{ radiusServerSecret }}"
      radiusServers:
        - radiusServerAddress: "{{ radiusServerAddress }}"
          radiusServerScore: {{ radiusServerScore }}
          radiusServerSecret: "{{ radiusServerSecret }}"
      aadAuthenticationParameters:
        aadTenant: "{{ aadTenant }}"
        aadAudience: "{{ aadAudience }}"
        aadIssuer: "{{ aadIssuer }}"
      provisioningState: "{{ provisioningState }}"
      p2SVpnGateways:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          location: "{{ location }}"
          tags: "{{ tags }}"
          properties:
            virtualHub:
              id: "{{ id }}"
            p2SConnectionConfigurations:
              - id: "{{ id }}"
                properties:
                  vpnClientAddressPool: "{{ vpnClientAddressPool }}"
                  routingConfiguration: "{{ routingConfiguration }}"
                  enableInternetSecurity: {{ enableInternetSecurity }}
                  configurationPolicyGroupAssociations: "{{ configurationPolicyGroupAssociations }}"
                  previousConfigurationPolicyGroupAssociations: "{{ previousConfigurationPolicyGroupAssociations }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
            provisioningState: "{{ provisioningState }}"
            vpnGatewayScaleUnit: {{ vpnGatewayScaleUnit }}
            vpnServerConfiguration:
              id: "{{ id }}"
            vpnClientConnectionHealth:
              totalIngressBytesTransferred: {{ totalIngressBytesTransferred }}
              totalEgressBytesTransferred: {{ totalEgressBytesTransferred }}
              vpnClientConnectionsCount: {{ vpnClientConnectionsCount }}
              allocatedIpAddresses:
                - "{{ allocatedIpAddresses }}"
            customDnsServers:
              - "{{ customDnsServers }}"
            isRoutingPreferenceInternet: {{ isRoutingPreferenceInternet }}
          etag: "{{ etag }}"
      configurationPolicyGroups:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            isDefault: {{ isDefault }}
            priority: {{ priority }}
            policyMembers:
              - name: "{{ name }}"
                attributeType: "{{ attributeType }}"
                attributeValue: "{{ attributeValue }}"
            p2SConnectionConfigurations:
              - id: "{{ id }}"
            provisioningState: "{{ provisioningState }}"
          etag: "{{ etag }}"
      etag: "{{ etag }}"

UPDATE examples

update_tags

Updates VpnServerConfiguration tags.

UPDATE azure.network.vpn_server_configurations
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND vpn_server_configuration_name = '{{ vpn_server_configuration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

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

REPLACE azure.network.vpn_server_configurations
SET 
id = '{{ id }}',
name = '{{ name }}',
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND vpn_server_configuration_name = '{{ vpn_server_configuration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes a VpnServerConfiguration.

DELETE FROM azure.network.vpn_server_configurations
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND vpn_server_configuration_name = '{{ vpn_server_configuration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_radius_secrets

List all Radius servers with respective radius secrets from VpnServerConfiguration.

EXEC azure.network.vpn_server_configurations.list_radius_secrets 
@resource_group_name='{{ resource_group_name }}' --required, 
@vpn_server_configuration_name='{{ vpn_server_configuration_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;