data_lake_store_accounts

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

Overview

Name	data_lake_store_accounts
Type	Resource
Id	azure.datalake_analytics.data_lake_store_accounts

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
suffix	string	The optional suffix for the Data Lake Store 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 Data Lake Store account.
type	string	The resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, data_lake_store_account_name, subscription_id		Gets the specified Data Lake Store account details in the specified 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 Data Lake Store accounts linked to the specified Data Lake Analytics account. The response includes a link to the next page, if any.
delete	delete	resource_group_name, account_name, data_lake_store_account_name, subscription_id		Updates the Data Lake Analytics account specified to remove the specified Data Lake Store account.
add	exec	resource_group_name, account_name, data_lake_store_account_name, subscription_id		Updates the specified Data Lake Analytics account to include the additional Data Lake Store account.

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.
data_lake_store_account_name	string	The name of the Data Lake Store account to add. Required.
resource_group_name	string	The name of the Azure resource group. 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	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

get

Gets the specified Data Lake Store account details in the specified Data Lake Analytics account.

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

list_by_account

Gets the first page of Data Lake Store accounts 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.data_lake_store_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 }}'
;

DELETE examples

delete

Updates the Data Lake Analytics account specified to remove the specified Data Lake Store account.

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

Lifecycle Methods

add

Updates the specified Data Lake Analytics account to include the additional Data Lake Store account.

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