virtual_network_gateways_connections

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

Overview

Name	virtual_network_gateways_connections
Type	Resource
Id	azure.network.virtual_network_gateways_connections

Fields

The following fields are returned by SELECT queries:

list

Request successful. The operation returns a list of VirtualNetworkGatewayConnection 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.
properties	object	Properties of the virtual network gateway connection.
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
list	select	resourceGroupName, virtualNetworkGatewayName, subscriptionId		Gets all the connections in a virtual network gateway.

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.
virtualNetworkGatewayName	string	The name of the virtual network gateway.

SELECT examples

list

Gets all the connections in a virtual network gateway.

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