volumes

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

Overview

Name	volumes
Type	Resource
Id	azure_stack.fabric_admin.volumes

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 volume.
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 volume.
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, scaleUnit, storageSubSystem, volume		Return the requested a storage volume.
list	select	subscriptionId, resourceGroupName, location, scaleUnit, storageSubSystem	$filter, $top, $skip	Returns a list of all storage volumes at a 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
location	string	The name of Azure region.
resourceGroupName	string	Name of the resource group.
scaleUnit	string	Name of the scale units.
storageSubSystem	string	Name of the storage system.
subscriptionId	string	The ID of the target subscription.
volume	string	Name of the storage volume.
$filter	string	OData filter parameter.
$skip	string	OData skip parameter.
$top	string	OData top parameter.

SELECT examples

get

Return the requested a storage volume.

SELECT
id,
name,
properties,
type
FROM azure_stack.fabric_admin.volumes
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND location = '{{ location }}' -- required
AND scaleUnit = '{{ scaleUnit }}' -- required
AND storageSubSystem = '{{ storageSubSystem }}' -- required
AND volume = '{{ volume }}' -- required
;

list

Returns a list of all storage volumes at a location.

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