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.data_lake_analytics.data_lake_store_accounts

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the specified Azure Data Lake Store account information.

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
properties	object	The Data Lake Store account properties.
type	string	The resource type.

list_by_account

Successfully retrieved the list of Data Lake Store accounts.

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
properties	object	The Data Lake Store account properties.
type	string	The resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, dataLakeStoreAccountName		Gets the specified Data Lake Store account details in the specified Data Lake Analytics account.
list_by_account	select	subscriptionId, resourceGroupName, accountName	$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	subscriptionId, resourceGroupName, accountName, dataLakeStoreAccountName		Updates the Data Lake Analytics account specified to remove the specified Data Lake Store account.
add	exec	subscriptionId, resourceGroupName, accountName, dataLakeStoreAccountName		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
accountName	string	The name of the Data Lake Analytics account.
dataLakeStoreAccountName	string	The name of the Data Lake Store account to add.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
$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.
$filter	string	OData filter. Optional.
$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.
$select	string	OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
$skip	integer (int32)	The number of items to skip over before returning elements. Optional.
$top	integer (int32)	The number of items to return. Optional.

SELECT examples

get

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

SELECT
id,
name,
properties,
type
FROM azure.data_lake_analytics.data_lake_store_accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND dataLakeStoreAccountName = '{{ dataLakeStoreAccountName }}' -- 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,
properties,
type
FROM azure.data_lake_analytics.data_lake_store_accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- 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.data_lake_analytics.data_lake_store_accounts
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND dataLakeStoreAccountName = '{{ dataLakeStoreAccountName }}' --required
;

Lifecycle Methods

add

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

EXEC azure.data_lake_analytics.data_lake_store_accounts.add 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@dataLakeStoreAccountName='{{ dataLakeStoreAccountName }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;