virtual_network_gateway_connections

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

Overview

Name	virtual_network_gateway_connections
Type	Resource
Id	azure.network.virtual_network_gateway_connections

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
authenticationType	string	Gateway connection authentication type. Known values are: "PSK" and "Certificate". (PSK, Certificate)
authorizationKey	string	The authorizationKey.
certificateAuthentication	object	Certificate Authentication information for a certificate based authentication connection.
connectionMode	string	The connection mode for this connection. Known values are: "Default", "ResponderOnly", and "InitiatorOnly". (Default, ResponderOnly, InitiatorOnly)
connectionProtocol	string	Connection protocol used for this connection. Known values are: "IKEv2" and "IKEv1". (IKEv2, IKEv1)
connectionStatus	string	Virtual Network Gateway connection status. Known values are: "Unknown", "Connecting", "Connected", and "NotConnected". (Unknown, Connecting, Connected, NotConnected)
connectionType	string	Gateway connection type. Required. Known values are: "IPsec", "Vnet2Vnet", "ExpressRoute", and "VPNClient". (IPsec, Vnet2Vnet, ExpressRoute, VPNClient)
dpdTimeoutSeconds	integer	The dead peer detection timeout of this connection in seconds.
egressBytesTransferred	integer	The egress bytes transferred in this connection.
egressNatRules	array	List of egress NatRules.
enableBgp	boolean	EnableBgp flag.
enablePrivateLinkFastPath	boolean	Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled.
etag	string	A unique read-only string that changes whenever the resource is updated.
expressRouteGatewayBypass	boolean	Bypass ExpressRoute Gateway for data forwarding.
gatewayCustomBgpIpAddresses	array	GatewayCustomBgpIpAddresses to be used for virtual network gateway Connection.
ingressBytesTransferred	integer	The ingress bytes transferred in this connection.
ingressNatRules	array	List of ingress NatRules.
ipsecPolicies	array	The IPSec Policies to be considered by this connection.
localNetworkGateway2	object	The reference to local network gateway resource.
location	string	Resource location.
peer	object	Reference to another subresource.
provisioningState	string	The provisioning state of the virtual network gateway connection resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the virtual network gateway connection resource.
routingConfiguration	object	The routing configuration indicating the associated and propagated route tables for this connection.
routingWeight	integer	The routing weight.
sharedKey	string	The IPSec shared key.
tags	object	Resource tags.
trafficSelectorPolicies	array	The Traffic Selector Policies to be considered by this connection.
tunnelConnectionStatus	array	Collection of all tunnels' connection health status.
tunnelProperties	array	Tunnel properties for virtual network gateway connection.
type	string	Resource type.
useLocalAzureIpAddress	boolean	Use private local Azure IP for the connection.
usePolicyBasedTrafficSelectors	boolean	Enable policy-based traffic selectors.
virtualNetworkGateway1	object	The reference to virtual network gateway resource. Required.
virtualNetworkGateway2	object	The reference to virtual network gateway resource.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
authenticationType	string	Gateway connection authentication type. Known values are: "PSK" and "Certificate". (PSK, Certificate)
authorizationKey	string	The authorizationKey.
certificateAuthentication	object	Certificate Authentication information for a certificate based authentication connection.
connectionMode	string	The connection mode for this connection. Known values are: "Default", "ResponderOnly", and "InitiatorOnly". (Default, ResponderOnly, InitiatorOnly)
connectionProtocol	string	Connection protocol used for this connection. Known values are: "IKEv2" and "IKEv1". (IKEv2, IKEv1)
connectionStatus	string	Virtual Network Gateway connection status. Known values are: "Unknown", "Connecting", "Connected", and "NotConnected". (Unknown, Connecting, Connected, NotConnected)
connectionType	string	Gateway connection type. Required. Known values are: "IPsec", "Vnet2Vnet", "ExpressRoute", and "VPNClient". (IPsec, Vnet2Vnet, ExpressRoute, VPNClient)
dpdTimeoutSeconds	integer	The dead peer detection timeout of this connection in seconds.
egressBytesTransferred	integer	The egress bytes transferred in this connection.
egressNatRules	array	List of egress NatRules.
enableBgp	boolean	EnableBgp flag.
enablePrivateLinkFastPath	boolean	Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled.
etag	string	A unique read-only string that changes whenever the resource is updated.
expressRouteGatewayBypass	boolean	Bypass ExpressRoute Gateway for data forwarding.
gatewayCustomBgpIpAddresses	array	GatewayCustomBgpIpAddresses to be used for virtual network gateway Connection.
ingressBytesTransferred	integer	The ingress bytes transferred in this connection.
ingressNatRules	array	List of ingress NatRules.
ipsecPolicies	array	The IPSec Policies to be considered by this connection.
localNetworkGateway2	object	The reference to local network gateway resource.
location	string	Resource location.
peer	object	Reference to another subresource.
provisioningState	string	The provisioning state of the virtual network gateway connection resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the virtual network gateway connection resource.
routingConfiguration	object	The routing configuration indicating the associated and propagated route tables for this connection.
routingWeight	integer	The routing weight.
sharedKey	string	The IPSec shared key.
tags	object	Resource tags.
trafficSelectorPolicies	array	The Traffic Selector Policies to be considered by this connection.
tunnelConnectionStatus	array	Collection of all tunnels' connection health status.
tunnelProperties	array	Tunnel properties for virtual network gateway connection.
type	string	Resource type.
useLocalAzureIpAddress	boolean	Use private local Azure IP for the connection.
usePolicyBasedTrafficSelectors	boolean	Enable policy-based traffic selectors.
virtualNetworkGateway1	object	The reference to virtual network gateway resource. Required.
virtualNetworkGateway2	object	The reference to virtual network gateway resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, virtual_network_gateway_connection_name, subscription_id		Gets the specified virtual network gateway connection by resource group.
list	select	resource_group_name, subscription_id		The List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created.
create_or_update	insert	resource_group_name, virtual_network_gateway_connection_name, subscription_id, properties		Creates or updates a virtual network gateway connection in the specified resource group.
update_tags	update	resource_group_name, virtual_network_gateway_connection_name, subscription_id		Updates a virtual network gateway connection tags.
create_or_update	replace	resource_group_name, virtual_network_gateway_connection_name, subscription_id, properties		Creates or updates a virtual network gateway connection in the specified resource group.
delete	delete	resource_group_name, virtual_network_gateway_connection_name, subscription_id		Deletes the specified virtual network Gateway connection.
get_shared_key	exec	resource_group_name, virtual_network_gateway_connection_name, subscription_id		The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves information about the specified virtual network gateway connection shared key through Network resource provider.
set_shared_key	exec	resource_group_name, virtual_network_gateway_connection_name, subscription_id, value		The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.
get_ike_sas	exec	resource_group_name, virtual_network_gateway_connection_name, subscription_id		Lists IKE Security Associations for the virtual network gateway connection in the specified resource group.
reset_shared_key	exec	resource_group_name, virtual_network_gateway_connection_name, subscription_id, keyLength		The VirtualNetworkGatewayConnectionResetSharedKey operation resets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.
start_packet_capture	exec	resource_group_name, virtual_network_gateway_connection_name, subscription_id		Starts packet capture on virtual network gateway connection in the specified resource group.
stop_packet_capture	exec	resource_group_name, virtual_network_gateway_connection_name, subscription_id		Stops packet capture on virtual network gateway connection in the specified resource group.
reset_connection	exec	resource_group_name, virtual_network_gateway_connection_name, subscription_id		Resets the virtual network gateway connection specified.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
virtual_network_gateway_connection_name	string	The name of the virtual network gateway connection. Required.

