storage_accounts

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

Overview

Name	storage_accounts
Type	Resource
Id	azure_stack.storage_admin.storage_accounts

Fields

The following fields are returned by SELECT queries:

get

OK -- The storage account has been returned.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource Name.
kind	string	Indicates the type of storage account
location	string	Resource Location.
properties	object	Properties of the storage account.
tags	object	Resource tags.
type	string	Resource Type.

list

OK -- The list of storage accounts has been returned.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource Name.
kind	string	Indicates the type of storage account
location	string	Resource Location.
properties	object	Properties of the storage account.
tags	object	Resource tags.
type	string	Resource Type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, location, accountId		Returns the requested storage account.
list	select	subscriptionId, location	$filter, summary	Returns a list of storage accounts.
undelete	exec	subscriptionId, location, accountId	newAccountName	Undelete a deleted storage account with new account name if the a new name is provided.
reclaim_storage_capacity	exec	subscriptionId, location		Start reclaim storage capacity on deleted storage objects.

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
accountId	string	Internal storage account ID, which is not visible to tenant.
location	string	Resource location.
subscriptionId	string	Subscription Id.
$filter	string	Filter string
newAccountName	string	New storage account name when doing undelete storage account operation.
summary	boolean	Switch for whether summary or detailed information is returned.

SELECT examples

get

Returns the requested storage account.

SELECT
id,
name,
kind,
location,
properties,
tags,
type
FROM azure_stack.storage_admin.storage_accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND location = '{{ location }}' -- required
AND accountId = '{{ accountId }}' -- required
;

list

Returns a list of storage accounts.

SELECT
id,
name,
kind,
location,
properties,
tags,
type
FROM azure_stack.storage_admin.storage_accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND location = '{{ location }}' -- required
AND $filter = '{{ $filter }}'
AND summary = '{{ summary }}'
;

Lifecycle Methods

undelete

Undelete a deleted storage account with new account name if the a new name is provided.

EXEC azure_stack.storage_admin.storage_accounts.undelete 
@subscriptionId='{{ subscriptionId }}' --required, 
@location='{{ location }}' --required, 
@accountId='{{ accountId }}' --required, 
@newAccountName='{{ newAccountName }}'
;

reclaim_storage_capacity

Start reclaim storage capacity on deleted storage objects.

EXEC azure_stack.storage_admin.storage_accounts.reclaim_storage_capacity 
@subscriptionId='{{ subscriptionId }}' --required, 
@location='{{ location }}' --required
;