edge_gateways

Creates, updates, deletes, gets or lists an edge_gateways resource.

Overview

Name	edge_gateways
Type	Resource
Id	azure_stack.fabric_admin.edge_gateways

Fields

The following fields are returned by SELECT queries:

get

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
properties	object	Object which holds information related to edge gateways.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

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
properties	object	Object which holds information related to edge gateways.
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	subscriptionId, resourceGroupName, location, edgeGateway		Returns the requested edge gateway.
list	select	subscriptionId, resourceGroupName, location	$filter	Returns the list of all edge gateways at a certain location.

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
edgeGateway	string	Name of the edge gateway.
location	string	The name of Azure region.
resourceGroupName	string	Name of the resource group.
subscriptionId	string	The ID of the target subscription.
$filter	string	OData filter parameter.

SELECT examples

get

Returns the requested edge gateway.

SELECT
id,
name,
properties,
type
FROM azure_stack.fabric_admin.edge_gateways
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND location = '{{ location }}' -- required
AND edgeGateway = '{{ edgeGateway }}' -- required
;

list

Returns the list of all edge gateways at a certain location.

SELECT
id,
name,
properties,
type
FROM azure_stack.fabric_admin.edge_gateways
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND location = '{{ location }}' -- required
AND $filter = '{{ $filter }}'
;