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

The following fields are returned by SELECT queries:

get

Request successful. The operation returns a VirtualNetworkGateway resource.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of type local virtual network gateway.
identity	object	The identity of the virtual network gateway, if configured.
properties	object	Properties of the virtual network gateway.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

Request successful. The operation returns a list of VirtualNetworkGateway resources.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of type local virtual network gateway.
identity	object	The identity of the virtual network gateway, if configured.
properties	object	Properties of the virtual network gateway.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, virtualNetworkGatewayName, subscriptionId		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, virtualNetworkGatewayName, subscriptionId, data__properties		Creates or updates a virtual network gateway in the specified resource group.
delete	delete	resourceGroupName, virtualNetworkGatewayName, subscriptionId		Deletes the specified virtual network gateway.
update_tags	exec	resourceGroupName, virtualNetworkGatewayName, subscriptionId		Updates a virtual network gateway tags.
reset	exec	resourceGroupName, virtualNetworkGatewayName, subscriptionId	gatewayVip	Resets the primary of the virtual network gateway in the specified resource group.
reset_vpn_client_shared_key	exec	resourceGroupName, virtualNetworkGatewayName, subscriptionId		Resets the VPN client shared key of the virtual network gateway in the specified resource group.
generatevpnclientpackage	exec	resourceGroupName, virtualNetworkGatewayName, subscriptionId		Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.
generate_vpn_profile	exec	resourceGroupName, virtualNetworkGatewayName, subscriptionId		Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.
supported_vpn_devices	exec	resourceGroupName, virtualNetworkGatewayName, subscriptionId		Gets a xml format representation for supported vpn devices.
set_vpnclient_ipsec_parameters	exec	resourceGroupName, virtualNetworkGatewayName, subscriptionId, saLifeTimeSeconds, saDataSizeKilobytes, ipsecEncryption, ipsecIntegrity, ikeEncryption, ikeIntegrity, dhGroup, pfsGroup		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.
vpn_device_configuration_script	exec	resourceGroupName, virtualNetworkGatewayConnectionName, subscriptionId		Gets a xml format representation for vpn device configuration script.
start_packet_capture	exec	resourceGroupName, virtualNetworkGatewayName, subscriptionId		Starts packet capture on virtual network gateway in the specified resource group.
stop_packet_capture	exec	resourceGroupName, virtualNetworkGatewayName, subscriptionId		Stops packet capture on virtual network gateway in the specified resource group.
disconnect_virtual_network_gateway_vpn_connections	exec	subscriptionId, resourceGroupName, virtualNetworkGatewayName		Disconnect vpn connections of virtual network gateway in the specified resource group.

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
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
virtualNetworkGatewayConnectionName	string	The name of the virtual network gateway connection for which the configuration script is generated.
virtualNetworkGatewayName	string	The name of the virtual network gateway.
gatewayVip	string	Virtual network gateway vip address supplied to the begin reset of the active-active feature enabled gateway.

SELECT examples

get

Gets the specified virtual network gateway by resource group.

SELECT
id,
name,
etag,
extendedLocation,
identity,
properties,
systemData,
type
FROM azure.network.virtual_network_gateways
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualNetworkGatewayName = '{{ virtualNetworkGatewayName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Gets all virtual network gateways by resource group.

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

INSERT examples

create_or_update

Creates or updates a virtual network gateway in the specified resource group.

INSERT INTO azure.network.virtual_network_gateways (
data__properties,
data__extendedLocation,
data__identity,
resourceGroupName,
virtualNetworkGatewayName,
subscriptionId
)
SELECT 
'{{ properties }}' /* required */,
'{{ extendedLocation }}',
'{{ identity }}',
'{{ resourceGroupName }}',
'{{ virtualNetworkGatewayName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
extendedLocation,
identity,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_network_gateways
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the virtual_network_gateways resource.
    - name: virtualNetworkGatewayName
      value: string
      description: Required parameter for the virtual_network_gateways resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the virtual_network_gateways resource.
    - name: properties
      value: object
      description: |
        Properties of the virtual network gateway.
    - name: extendedLocation
      value: object
      description: |
        The extended location of type local virtual network gateway.
    - name: identity
      value: object
      description: |
        The identity of the virtual network gateway, if configured.

DELETE examples

delete

