storage_accounts

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

Overview

Name	storage_accounts
Type	Resource
Id	azure.datalake_analytics.storage_accounts

Fields

The following fields are returned by SELECT queries:

list_sas_tokens

Name	Datatype	Description
accessToken	string	The access token for the associated Azure Storage Container.

get

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
suffix	string	The optional suffix for the storage account.
type	string	The resource type.

list_by_account

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
suffix	string	The optional suffix for the storage account.
type	string	The resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_sas_tokens	select	resource_group_name, account_name, storage_account_name, container_name, subscription_id		Gets the SAS token associated with the specified Data Lake Analytics and Azure Storage account and container combination.
get	select	resource_group_name, account_name, storage_account_name, subscription_id		Gets the specified Azure Storage account linked to the given Data Lake Analytics account.
list_by_account	select	resource_group_name, account_name, subscription_id	$filter, $top, $skip, $select, $orderby, $count	Gets the first page of Azure Storage accounts, if any, linked to the specified Data Lake Analytics account. The response includes a link to the next page, if any.
update	update	resource_group_name, account_name, storage_account_name, subscription_id		Updates the Data Lake Analytics account to replace Azure Storage blob account details, such as the access key and/or suffix.
delete	delete	resource_group_name, account_name, storage_account_name, subscription_id		Updates the specified Data Lake Analytics account to remove an Azure Storage account.
add	exec	resource_group_name, account_name, storage_account_name, subscription_id, properties		Updates the specified Data Lake Analytics account to add an Azure Storage account.
list_storage_containers	exec	resource_group_name, account_name, storage_account_name, subscription_id		Lists the Azure Storage containers, if any, associated with the specified Data Lake Analytics and Azure Storage account combination. The response includes a link to the next page of results, if any.
get_storage_container	exec	resource_group_name, account_name, storage_account_name, container_name, subscription_id		Gets the specified Azure Storage container associated with the given Data Lake Analytics and Azure Storage accounts.

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
account_name	string	The name of the Data Lake Analytics account. Required.
container_name	string	The name of the Azure storage container to retrieve. Required.
resource_group_name	string	The name of the Azure resource group. Required.
storage_account_name	string	The name of the Azure storage account from which to retrieve the blob container. Required.
subscription_id	string
$count	boolean	The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional. Default value is None.
$filter	string	The OData filter. Optional. Default value is None.
$orderby	string	OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional. Default value is None.
$select	string	OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. Default value is None.
$skip	integer	The number of items to skip over before returning elements. Optional. Default value is None.
$top	integer	The number of items to return. Optional. Default value is None.

SELECT examples

list_sas_tokens

Gets the SAS token associated with the specified Data Lake Analytics and Azure Storage account and container combination.

SELECT
accessToken
FROM azure.datalake_analytics.storage_accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND storage_account_name = '{{ storage_account_name }}' -- required
AND container_name = '{{ container_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Gets the specified Azure Storage account linked to the given Data Lake Analytics account.

SELECT
id,
name,
suffix,
type
FROM azure.datalake_analytics.storage_accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND storage_account_name = '{{ storage_account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_account

Gets the first page of Azure Storage accounts, if any, linked to the specified Data Lake Analytics account. The response includes a link to the next page, if any.

SELECT
id,
name,
suffix,
type
FROM azure.datalake_analytics.storage_accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
AND $select = '{{ $select }}'
AND $orderby = '{{ $orderby }}'
AND $count = '{{ $count }}'
;

UPDATE examples

update

Updates the Data Lake Analytics account to replace Azure Storage blob account details, such as the access key and/or suffix.

UPDATE azure.datalake_analytics.storage_accounts
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND storage_account_name = '{{ storage_account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required;

DELETE examples

delete

Updates the specified Data Lake Analytics account to remove an Azure Storage account.

DELETE FROM azure.datalake_analytics.storage_accounts
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND storage_account_name = '{{ storage_account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

add

Updates the specified Data Lake Analytics account to add an Azure Storage account.

EXEC azure.datalake_analytics.storage_accounts.add 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@storage_account_name='{{ storage_account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

list_storage_containers

Lists the Azure Storage containers, if any, associated with the specified Data Lake Analytics and Azure Storage account combination. The response includes a link to the next page of results, if any.

EXEC azure.datalake_analytics.storage_accounts.list_storage_containers 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@storage_account_name='{{ storage_account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_storage_container

Gets the specified Azure Storage container associated with the given Data Lake Analytics and Azure Storage accounts.

EXEC azure.datalake_analytics.storage_accounts.get_storage_container 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@storage_account_name='{{ storage_account_name }}' --required, 
@container_name='{{ container_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;