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
- vw_vpn_server_configurations
- vpn_server_configurations
| Name | Datatype | Description |
|---|---|---|
id | text | Resource ID. |
name | text | Resource name. |
aad_authentication_parameters | text | field from the properties object |
configuration_policy_groups | text | field from the properties object |
etag | text | A unique read-only string that changes whenever the resource is updated. |
location | text | Resource location. |
p2_s_vpn_gateways | text | field from the properties object |
provisioning_state | text | field from the properties object |
radius_client_root_certificates | text | field from the properties object |
radius_server_address | text | field from the properties object |
radius_server_root_certificates | text | field from the properties object |
radius_server_secret | text | field from the properties object |
radius_servers | text | field from the properties object |
resourceGroupName | text | field from the properties object |
subscriptionId | text | field from the properties object |
tags | text | Resource tags. |
type | text | Resource type. |
vpnServerConfigurationName | text | field from the properties object |
vpn_authentication_types | text | field from the properties object |
vpn_client_ipsec_policies | text | field from the properties object |
vpn_client_revoked_certificates | text | field from the properties object |
vpn_client_root_certificates | text | field from the properties object |
vpn_protocols | text | field from the properties object |
| Name | Datatype | Description |
|---|---|---|
id | string | Resource ID. |
name | string | Resource name. |
etag | string | A unique read-only string that changes whenever the resource is updated. |
location | string | Resource location. |
properties | object | Parameters for VpnServerConfiguration. |
tags | object | Resource tags. |
type | string | Resource type. |
Methods
| Name | Accessible by | Required Params | Description |
|---|---|---|---|
get | SELECT | resourceGroupName, subscriptionId, vpnServerConfigurationName | Retrieves the details of a VpnServerConfiguration. |
list | SELECT | subscriptionId | Lists all the VpnServerConfigurations in a subscription. |
list_by_resource_group | SELECT | resourceGroupName, subscriptionId | Lists all the vpnServerConfigurations in a resource group. |
create_or_update | INSERT | resourceGroupName, subscriptionId, vpnServerConfigurationName | Creates a VpnServerConfiguration resource if it doesn't exist else updates the existing VpnServerConfiguration. |
delete | DELETE | resourceGroupName, subscriptionId, vpnServerConfigurationName | Deletes a VpnServerConfiguration. |
update_tags | EXEC | resourceGroupName, subscriptionId, vpnServerConfigurationName | Updates VpnServerConfiguration tags. |
SELECT examples
Lists all the VpnServerConfigurations in a subscription.
- vw_vpn_server_configurations
- vpn_server_configurations
SELECT
id,
name,
aad_authentication_parameters,
configuration_policy_groups,
etag,
location,
p2_s_vpn_gateways,
provisioning_state,
radius_client_root_certificates,
radius_server_address,
radius_server_root_certificates,
radius_server_secret,
radius_servers,
resourceGroupName,
subscriptionId,
tags,
type,
vpnServerConfigurationName,
vpn_authentication_types,
vpn_client_ipsec_policies,
vpn_client_revoked_certificates,
vpn_client_root_certificates,
vpn_protocols
FROM azure.network.vw_vpn_server_configurations
WHERE subscriptionId = '{{ subscriptionId }}';
SELECT
id,
name,
etag,
location,
properties,
tags,
type
FROM azure.network.vpn_server_configurations
WHERE subscriptionId = '{{ subscriptionId }}';
INSERT example
Use the following StackQL query and manifest file to create a new vpn_server_configurations resource.
- All Properties
- Manifest
/*+ create */
INSERT INTO azure.network.vpn_server_configurations (
resourceGroupName,
subscriptionId,
vpnServerConfigurationName,
properties,
id,
location,
tags
)
SELECT
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ vpnServerConfigurationName }}',
'{{ properties }}',
'{{ id }}',
'{{ location }}',
'{{ tags }}'
;
- name: your_resource_model_name
props:
- name: properties
value:
- name: name
value: string
- name: vpnProtocols
value:
- string
- name: vpnAuthenticationTypes
value:
- string
- name: vpnClientRootCertificates
value:
- - name: name
value: string
- name: publicCertData
value: string
- name: vpnClientRevokedCertificates
value:
- - name: name
value: string
- name: thumbprint
value: string
- name: radiusServerRootCertificates
value:
- - name: name
value: string
- name: publicCertData
value: string
- name: radiusClientRootCertificates
value:
- - name: name
value: string
- name: thumbprint
value: string
- name: vpnClientIpsecPolicies
value:
- - name: saLifeTimeSeconds
value: integer
- name: saDataSizeKilobytes
value: integer
- name: ipsecEncryption
value: []
- name: ipsecIntegrity
value: []
- name: ikeEncryption
value: []
- name: ikeIntegrity
value: []
- name: dhGroup
value: []
- name: pfsGroup
value: []
- name: radiusServerAddress
value: string
- name: radiusServerSecret
value: string
- name: radiusServers
value:
- - name: radiusServerAddress
value: string
- name: radiusServerScore
value: integer
- name: radiusServerSecret
value: string
- name: aadAuthenticationParameters
value:
- name: aadTenant
value: string
- name: aadAudience
value: string
- name: aadIssuer
value: string
- name: provisioningState
value: string
- name: p2SVpnGateways
value:
- - name: properties
value:
- name: virtualHub
value:
- name: id
value: string
- name: p2SConnectionConfigurations
value:
- - name: properties
value:
- name: vpnClientAddressPool
value:
- name: addressPrefixes
value:
- string
- name: routingConfiguration
value:
- name: propagatedRouteTables
value:
- name: labels
value:
- string
- name: ids
value:
- - name: id
value: string
- name: vnetRoutes
value:
- name: staticRoutesConfig
value:
- name: propagateStaticRoutes
value: boolean
- name: vnetLocalRouteOverrideCriteria
value: []
- name: staticRoutes
value:
- - name: name
value: string
- name: addressPrefixes
value:
- string
- name: nextHopIpAddress
value: string
- name: bgpConnections
value:
- - name: id
value: string
- name: enableInternetSecurity
value: boolean
- name: configurationPolicyGroupAssociations
value:
- - name: id
value: string
- name: previousConfigurationPolicyGroupAssociations
value:
- - name: properties
value:
- name: isDefault
value: boolean
- name: priority
value: integer
- name: policyMembers
value:
- - name: name
value: string
- name: attributeType
value: string
- name: attributeValue
value: string
- name: p2SConnectionConfigurations
value:
- - name: id
value: string
- name: provisioningState
value: []
- name: etag
value: string
- name: name
value: string
- name: type
value: string
- name: id
value: string
- name: name
value: string
- name: etag
value: string
- name: id
value: string
- name: vpnGatewayScaleUnit
value: integer
- name: vpnClientConnectionHealth
value:
- name: totalIngressBytesTransferred
value: integer
- name: totalEgressBytesTransferred
value: integer
- name: vpnClientConnectionsCount
value: integer
- name: allocatedIpAddresses
value:
- string
- name: customDnsServers
value:
- string
- name: isRoutingPreferenceInternet
value: boolean
- name: etag
value: string
- name: id
value: string
- name: name
value: string
- name: type
value: string
- name: location
value: string
- name: tags
value: object
- name: configurationPolicyGroups
value:
- - name: etag
value: string
- name: name
value: string
- name: type
value: string
- name: id
value: string
- name: etag
value: string
- name: name
value: string
- name: etag
value: string
- name: id
value: string
- name: type
value: string
- name: location
value: string
- name: tags
value: object
DELETE example
Deletes the specified vpn_server_configurations resource.
/*+ delete */
DELETE FROM azure.network.vpn_server_configurations
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND vpnServerConfigurationName = '{{ vpnServerConfigurationName }}';