accounts

Creates, updates, deletes, gets or lists an accounts resource.

Overview

Name	accounts
Type	Resource
Id	azure.data_lake_store.accounts

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved details of the specified account.

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
identity	object	The Key Vault encryption identity, if any.
location	string	The resource location.
properties	object	The Data Lake Store account properties.
tags	object	The resource tags.
type	string	The resource type.

list_by_resource_group

Successfully retrieved the list of accounts in the specified resource group.

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

list

Successfully retrieved the list of accounts.

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
location	string	The resource location.
properties	object	The basic Data Lake Store account properties.
tags	object	The resource tags.
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		Gets the specified Data Lake Store account.
list_by_resource_group	select	subscriptionId, resourceGroupName	$filter, $top, $skip, $select, $orderby, $count	Lists the Data Lake Store accounts within a specific resource group. The response includes a link to the next page of results, if any.
list	select	subscriptionId	$filter, $top, $skip, $select, $orderby, $count	Lists the Data Lake Store accounts within the subscription. The response includes a link to the next page of results, if any.
create	insert	subscriptionId, resourceGroupName, accountName, data__location		Creates the specified Data Lake Store account.
update	update	subscriptionId, resourceGroupName, accountName		Updates the specified Data Lake Store account information.
delete	delete	subscriptionId, resourceGroupName, accountName		Deletes the specified Data Lake Store account.
enable_key_vault	exec	subscriptionId, resourceGroupName, accountName		Attempts to enable a user managed Key Vault for encryption of the specified Data Lake Store account.
check_name_availability	exec	subscriptionId, location, name, type		Checks whether the specified account name is available or taken.

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 Store account.
location	string	The resource location without whitespace.
resourceGroupName	string	The name of the Azure resource group.
subscriptionId	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
$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.

SELECT
id,
name,
identity,
location,
properties,
tags,
type
FROM azure.data_lake_store.accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
;

list_by_resource_group

Lists the Data Lake Store accounts within a specific resource group. The response includes a link to the next page of results, if any.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.data_lake_store.accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
AND $select = '{{ $select }}'
AND $orderby = '{{ $orderby }}'
AND $count = '{{ $count }}'
;

list

Lists the Data Lake Store accounts within the subscription. The response includes a link to the next page of results, if any.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.data_lake_store.accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
AND $select = '{{ $select }}'
AND $orderby = '{{ $orderby }}'
AND $count = '{{ $count }}'
;

INSERT examples

create

Creates the specified Data Lake Store account.

INSERT INTO azure.data_lake_store.accounts (
data__location,
data__tags,
data__identity,
data__properties,
subscriptionId,
resourceGroupName,
accountName
)
SELECT 
'{{ location }}' /* required */,
'{{ tags }}',
'{{ identity }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}'
RETURNING
id,
name,
identity,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: accounts
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the accounts resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the accounts resource.
    - name: accountName
      value: string
      description: Required parameter for the accounts resource.
    - name: location
      value: string
      description: |
        The resource location.
    - name: tags
      value: object
      description: |
        The resource tags.
    - name: identity
      value: object
      description: |
        The Key Vault encryption identity, if any.
    - name: properties
      value: object
      description: |
        The Data Lake Store account properties to use for creating.

UPDATE examples

update

Updates the specified Data Lake Store account information.

UPDATE azure.data_lake_store.accounts
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
RETURNING
id,
name,
identity,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes the specified Data Lake Store account.

DELETE FROM azure.data_lake_store.accounts
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
;

Lifecycle Methods

enable_key_vault

Attempts to enable a user managed Key Vault for encryption of the specified Data Lake Store account.

EXEC azure.data_lake_store.accounts.enable_key_vault 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required
;

check_name_availability

Checks whether the specified account name is available or taken.

EXEC azure.data_lake_store.accounts.check_name_availability 
@subscriptionId='{{ subscriptionId }}' --required, 
@location='{{ location }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;