SELECT examples

get

Gets the specified virtual network gateway connection by resource group.

SELECT
id,
name,
authenticationType,
authorizationKey,
certificateAuthentication,
connectionMode,
connectionProtocol,
connectionStatus,
connectionType,
dpdTimeoutSeconds,
egressBytesTransferred,
egressNatRules,
enableBgp,
enablePrivateLinkFastPath,
etag,
expressRouteGatewayBypass,
gatewayCustomBgpIpAddresses,
ingressBytesTransferred,
ingressNatRules,
ipsecPolicies,
localNetworkGateway2,
location,
peer,
provisioningState,
resourceGuid,
routingConfiguration,
routingWeight,
sharedKey,
tags,
trafficSelectorPolicies,
tunnelConnectionStatus,
tunnelProperties,
type,
useLocalAzureIpAddress,
usePolicyBasedTrafficSelectors,
virtualNetworkGateway1,
virtualNetworkGateway2
FROM azure.network.virtual_network_gateway_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_network_gateway_connection_name = '{{ virtual_network_gateway_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

The List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created.

SELECT
id,
name,
authenticationType,
authorizationKey,
certificateAuthentication,
connectionMode,
connectionProtocol,
connectionStatus,
connectionType,
dpdTimeoutSeconds,
egressBytesTransferred,
egressNatRules,
enableBgp,
enablePrivateLinkFastPath,
etag,
expressRouteGatewayBypass,
gatewayCustomBgpIpAddresses,
ingressBytesTransferred,
ingressNatRules,
ipsecPolicies,
localNetworkGateway2,
location,
peer,
provisioningState,
resourceGuid,
routingConfiguration,
routingWeight,
sharedKey,
tags,
trafficSelectorPolicies,
tunnelConnectionStatus,
tunnelProperties,
type,
useLocalAzureIpAddress,
usePolicyBasedTrafficSelectors,
virtualNetworkGateway1,
virtualNetworkGateway2
FROM azure.network.virtual_network_gateway_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure.network.virtual_network_gateway_connections (
id,
location,
tags,
properties,
resource_group_name,
virtual_network_gateway_connection_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ virtual_network_gateway_connection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_network_gateway_connections
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the virtual_network_gateway_connections resource.
  - name: virtual_network_gateway_connection_name
    value: "{{ virtual_network_gateway_connection_name }}"
    description: Required parameter for the virtual_network_gateway_connections resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the virtual_network_gateway_connections resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    description: |
      Properties of the virtual network gateway connection. Required.
    value:
      authorizationKey: "{{ authorizationKey }}"
      virtualNetworkGateway1:
        id: "{{ id }}"
        name: "{{ name }}"
        type: "{{ type }}"
        location: "{{ location }}"
        tags: "{{ tags }}"
        properties:
          autoScaleConfiguration:
            bounds:
              min: {{ min }}
              max: {{ max }}
          ipConfigurations:
            - id: "{{ id }}"
              properties:
                privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
                subnet: "{{ subnet }}"
                publicIPAddress: "{{ publicIPAddress }}"
                privateIPAddress: "{{ privateIPAddress }}"
                provisioningState: "{{ provisioningState }}"
              name: "{{ name }}"
              etag: "{{ etag }}"
          gatewayType: "{{ gatewayType }}"
          vpnType: "{{ vpnType }}"
          vpnGatewayGeneration: "{{ vpnGatewayGeneration }}"
          enableBgp: {{ enableBgp }}
          enablePrivateIpAddress: {{ enablePrivateIpAddress }}
          virtualNetworkGatewayMigrationStatus:
            state: "{{ state }}"
            phase: "{{ phase }}"
            errorMessage: "{{ errorMessage }}"
          activeActive: {{ activeActive }}
          enableHighBandwidthVpnGateway: {{ enableHighBandwidthVpnGateway }}
          disableIPSecReplayProtection: {{ disableIPSecReplayProtection }}
          gatewayDefaultSite:
            id: "{{ id }}"
          sku:
            name: "{{ name }}"
            tier: "{{ tier }}"
            capacity: {{ capacity }}
          vpnClientConfiguration:
            vpnClientAddressPool:
              addressPrefixes: "{{ addressPrefixes }}"
              ipamPoolPrefixAllocations: "{{ ipamPoolPrefixAllocations }}"
            vpnClientRootCertificates:
              - id: "{{ id }}"
                properties:
                  publicCertData: "{{ publicCertData }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
            vpnClientRevokedCertificates:
              - id: "{{ id }}"
                properties:
                  thumbprint: "{{ thumbprint }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
            vpnClientProtocols:
              - "{{ vpnClientProtocols }}"
            vpnAuthenticationTypes:
              - "{{ vpnAuthenticationTypes }}"
            vpnClientIpsecPolicies:
              - saLifeTimeSeconds: {{ saLifeTimeSeconds }}
                saDataSizeKilobytes: {{ saDataSizeKilobytes }}
                ipsecEncryption: "{{ ipsecEncryption }}"
                ipsecIntegrity: "{{ ipsecIntegrity }}"
                ikeEncryption: "{{ ikeEncryption }}"
                ikeIntegrity: "{{ ikeIntegrity }}"
                dhGroup: "{{ dhGroup }}"
                pfsGroup: "{{ pfsGroup }}"
            radiusServerAddress: "{{ radiusServerAddress }}"
            radiusServerSecret: "{{ radiusServerSecret }}"
            radiusServers:
              - radiusServerAddress: "{{ radiusServerAddress }}"
                radiusServerScore: {{ radiusServerScore }}
                radiusServerSecret: "{{ radiusServerSecret }}"
            aadTenant: "{{ aadTenant }}"
            aadAudience: "{{ aadAudience }}"
            aadIssuer: "{{ aadIssuer }}"
            vngClientConnectionConfigurations:
              - id: "{{ id }}"
                properties:
                  vpnClientAddressPool: "{{ vpnClientAddressPool }}"
                  virtualNetworkGatewayPolicyGroups: "{{ virtualNetworkGatewayPolicyGroups }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
          virtualNetworkGatewayPolicyGroups:
            - id: "{{ id }}"
              properties:
                isDefault: {{ isDefault }}
                priority: {{ priority }}
                policyMembers: "{{ policyMembers }}"
                vngClientConnectionConfigurations: "{{ vngClientConnectionConfigurations }}"
                provisioningState: "{{ provisioningState }}"
              name: "{{ name }}"
              etag: "{{ etag }}"
          bgpSettings:
            asn: {{ asn }}
            bgpPeeringAddress: "{{ bgpPeeringAddress }}"
            peerWeight: {{ peerWeight }}
            bgpPeeringAddresses:
              - ipconfigurationId: "{{ ipconfigurationId }}"
                defaultBgpIpAddresses: "{{ defaultBgpIpAddresses }}"
                customBgpIpAddresses: "{{ customBgpIpAddresses }}"
                tunnelIpAddresses: "{{ tunnelIpAddresses }}"
          customRoutes:
            addressPrefixes:
              - "{{ addressPrefixes }}"
            ipamPoolPrefixAllocations:
              - pool:
                  id: "{{ id }}"
                numberOfIpAddresses: "{{ numberOfIpAddresses }}"
                allocatedAddressPrefixes: "{{ allocatedAddressPrefixes }}"
          resourceGuid: "{{ resourceGuid }}"
          provisioningState: "{{ provisioningState }}"
          enableDnsForwarding: {{ enableDnsForwarding }}
          inboundDnsForwardingEndpoint: "{{ inboundDnsForwardingEndpoint }}"
          vNetExtendedLocationResourceId: "{{ vNetExtendedLocationResourceId }}"
          natRules:
            - id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              properties:
                provisioningState: "{{ provisioningState }}"
                type: "{{ type }}"
                mode: "{{ mode }}"
                internalMappings: "{{ internalMappings }}"
                externalMappings: "{{ externalMappings }}"
                ipConfigurationId: "{{ ipConfigurationId }}"
              etag: "{{ etag }}"
          enableBgpRouteTranslationForNat: {{ enableBgpRouteTranslationForNat }}
          allowVirtualWanTraffic: {{ allowVirtualWanTraffic }}
          allowRemoteVnetTraffic: {{ allowRemoteVnetTraffic }}
          adminState: "{{ adminState }}"
          resiliencyModel: "{{ resiliencyModel }}"
        extendedLocation:
          name: "{{ name }}"
          type: "{{ type }}"
        etag: "{{ etag }}"
        identity:
          principalId: "{{ principalId }}"
          tenantId: "{{ tenantId }}"
          type: "{{ type }}"
          userAssignedIdentities: "{{ userAssignedIdentities }}"
      virtualNetworkGateway2:
        id: "{{ id }}"
        name: "{{ name }}"
        type: "{{ type }}"
        location: "{{ location }}"
        tags: "{{ tags }}"
        properties:
          autoScaleConfiguration:
            bounds:
              min: {{ min }}
              max: {{ max }}
          ipConfigurations:
            - id: "{{ id }}"
              properties:
                privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
                subnet: "{{ subnet }}"
                publicIPAddress: "{{ publicIPAddress }}"
                privateIPAddress: "{{ privateIPAddress }}"
                provisioningState: "{{ provisioningState }}"
              name: "{{ name }}"
              etag: "{{ etag }}"
          gatewayType: "{{ gatewayType }}"
          vpnType: "{{ vpnType }}"
          vpnGatewayGeneration: "{{ vpnGatewayGeneration }}"
          enableBgp: {{ enableBgp }}
          enablePrivateIpAddress: {{ enablePrivateIpAddress }}
          virtualNetworkGatewayMigrationStatus:
            state: "{{ state }}"
            phase: "{{ phase }}"
            errorMessage: "{{ errorMessage }}"
          activeActive: {{ activeActive }}
          enableHighBandwidthVpnGateway: {{ enableHighBandwidthVpnGateway }}
          disableIPSecReplayProtection: {{ disableIPSecReplayProtection }}
          gatewayDefaultSite:
            id: "{{ id }}"
          sku:
            name: "{{ name }}"
            tier: "{{ tier }}"
            capacity: {{ capacity }}
          vpnClientConfiguration:
            vpnClientAddressPool:
              addressPrefixes: "{{ addressPrefixes }}"
              ipamPoolPrefixAllocations: "{{ ipamPoolPrefixAllocations }}"
            vpnClientRootCertificates:
              - id: "{{ id }}"
                properties:
                  publicCertData: "{{ publicCertData }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
            vpnClientRevokedCertificates:
              - id: "{{ id }}"
                properties:
                  thumbprint: "{{ thumbprint }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
            vpnClientProtocols:
              - "{{ vpnClientProtocols }}"
            vpnAuthenticationTypes:
              - "{{ vpnAuthenticationTypes }}"
            vpnClientIpsecPolicies:
              - saLifeTimeSeconds: {{ saLifeTimeSeconds }}
                saDataSizeKilobytes: {{ saDataSizeKilobytes }}
                ipsecEncryption: "{{ ipsecEncryption }}"
                ipsecIntegrity: "{{ ipsecIntegrity }}"
                ikeEncryption: "{{ ikeEncryption }}"
                ikeIntegrity: "{{ ikeIntegrity }}"
                dhGroup: "{{ dhGroup }}"
                pfsGroup: "{{ pfsGroup }}"
            radiusServerAddress: "{{ radiusServerAddress }}"
            radiusServerSecret: "{{ radiusServerSecret }}"
            radiusServers:
              - radiusServerAddress: "{{ radiusServerAddress }}"
                radiusServerScore: {{ radiusServerScore }}
                radiusServerSecret: "{{ radiusServerSecret }}"
            aadTenant: "{{ aadTenant }}"
            aadAudience: "{{ aadAudience }}"
            aadIssuer: "{{ aadIssuer }}"
            vngClientConnectionConfigurations:
              - id: "{{ id }}"
                properties:
                  vpnClientAddressPool: "{{ vpnClientAddressPool }}"
                  virtualNetworkGatewayPolicyGroups: "{{ virtualNetworkGatewayPolicyGroups }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
          virtualNetworkGatewayPolicyGroups:
            - id: "{{ id }}"
              properties:
                isDefault: {{ isDefault }}
                priority: {{ priority }}
                policyMembers: "{{ policyMembers }}"
                vngClientConnectionConfigurations: "{{ vngClientConnectionConfigurations }}"
                provisioningState: "{{ provisioningState }}"
              name: "{{ name }}"
              etag: "{{ etag }}"
          bgpSettings:
            asn: {{ asn }}
            bgpPeeringAddress: "{{ bgpPeeringAddress }}"
            peerWeight: {{ peerWeight }}
            bgpPeeringAddresses:
              - ipconfigurationId: "{{ ipconfigurationId }}"
                defaultBgpIpAddresses: "{{ defaultBgpIpAddresses }}"
                customBgpIpAddresses: "{{ customBgpIpAddresses }}"
                tunnelIpAddresses: "{{ tunnelIpAddresses }}"
          customRoutes:
            addressPrefixes:
              - "{{ addressPrefixes }}"
            ipamPoolPrefixAllocations:
              - pool:
                  id: "{{ id }}"
                numberOfIpAddresses: "{{ numberOfIpAddresses }}"
                allocatedAddressPrefixes: "{{ allocatedAddressPrefixes }}"
          resourceGuid: "{{ resourceGuid }}"
          provisioningState: "{{ provisioningState }}"
          enableDnsForwarding: {{ enableDnsForwarding }}
          inboundDnsForwardingEndpoint: "{{ inboundDnsForwardingEndpoint }}"
          vNetExtendedLocationResourceId: "{{ vNetExtendedLocationResourceId }}"
          natRules:
            - id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              properties:
                provisioningState: "{{ provisioningState }}"
                type: "{{ type }}"
                mode: "{{ mode }}"
                internalMappings: "{{ internalMappings }}"
                externalMappings: "{{ externalMappings }}"
                ipConfigurationId: "{{ ipConfigurationId }}"
              etag: "{{ etag }}"
          enableBgpRouteTranslationForNat: {{ enableBgpRouteTranslationForNat }}
          allowVirtualWanTraffic: {{ allowVirtualWanTraffic }}
          allowRemoteVnetTraffic: {{ allowRemoteVnetTraffic }}
          adminState: "{{ adminState }}"
          resiliencyModel: "{{ resiliencyModel }}"
        extendedLocation:
          name: "{{ name }}"
          type: "{{ type }}"
        etag: "{{ etag }}"
        identity:
          principalId: "{{ principalId }}"
          tenantId: "{{ tenantId }}"
          type: "{{ type }}"
          userAssignedIdentities: "{{ userAssignedIdentities }}"
      localNetworkGateway2:
        id: "{{ id }}"
        name: "{{ name }}"
        type: "{{ type }}"
        location: "{{ location }}"
        tags: "{{ tags }}"
        properties:
          localNetworkAddressSpace:
            addressPrefixes:
              - "{{ addressPrefixes }}"
            ipamPoolPrefixAllocations:
              - pool:
                  id: "{{ id }}"
                numberOfIpAddresses: "{{ numberOfIpAddresses }}"
                allocatedAddressPrefixes: "{{ allocatedAddressPrefixes }}"
          gatewayIpAddress: "{{ gatewayIpAddress }}"
          fqdn: "{{ fqdn }}"
          bgpSettings:
            asn: {{ asn }}
            bgpPeeringAddress: "{{ bgpPeeringAddress }}"
            peerWeight: {{ peerWeight }}
            bgpPeeringAddresses:
              - ipconfigurationId: "{{ ipconfigurationId }}"
                defaultBgpIpAddresses: "{{ defaultBgpIpAddresses }}"
                customBgpIpAddresses: "{{ customBgpIpAddresses }}"
                tunnelIpAddresses: "{{ tunnelIpAddresses }}"
          resourceGuid: "{{ resourceGuid }}"
          provisioningState: "{{ provisioningState }}"
        etag: "{{ etag }}"
      ingressNatRules:
        - id: "{{ id }}"
      egressNatRules:
        - id: "{{ id }}"
      connectionType: "{{ connectionType }}"
      connectionProtocol: "{{ connectionProtocol }}"
      routingWeight: {{ routingWeight }}
      dpdTimeoutSeconds: {{ dpdTimeoutSeconds }}
      connectionMode: "{{ connectionMode }}"
      tunnelProperties:
        - tunnelIpAddress: "{{ tunnelIpAddress }}"
          bgpPeeringAddress: "{{ bgpPeeringAddress }}"
      sharedKey: "{{ sharedKey }}"
      connectionStatus: "{{ connectionStatus }}"
      tunnelConnectionStatus:
        - tunnel: "{{ tunnel }}"
          connectionStatus: "{{ connectionStatus }}"
          ingressBytesTransferred: {{ ingressBytesTransferred }}
          egressBytesTransferred: {{ egressBytesTransferred }}
          lastConnectionEstablishedUtcTime: "{{ lastConnectionEstablishedUtcTime }}"
      egressBytesTransferred: {{ egressBytesTransferred }}
      ingressBytesTransferred: {{ ingressBytesTransferred }}
      peer:
        id: "{{ id }}"
      enableBgp: {{ enableBgp }}
      gatewayCustomBgpIpAddresses:
        - ipConfigurationId: "{{ ipConfigurationId }}"
          customBgpIpAddress: "{{ customBgpIpAddress }}"
      useLocalAzureIpAddress: {{ useLocalAzureIpAddress }}
      usePolicyBasedTrafficSelectors: {{ usePolicyBasedTrafficSelectors }}
      ipsecPolicies:
        - saLifeTimeSeconds: {{ saLifeTimeSeconds }}
          saDataSizeKilobytes: {{ saDataSizeKilobytes }}
          ipsecEncryption: "{{ ipsecEncryption }}"
          ipsecIntegrity: "{{ ipsecIntegrity }}"
          ikeEncryption: "{{ ikeEncryption }}"
          ikeIntegrity: "{{ ikeIntegrity }}"
          dhGroup: "{{ dhGroup }}"
          pfsGroup: "{{ pfsGroup }}"
      trafficSelectorPolicies:
        - localAddressRanges: "{{ localAddressRanges }}"
          remoteAddressRanges: "{{ remoteAddressRanges }}"
      resourceGuid: "{{ resourceGuid }}"
      provisioningState: "{{ provisioningState }}"
      expressRouteGatewayBypass: {{ expressRouteGatewayBypass }}
      enablePrivateLinkFastPath: {{ enablePrivateLinkFastPath }}
      authenticationType: "{{ authenticationType }}"
      certificateAuthentication:
        outboundAuthCertificate: "{{ outboundAuthCertificate }}"
        inboundAuthCertificateSubjectName: "{{ inboundAuthCertificateSubjectName }}"
        inboundAuthCertificateChain:
          - "{{ inboundAuthCertificateChain }}"
      routingConfiguration:
        associatedRouteTable:
          id: "{{ id }}"
        propagatedRouteTables:
          labels:
            - "{{ labels }}"
          ids:
            - id: "{{ id }}"
        vnetRoutes:
          staticRoutesConfig:
            propagateStaticRoutes: {{ propagateStaticRoutes }}
            vnetLocalRouteOverrideCriteria: "{{ vnetLocalRouteOverrideCriteria }}"
          staticRoutes:
            - name: "{{ name }}"
              addressPrefixes: "{{ addressPrefixes }}"
              nextHopIpAddress: "{{ nextHopIpAddress }}"
          bgpConnections:
            - id: "{{ id }}"
        inboundRouteMap:
          id: "{{ id }}"
        outboundRouteMap:
          id: "{{ id }}"

UPDATE examples

update_tags

Updates a virtual network gateway connection tags.

UPDATE azure.network.virtual_network_gateway_connections
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND virtual_network_gateway_connection_name = '{{ virtual_network_gateway_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

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

REPLACE azure.network.virtual_network_gateway_connections
SET 
id = '{{ id }}',
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND virtual_network_gateway_connection_name = '{{ virtual_network_gateway_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
etag,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes the specified virtual network Gateway connection.

DELETE FROM azure.network.virtual_network_gateway_connections
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND virtual_network_gateway_connection_name = '{{ virtual_network_gateway_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_shared_key

The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves information about the specified virtual network gateway connection shared key through Network resource provider.

EXEC azure.network.virtual_network_gateway_connections.get_shared_key 
@resource_group_name='{{ resource_group_name }}' --required, 
@virtual_network_gateway_connection_name='{{ virtual_network_gateway_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

set_shared_key

The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.

EXEC azure.network.virtual_network_gateway_connections.set_shared_key 
@resource_group_name='{{ resource_group_name }}' --required, 
@virtual_network_gateway_connection_name='{{ virtual_network_gateway_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"id": "{{ id }}", 
"value": "{{ value }}"
}'
;

