file_shares

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

Overview

Name	file_shares
Type	Resource
Id	azure_stack.fabric_admin.file_shares

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	Properties of a file share resource.
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	Properties of a file share resource.
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, fileShare		Returns the requested fabric file share.
list	select	subscriptionId, resourceGroupName, location	$filter, $top, $skip	Returns a list of all fabric file shares 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
fileShare	string	Fabric file share name.
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.
$skip	string	OData skip parameter.
$top	string	OData top parameter.

SELECT examples

get

Returns the requested fabric file share.

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

list

Returns a list of all fabric file shares at a certain location.

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