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_stack.network_admin.virtual_network_gateway_connections

Fields

The following fields are returned by SELECT queries:

list

OK -- The list of virtual network gateway connections has been returned.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
location	string	Name of Azure Stack
properties	object	Virtual Network Gateway Connection properties.
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	subscriptionId	$filter, $orderBy, $top	Returns a list of all Virtual Network Gateway Connections.

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
subscriptionId	string	The ID of the target subscription.
$filter	string	OData filter parameter.
$orderBy	string	OData orderBy parameter.
$top	string	OData top parameter.

SELECT examples

list

Returns a list of all Virtual Network Gateway Connections.

SELECT
id,
name,
location,
properties,
type
FROM azure_stack.network_admin.virtual_network_gateway_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $orderBy = '{{ $orderBy }}'
AND $top = '{{ $top }}'
;