Deletes the specified virtual network gateway.

DELETE FROM azure.network.virtual_network_gateways
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND virtualNetworkGatewayName = '{{ virtualNetworkGatewayName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

update_tags

Updates a virtual network gateway tags.

EXEC azure.network.virtual_network_gateways.update_tags 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@virtualNetworkGatewayName='{{ virtualNetworkGatewayName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;

reset

Resets the primary of the virtual network gateway in the specified resource group.

EXEC azure.network.virtual_network_gateways.reset 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@virtualNetworkGatewayName='{{ virtualNetworkGatewayName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@gatewayVip='{{ gatewayVip }}'
;

reset_vpn_client_shared_key

Resets the VPN client shared key of the virtual network gateway in the specified resource group.

EXEC azure.network.virtual_network_gateways.reset_vpn_client_shared_key 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@virtualNetworkGatewayName='{{ virtualNetworkGatewayName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

generatevpnclientpackage

Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.

EXEC azure.network.virtual_network_gateways.generatevpnclientpackage 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@virtualNetworkGatewayName='{{ virtualNetworkGatewayName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"processorArchitecture": "{{ processorArchitecture }}", 
"authenticationMethod": "{{ authenticationMethod }}", 
"radiusServerAuthCertificate": "{{ radiusServerAuthCertificate }}", 
"clientRootCertificates": "{{ clientRootCertificates }}"
}'
;

generate_vpn_profile

Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.

EXEC azure.network.virtual_network_gateways.generate_vpn_profile 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@virtualNetworkGatewayName='{{ virtualNetworkGatewayName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"processorArchitecture": "{{ processorArchitecture }}", 
"authenticationMethod": "{{ authenticationMethod }}", 
"radiusServerAuthCertificate": "{{ radiusServerAuthCertificate }}", 
"clientRootCertificates": "{{ clientRootCertificates }}"
}'
;

supported_vpn_devices

Gets a xml format representation for supported vpn devices.

EXEC azure.network.virtual_network_gateways.supported_vpn_devices 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@virtualNetworkGatewayName='{{ virtualNetworkGatewayName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

set_vpnclient_ipsec_parameters

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.

EXEC azure.network.virtual_network_gateways.set_vpnclient_ipsec_parameters 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@virtualNetworkGatewayName='{{ virtualNetworkGatewayName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"saLifeTimeSeconds": {{ saLifeTimeSeconds }}, 
"saDataSizeKilobytes": {{ saDataSizeKilobytes }}, 
"ipsecEncryption": "{{ ipsecEncryption }}", 
"ipsecIntegrity": "{{ ipsecIntegrity }}", 
"ikeEncryption": "{{ ikeEncryption }}", 
"ikeIntegrity": "{{ ikeIntegrity }}", 
"dhGroup": "{{ dhGroup }}", 
"pfsGroup": "{{ pfsGroup }}"
}'
;

vpn_device_configuration_script

Gets a xml format representation for vpn device configuration script.

EXEC azure.network.virtual_network_gateways.vpn_device_configuration_script 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@virtualNetworkGatewayConnectionName='{{ virtualNetworkGatewayConnectionName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"vendor": "{{ vendor }}", 
"deviceFamily": "{{ deviceFamily }}", 
"firmwareVersion": "{{ firmwareVersion }}"
}'
;

start_packet_capture

Starts packet capture on virtual network gateway in the specified resource group.

EXEC azure.network.virtual_network_gateways.start_packet_capture 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@virtualNetworkGatewayName='{{ virtualNetworkGatewayName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"filterData": "{{ filterData }}"
}'
;

stop_packet_capture

Stops packet capture on virtual network gateway in the specified resource group.

EXEC azure.network.virtual_network_gateways.stop_packet_capture 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@virtualNetworkGatewayName='{{ virtualNetworkGatewayName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"sasUrl": "{{ sasUrl }}"
}'
;

disconnect_virtual_network_gateway_vpn_connections

Disconnect vpn connections of virtual network gateway in the specified resource group.

EXEC azure.network.virtual_network_gateways.disconnect_virtual_network_gateway_vpn_connections 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@virtualNetworkGatewayName='{{ virtualNetworkGatewayName }}' --required 
@@json=
'{
"vpnConnectionIds": "{{ vpnConnectionIds }}"
}'
;