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

vw_p2s_vpn_gateways

Name	Datatype	Description
id	text	Resource ID.
name	text	Resource name.
custom_dns_servers	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
gatewayName	text	field from the properties object
is_routing_preference_internet	text	field from the properties object
location	text	Resource location.
p2_s_connection_configurations	text	field from the properties object
provisioning_state	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.
virtual_hub	text	field from the properties object
vpn_client_connection_health	text	field from the properties object
vpn_gateway_scale_unit	text	field from the properties object
vpn_server_configuration	text	field from the properties object

p2s_vpn_gateways

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 P2SVpnGateway.
tags	object	Resource tags.
type	string	Resource type.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	gatewayName, resourceGroupName, subscriptionId	Retrieves the details of a virtual wan p2s vpn gateway.
list	SELECT	subscriptionId	Lists all the P2SVpnGateways in a subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Lists all the P2SVpnGateways in a resource group.
create_or_update	INSERT	gatewayName, resourceGroupName, subscriptionId, data__location	Creates a virtual wan p2s vpn gateway if it doesn't exist else updates the existing gateway.
delete	DELETE	gatewayName, resourceGroupName, subscriptionId	Deletes a virtual wan p2s vpn gateway.
disconnect_p2s_vpn_connections	EXEC	p2sVpnGatewayName, resourceGroupName, subscriptionId	Disconnect P2S vpn connections of the virtual wan P2SVpnGateway in the specified resource group.
generate_vpn_profile	EXEC	gatewayName, resourceGroupName, subscriptionId	Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group.
reset	EXEC	gatewayName, resourceGroupName, subscriptionId	Resets the primary of the p2s vpn gateway in the specified resource group.
update_tags	EXEC	gatewayName, resourceGroupName, subscriptionId	Updates virtual wan p2s vpn gateway tags.

SELECT examples

Lists all the P2SVpnGateways in a subscription.

vw_p2s_vpn_gateways

SELECT
id,
name,
custom_dns_servers,
etag,
gatewayName,
is_routing_preference_internet,
location,
p2_s_connection_configurations,
provisioning_state,
resourceGroupName,
subscriptionId,
tags,
type,
virtual_hub,
vpn_client_connection_health,
vpn_gateway_scale_unit,
vpn_server_configuration
FROM azure.network.vw_p2s_vpn_gateways
WHERE subscriptionId = '{{ subscriptionId }}';

p2s_vpn_gateways

SELECT
id,
name,
etag,
location,
properties,
tags,
type
FROM azure.network.p2s_vpn_gateways
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new p2s_vpn_gateways resource.

All Properties

/*+ create */
INSERT INTO azure.network.p2s_vpn_gateways (
gatewayName,
resourceGroupName,
subscriptionId,
data__location,
properties,
id,
location,
tags
)
SELECT 
'{{ gatewayName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__location }}',
'{{ properties }}',
'{{ id }}',
'{{ location }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - 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

DELETE example

Deletes the specified p2s_vpn_gateways resource.

/*+ delete */
DELETE FROM azure.network.p2s_vpn_gateways
WHERE gatewayName = '{{ gatewayName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';