virtual_network_gateways

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

Overview

Name	virtual_network_gateways
Type	Resource
Id	azure.network.virtual_network_gateways

Fields

vw_virtual_network_gateways

Name	Datatype	Description
id	text	Resource ID.
name	text	Resource name.
active_active	text	field from the properties object
admin_state	text	field from the properties object
allow_remote_vnet_traffic	text	field from the properties object
allow_virtual_wan_traffic	text	field from the properties object
auto_scale_configuration	text	field from the properties object
bgp_settings	text	field from the properties object
custom_routes	text	field from the properties object
disable_ip_sec_replay_protection	text	field from the properties object
enable_bgp	text	field from the properties object
enable_bgp_route_translation_for_nat	text	field from the properties object
enable_dns_forwarding	text	field from the properties object
enable_private_ip_address	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
extended_location	text	field from the properties object
gateway_default_site	text	field from the properties object
gateway_type	text	field from the properties object
identity	text	Identity for the resource.
inbound_dns_forwarding_endpoint	text	field from the properties object
ip_configurations	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
resiliency_model	text	field from the properties object
resourceGroupName	text	field from the properties object
resource_guid	text	field from the properties object
sku	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
type	text	Resource type.
virtualNetworkGatewayName	text	field from the properties object
virtual_network_gateway_policy_groups	text	field from the properties object
vnet_extended_location_resource_id	text	field from the properties object
vpn_client_configuration	text	field from the properties object
vpn_gateway_generation	text	field from the properties object
vpn_type	text	field from the properties object

virtual_network_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.
extendedLocation	object	ExtendedLocation complex type.
identity	object	Identity for the resource.
location	string	Resource location.
properties	object	VirtualNetworkGateway properties.
tags	object	Resource tags.
type	string	Resource type.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, subscriptionId, virtualNetworkGatewayName	Gets the specified virtual network gateway by resource group.
list	SELECT	resourceGroupName, subscriptionId	Gets all virtual network gateways by resource group.
create_or_update	INSERT	resourceGroupName, subscriptionId, virtualNetworkGatewayName, data__properties	Creates or updates a virtual network gateway in the specified resource group.
delete	DELETE	resourceGroupName, subscriptionId, virtualNetworkGatewayName	Deletes the specified virtual network gateway.
disconnect_virtual_network_gateway_vpn_connections	EXEC	resourceGroupName, subscriptionId, virtualNetworkGatewayName	Disconnect vpn connections of virtual network gateway in the specified resource group.
generate_vpn_profile	EXEC	resourceGroupName, subscriptionId, virtualNetworkGatewayName	Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.
generatevpnclientpackage	EXEC	resourceGroupName, subscriptionId, virtualNetworkGatewayName	Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.
reset	EXEC	resourceGroupName, subscriptionId, virtualNetworkGatewayName	Resets the primary of the virtual network gateway in the specified resource group.
reset_vpn_client_shared_key	EXEC	resourceGroupName, subscriptionId, virtualNetworkGatewayName	Resets the VPN client shared key of the virtual network gateway in the specified resource group.
set_vpnclient_ipsec_parameters	EXEC	resourceGroupName, subscriptionId, virtualNetworkGatewayName, data__dhGroup, data__ikeEncryption, data__ikeIntegrity, data__ipsecEncryption, data__ipsecIntegrity, data__pfsGroup, data__saDataSizeKilobytes, data__saLifeTimeSeconds	The Set VpnclientIpsecParameters operation sets the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.
start_packet_capture	EXEC	resourceGroupName, subscriptionId, virtualNetworkGatewayName	Starts packet capture on virtual network gateway in the specified resource group.
stop_packet_capture	EXEC	resourceGroupName, subscriptionId, virtualNetworkGatewayName	Stops packet capture on virtual network gateway in the specified resource group.
supported_vpn_devices	EXEC	resourceGroupName, subscriptionId, virtualNetworkGatewayName	Gets a xml format representation for supported vpn devices.
update_tags	EXEC	resourceGroupName, subscriptionId, virtualNetworkGatewayName	Updates a virtual network gateway tags.
vpn_device_configuration_script	EXEC	resourceGroupName, subscriptionId, virtualNetworkGatewayConnectionName	Gets a xml format representation for vpn device configuration script.

SELECT examples

Gets all virtual network gateways by resource group.

vw_virtual_network_gateways

