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

vw_virtual_network_gateway_connections

Name	Datatype	Description
id	text	Resource ID.
name	text	Resource name.
authorization_key	text	field from the properties object
connection_mode	text	field from the properties object
connection_protocol	text	field from the properties object
connection_status	text	field from the properties object
connection_type	text	field from the properties object
dpd_timeout_seconds	text	field from the properties object
egress_bytes_transferred	text	field from the properties object
egress_nat_rules	text	field from the properties object
enable_bgp	text	field from the properties object
enable_private_link_fast_path	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
express_route_gateway_bypass	text	field from the properties object
gateway_custom_bgp_ip_addresses	text	field from the properties object
ingress_bytes_transferred	text	field from the properties object
ingress_nat_rules	text	field from the properties object
ipsec_policies	text	field from the properties object
local_network_gateway2	text	field from the properties object
location	text	Resource location.
peer	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
resource_guid	text	field from the properties object
routing_weight	text	field from the properties object
shared_key	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
traffic_selector_policies	text	field from the properties object
tunnel_connection_status	text	field from the properties object
type	text	Resource type.
use_local_azure_ip_address	text	field from the properties object
use_policy_based_traffic_selectors	text	field from the properties object
virtualNetworkGatewayConnectionName	text	field from the properties object
virtual_network_gateway1	text	field from the properties object
virtual_network_gateway2	text	field from the properties object

virtual_network_gateway_connections

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

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, subscriptionId, virtualNetworkGatewayConnectionName	Gets the specified virtual network gateway connection by resource group.
list	SELECT	resourceGroupName, subscriptionId	The List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created.
create_or_update	INSERT	resourceGroupName, subscriptionId, virtualNetworkGatewayConnectionName, data__properties	Creates or updates a virtual network gateway connection in the specified resource group.
delete	DELETE	resourceGroupName, subscriptionId, virtualNetworkGatewayConnectionName	Deletes the specified virtual network Gateway connection.
reset_connection	EXEC	resourceGroupName, subscriptionId, virtualNetworkGatewayConnectionName	Resets the virtual network gateway connection specified.
reset_shared_key	EXEC	resourceGroupName, subscriptionId, virtualNetworkGatewayConnectionName, data__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.
set_shared_key	EXEC	resourceGroupName, subscriptionId, virtualNetworkGatewayConnectionName, data__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.
start_packet_capture	EXEC	resourceGroupName, subscriptionId, virtualNetworkGatewayConnectionName	Starts packet capture on virtual network gateway connection in the specified resource group.
stop_packet_capture	EXEC	resourceGroupName, subscriptionId, virtualNetworkGatewayConnectionName	Stops packet capture on virtual network gateway connection in the specified resource group.
update_tags	EXEC	resourceGroupName, subscriptionId, virtualNetworkGatewayConnectionName	Updates a virtual network gateway connection tags.

SELECT examples

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

vw_virtual_network_gateway_connections

SELECT
id,
name,
authorization_key,
connection_mode,
connection_protocol,
connection_status,
connection_type,
dpd_timeout_seconds,
egress_bytes_transferred,
egress_nat_rules,
enable_bgp,
enable_private_link_fast_path,
etag,
express_route_gateway_bypass,
gateway_custom_bgp_ip_addresses,
ingress_bytes_transferred,
ingress_nat_rules,
ipsec_policies,
local_network_gateway2,
location,
peer,
provisioning_state,
resourceGroupName,
resource_guid,
routing_weight,
shared_key,
subscriptionId,
tags,
traffic_selector_policies,
tunnel_connection_status,
type,
use_local_azure_ip_address,
use_policy_based_traffic_selectors,
virtualNetworkGatewayConnectionName,
virtual_network_gateway1,
virtual_network_gateway2
FROM azure.network.vw_virtual_network_gateway_connections
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

virtual_network_gateway_connections

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

INSERT example

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

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: authorizationKey
          value: string
        - name: virtualNetworkGateway1
          value:
            - 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
        - name: localNetworkGateway2
          value:
            - name: properties
              value:
                - name: gatewayIpAddress
                  value: string
                - name: fqdn
                  value: string
                - name: resourceGuid
                  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
        - name: ingressNatRules
          value:
            - - name: id
                value: string
        - name: egressNatRules
          value:
            - - name: id
                value: string
        - name: connectionType
          value: []
        - name: connectionProtocol
          value: []
        - name: routingWeight
          value: integer
        - name: dpdTimeoutSeconds
          value: integer
        - name: connectionMode
          value: []
        - name: sharedKey
          value: string
        - name: connectionStatus
          value: []
        - name: tunnelConnectionStatus
          value:
            - - name: tunnel
                value: string
              - name: ingressBytesTransferred
                value: integer
              - name: egressBytesTransferred
                value: integer
              - name: lastConnectionEstablishedUtcTime
                value: string
        - name: egressBytesTransferred
          value: integer
        - name: ingressBytesTransferred
          value: integer
        - name: enableBgp
          value: boolean
        - name: gatewayCustomBgpIpAddresses
          value:
            - - name: ipConfigurationId
                value: string
              - name: customBgpIpAddress
                value: string
        - name: useLocalAzureIpAddress
          value: boolean
        - name: usePolicyBasedTrafficSelectors
          value: boolean
        - name: ipsecPolicies
          value:
            - - name: saLifeTimeSeconds
                value: integer
              - name: saDataSizeKilobytes
                value: integer
        - name: trafficSelectorPolicies
          value:
            - - name: localAddressRanges
                value:
                  - string
              - name: remoteAddressRanges
                value:
                  - string
        - name: resourceGuid
          value: string
        - name: expressRouteGatewayBypass
          value: boolean
        - name: enablePrivateLinkFastPath
          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 virtual_network_gateway_connections resource.

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