get_ike_sas

Lists IKE Security Associations for the virtual network gateway connection in the specified resource group.

EXEC azure.network.virtual_network_gateway_connections.get_ike_sas 
@resource_group_name='{{ resource_group_name }}' --required, 
@virtual_network_gateway_connection_name='{{ virtual_network_gateway_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

reset_shared_key

The VirtualNetworkGatewayConnectionResetSharedKey operation resets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.

EXEC azure.network.virtual_network_gateway_connections.reset_shared_key 
@resource_group_name='{{ resource_group_name }}' --required, 
@virtual_network_gateway_connection_name='{{ virtual_network_gateway_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"keyLength": {{ keyLength }}
}'
;

start_packet_capture

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

EXEC azure.network.virtual_network_gateway_connections.start_packet_capture 
@resource_group_name='{{ resource_group_name }}' --required, 
@virtual_network_gateway_connection_name='{{ virtual_network_gateway_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"filterData": "{{ filterData }}"
}'
;

stop_packet_capture

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

EXEC azure.network.virtual_network_gateway_connections.stop_packet_capture 
@resource_group_name='{{ resource_group_name }}' --required, 
@virtual_network_gateway_connection_name='{{ virtual_network_gateway_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"sasUrl": "{{ sasUrl }}"
}'
;

reset_connection

Resets the virtual network gateway connection specified.

EXEC azure.network.virtual_network_gateway_connections.reset_connection 
@resource_group_name='{{ resource_group_name }}' --required, 
@virtual_network_gateway_connection_name='{{ virtual_network_gateway_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;