vpn_gateways

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

Overview

Name	vpn_gateways
Type	Resource
Id	azure.network.vpn_gateways

Fields

vw_vpn_gateways

Name	Datatype	Description
id	text	Resource ID.
name	text	Resource name.
bgp_settings	text	field from the properties object
connections	text	field from the properties object
enable_bgp_route_translation_for_nat	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
ip_configurations	text	field from the properties object
is_routing_preference_internet	text	field from the properties object
location	text	Resource location.
nat_rules	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_gateway_scale_unit	text	field from the properties object

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 VpnGateway.
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 vpn gateway.
list	SELECT	subscriptionId	Lists all the VpnGateways in a subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Lists all the VpnGateways in a resource group.
create_or_update	INSERT	gatewayName, resourceGroupName, subscriptionId, data__location	Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.
delete	DELETE	gatewayName, resourceGroupName, subscriptionId	Deletes a virtual wan vpn gateway.
reset	EXEC	gatewayName, resourceGroupName, subscriptionId	Resets the primary of the vpn gateway in the specified resource group.
start_packet_capture	EXEC	gatewayName, resourceGroupName, subscriptionId	Starts packet capture on vpn gateway in the specified resource group.
stop_packet_capture	EXEC	gatewayName, resourceGroupName, subscriptionId	Stops packet capture on vpn gateway in the specified resource group.
update_tags	EXEC	gatewayName, resourceGroupName, subscriptionId	Updates virtual wan vpn gateway tags.

SELECT examples

Lists all the VpnGateways in a subscription.

vw_vpn_gateways

SELECT
id,
name,
bgp_settings,
connections,
enable_bgp_route_translation_for_nat,
etag,
gatewayName,
ip_configurations,
is_routing_preference_internet,
location,
nat_rules,
provisioning_state,
resourceGroupName,
subscriptionId,
tags,
type,
virtual_hub,
vpn_gateway_scale_unit
FROM azure.network.vw_vpn_gateways
WHERE subscriptionId = '{{ subscriptionId }}';

vpn_gateways

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.network.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: connections
          value:
            - - name: properties
                value:
                  - name: routingWeight
                    value: integer
                  - name: dpdTimeoutSeconds
                    value: integer
                  - name: connectionStatus
                    value: []
                  - name: vpnConnectionProtocolType
                    value: []
                  - name: ingressBytesTransferred
                    value: integer
                  - name: egressBytesTransferred
                    value: integer
                  - name: connectionBandwidth
                    value: integer
                  - name: sharedKey
                    value: string
                  - name: enableBgp
                    value: boolean
                  - name: usePolicyBasedTrafficSelectors
                    value: boolean
                  - name: ipsecPolicies
                    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: trafficSelectorPolicies
                    value:
                      - - name: localAddressRanges
                          value:
                            - string
                        - name: remoteAddressRanges
                          value:
                            - string
                  - name: enableRateLimiting
                    value: boolean
                  - name: enableInternetSecurity
                    value: boolean
                  - name: useLocalAzureIpAddress
                    value: boolean
                  - name: provisioningState
                    value: []
                  - name: vpnLinkConnections
                    value:
                      - - name: properties
                          value:
                            - name: routingWeight
                              value: integer
                            - name: vpnLinkConnectionMode
                              value: string
                            - name: ingressBytesTransferred
                              value: integer
                            - name: egressBytesTransferred
                              value: integer
                            - name: connectionBandwidth
                              value: integer
                            - name: sharedKey
                              value: string
                            - name: enableBgp
                              value: boolean
                            - name: vpnGatewayCustomBgpAddresses
                              value:
                                - - name: ipConfigurationId
                                    value: string
                                  - name: customBgpIpAddress
                                    value: string
                            - name: usePolicyBasedTrafficSelectors
                              value: boolean
                            - name: ipsecPolicies
                              value:
                                - - name: saLifeTimeSeconds
                                    value: integer
                                  - name: saDataSizeKilobytes
                                    value: integer
                            - name: enableRateLimiting
                              value: boolean
                            - name: useLocalAzureIpAddress
                              value: boolean
                            - name: ingressNatRules
                              value:
                                - - name: id
                                    value: string
                            - name: egressNatRules
                              value:
                                - - name: id
                                    value: string
                            - name: dpdTimeoutSeconds
                              value: integer
                        - name: name
                          value: string
                        - name: etag
                          value: string
                        - name: type
                          value: string
                        - name: id
                          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: name
                value: string
              - name: etag
                value: string
              - name: id
                value: string
        - name: bgpSettings
          value:
            - name: asn
              value: integer
            - name: bgpPeeringAddress
              value: string
            - name: peerWeight
              value: integer
            - name: bgpPeeringAddresses
              value:
                - - name: ipconfigurationId
                    value: string
                  - name: defaultBgpIpAddresses
                    value:
                      - string
                  - name: customBgpIpAddresses
                    value:
                      - string
                  - name: tunnelIpAddresses
                    value:
                      - string
        - name: vpnGatewayScaleUnit
          value: integer
        - name: ipConfigurations
          value:
            - - name: id
                value: string
              - name: publicIpAddress
                value: string
              - name: privateIpAddress
                value: string
        - name: enableBgpRouteTranslationForNat
          value: boolean
        - name: isRoutingPreferenceInternet
          value: boolean
        - name: natRules
          value:
            - - name: properties
                value:
                  - name: type
                    value: string
                  - name: mode
                    value: string
                  - name: internalMappings
                    value:
                      - - name: addressSpace
                          value: string
                        - name: portRange
                          value: string
                  - name: externalMappings
                    value:
                      - - name: addressSpace
                          value: string
                        - name: portRange
                          value: string
                  - name: ipConfigurationId
                    value: string
                  - name: egressVpnSiteLinkConnections
                    value:
                      - - name: id
                          value: string
                  - name: ingressVpnSiteLinkConnections
                    value:
                      - - name: id
                          value: string
              - name: name
                value: string
              - name: etag
                value: string
              - name: type
                value: string
              - name: id
                value: string
    - 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 vpn_gateways resource.

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