SELECT
id,
name,
active_active,
admin_state,
allow_remote_vnet_traffic,
allow_virtual_wan_traffic,
auto_scale_configuration,
bgp_settings,
custom_routes,
disable_ip_sec_replay_protection,
enable_bgp,
enable_bgp_route_translation_for_nat,
enable_dns_forwarding,
enable_private_ip_address,
etag,
extended_location,
gateway_default_site,
gateway_type,
identity,
inbound_dns_forwarding_endpoint,
ip_configurations,
location,
nat_rules,
provisioning_state,
resiliency_model,
resourceGroupName,
resource_guid,
sku,
subscriptionId,
tags,
type,
virtualNetworkGatewayName,
virtual_network_gateway_policy_groups,
vnet_extended_location_resource_id,
vpn_client_configuration,
vpn_gateway_generation,
vpn_type
FROM azure.network.vw_virtual_network_gateways
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

virtual_network_gateways

SELECT
id,
name,
etag,
extendedLocation,
identity,
location,
properties,
tags,
type
FROM azure.network.virtual_network_gateways
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.network.virtual_network_gateways (
resourceGroupName,
subscriptionId,
virtualNetworkGatewayName,
data__properties,
properties,
extendedLocation,
identity,
id,
location,
tags
)
SELECT 
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ virtualNetworkGatewayName }}',
'{{ data__properties }}',
'{{ properties }}',
'{{ extendedLocation }}',
'{{ identity }}',
'{{ id }}',
'{{ location }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: autoScaleConfiguration
          value:
            - name: bounds
              value:
                - name: min
                  value: integer
                - name: max
                  value: integer
        - name: ipConfigurations
          value:
            - - name: properties
                value:
                  - name: privateIPAllocationMethod
                    value: []
                  - name: subnet
                    value:
                      - name: id
                        value: string
                  - name: privateIPAddress
                    value: string
                  - name: provisioningState
                    value: []
              - name: name
                value: string
              - name: etag
                value: string
              - name: id
                value: string
        - name: gatewayType
          value: string
        - name: vpnType
          value: string
        - name: vpnGatewayGeneration
          value: string
        - name: enableBgp
          value: boolean
        - name: enablePrivateIpAddress
          value: boolean
        - name: activeActive
          value: boolean
        - name: disableIPSecReplayProtection
          value: boolean
        - name: sku
          value:
            - name: name
              value: string
            - name: tier
              value: string
            - name: capacity
              value: integer
        - name: vpnClientConfiguration
          value:
            - name: vpnClientAddressPool
              value:
                - name: addressPrefixes
                  value:
                    - string
            - name: vpnClientRootCertificates
              value:
                - - name: properties
                    value:
                      - name: publicCertData
                        value: string
                  - name: name
                    value: string
                  - name: etag
                    value: string
                  - name: id
                    value: string
            - name: vpnClientRevokedCertificates
              value:
                - - name: properties
                    value:
                      - name: thumbprint
                        value: string
                  - name: name
                    value: string
                  - name: etag
                    value: string
                  - name: id
                    value: string
            - name: vpnClientProtocols
              value:
                - string
            - name: vpnAuthenticationTypes
              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: aadTenant
              value: string
            - name: aadAudience
              value: string
            - name: aadIssuer
              value: string
            - name: vngClientConnectionConfigurations
              value:
                - - name: properties
                    value:
                      - name: virtualNetworkGatewayPolicyGroups
                        value:
                          - - name: id
                              value: string
                  - name: name
                    value: string
                  - name: etag
                    value: string
                  - name: id
                    value: string
        - name: virtualNetworkGatewayPolicyGroups
          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: vngClientConnectionConfigurations
                    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: resourceGuid
          value: string
        - name: enableDnsForwarding
          value: boolean
        - name: inboundDnsForwardingEndpoint
          value: string
        - name: vNetExtendedLocationResourceId
          value: string
        - 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: name
                value: string
              - name: etag
                value: string
              - name: type
                value: string
              - name: id
                value: string
        - name: enableBgpRouteTranslationForNat
          value: boolean
        - name: allowVirtualWanTraffic
          value: boolean
        - name: allowRemoteVnetTraffic
          value: boolean
        - name: adminState
          value: string
        - name: resiliencyModel
          value: string
    - name: extendedLocation
      value:
        - name: name
          value: string
        - name: type
          value: []
    - name: etag
      value: string
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: string
        - name: userAssignedIdentities
          value: object
    - 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 virtual_network_gateways resource.

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