accounts

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

Overview

Name	accounts
Type	Resource
Id	azure.datalake_store.accounts

Fields

The following fields are returned by SELECT queries:

check_name_availability

Name	Datatype	Description
message	string	The message describing why the Data Lake Store account name is not available, if nameAvailable is false.
nameAvailable	boolean	The Boolean value of true or false to indicate whether the Data Lake Store account name is available or not.
reason	string	The reason why the Data Lake Store account name is not available, if nameAvailable is false.

get

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
accountId	string	The unique identifier associated with this Data Lake Store account.
creationTime	string (date-time)	The account creation time.
currentTier	string	The commitment tier in use for the current month. Known values are: "Consumption", "Commitment_1TB", "Commitment_10TB", "Commitment_100TB", "Commitment_500TB", "Commitment_1PB", and "Commitment_5PB".
defaultGroup	string	The default owner group for all new folders and files created in the Data Lake Store account.
encryptionConfig	object	The Key Vault encryption configuration.
encryptionProvisioningState	string	The current state of encryption provisioning for this Data Lake Store account. Known values are: "Creating" and "Succeeded".
encryptionState	string	The current state of encryption for this Data Lake Store account. Known values are: "Enabled" and "Disabled".
endpoint	string	The full CName endpoint for this account.
firewallAllowAzureIps	string	The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. Known values are: "Enabled" and "Disabled".
firewallRules	array	The list of firewall rules associated with this Data Lake Store account.
firewallState	string	The current state of the IP address firewall for this Data Lake Store account. Known values are: "Enabled" and "Disabled".
identity	object	The Key Vault encryption identity, if any.
lastModifiedTime	string (date-time)	The account last modified time.
location	string	The resource location.
newTier	string	The commitment tier to use for next month. Known values are: "Consumption", "Commitment_1TB", "Commitment_10TB", "Commitment_100TB", "Commitment_500TB", "Commitment_1PB", and "Commitment_5PB".
provisioningState	string	The provisioning status of the Data Lake Store account. Known values are: "Failed", "Creating", "Running", "Succeeded", "Patching", "Suspending", "Resuming", "Deleting", "Deleted", "Undeleting", and "Canceled".
state	string	The state of the Data Lake Store account. Known values are: "Active" and "Suspended".
tags	object	The resource tags.
trustedIdProviderState	string	The current state of the trusted identity provider feature for this Data Lake Store account. Known values are: "Enabled" and "Disabled".
trustedIdProviders	array	The list of trusted identity providers associated with this Data Lake Store account.
type	string	The resource type.
virtualNetworkRules	array	The list of virtual network rules associated with this Data Lake Store account.

list_by_resource_group

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
accountId	string	The unique identifier associated with this Data Lake Store account.
creationTime	string (date-time)	The account creation time.
endpoint	string	The full CName endpoint for this account.
lastModifiedTime	string (date-time)	The account last modified time.
location	string	The resource location.
provisioningState	string	The provisioning status of the Data Lake Store account. Known values are: "Failed", "Creating", "Running", "Succeeded", "Patching", "Suspending", "Resuming", "Deleting", "Deleted", "Undeleting", and "Canceled".
state	string	The state of the Data Lake Store account. Known values are: "Active" and "Suspended".
tags	object	The resource tags.
type	string	The resource type.

list

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
accountId	string	The unique identifier associated with this Data Lake Store account.
creationTime	string (date-time)	The account creation time.
endpoint	string	The full CName endpoint for this account.
lastModifiedTime	string (date-time)	The account last modified time.
location	string	The resource location.
provisioningState	string	The provisioning status of the Data Lake Store account. Known values are: "Failed", "Creating", "Running", "Succeeded", "Patching", "Suspending", "Resuming", "Deleting", "Deleted", "Undeleting", and "Canceled".
state	string	The state of the Data Lake Store account. Known values are: "Active" and "Suspended".
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
check_name_availability	select	location, subscription_id		Checks whether the specified account name is available or taken.
get	select	resource_group_name, account_name, subscription_id		Gets the specified Data Lake Store account.
list_by_resource_group	select	resource_group_name, subscription_id	$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	subscription_id	$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	resource_group_name, account_name, subscription_id, location		Creates the specified Data Lake Store account.
update	update	resource_group_name, account_name, subscription_id		Updates the specified Data Lake Store account information.
delete	delete	resource_group_name, account_name, subscription_id		Deletes the specified Data Lake Store account.
enable_key_vault	exec	resource_group_name, account_name, subscription_id		Attempts to enable a user managed Key Vault for encryption of the specified 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 Store account. Required.
location	string	The resource location without whitespace. 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

check_name_availability

Checks whether the specified account name is available or taken.

SELECT
message,
nameAvailable,
reason
FROM azure.datalake_store.accounts
WHERE location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Gets the specified Data Lake Store account.

SELECT
id,
name,
accountId,
creationTime,
currentTier,
defaultGroup,
encryptionConfig,
encryptionProvisioningState,
encryptionState,
endpoint,
firewallAllowAzureIps,
firewallRules,
firewallState,
identity,
lastModifiedTime,
location,
newTier,
provisioningState,
state,
tags,
trustedIdProviderState,
trustedIdProviders,
type,
virtualNetworkRules
FROM azure.datalake_store.accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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,
accountId,
creationTime,
endpoint,
lastModifiedTime,
location,
provisioningState,
state,
tags,
type
FROM azure.datalake_store.accounts
WHERE resource_group_name = '{{ resource_group_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 }}'
;

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,
accountId,
creationTime,
endpoint,
lastModifiedTime,
location,
provisioningState,
state,
tags,
type
FROM azure.datalake_store.accounts
WHERE subscription_id = '{{ subscription_id }}' -- 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.datalake_store.accounts (
location,
tags,
identity,
properties,
resource_group_name,
account_name,
subscription_id
)
SELECT 
'{{ location }}' /* required */,
'{{ tags }}',
'{{ identity }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: accounts
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the accounts resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the accounts resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the accounts resource.
  - name: location
    value: "{{ location }}"
    description: |
      The resource location. Required.
  - name: tags
    value: "{{ tags }}"
    description: |
      The resource tags.
  - name: identity
    description: |
      The Key Vault encryption identity, if any.
    value:
      type: "{{ type }}"
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
  - name: properties
    value:
      defaultGroup: "{{ defaultGroup }}"
      encryptionConfig:
        type: "{{ type }}"
        keyVaultMetaInfo:
          keyVaultResourceId: "{{ keyVaultResourceId }}"
          encryptionKeyName: "{{ encryptionKeyName }}"
          encryptionKeyVersion: "{{ encryptionKeyVersion }}"
      encryptionState: "{{ encryptionState }}"
      firewallRules:
        - name: "{{ name }}"
          properties:
            startIpAddress: "{{ startIpAddress }}"
            endIpAddress: "{{ endIpAddress }}"
      virtualNetworkRules:
        - name: "{{ name }}"
          properties:
            subnetId: "{{ subnetId }}"
      firewallState: "{{ firewallState }}"
      firewallAllowAzureIps: "{{ firewallAllowAzureIps }}"
      trustedIdProviders:
        - name: "{{ name }}"
          properties:
            idProvider: "{{ idProvider }}"
      trustedIdProviderState: "{{ trustedIdProviderState }}"
      newTier: "{{ newTier }}"

UPDATE examples

update

Updates the specified Data Lake Store account information.

UPDATE azure.datalake_store.accounts
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes the specified Data Lake Store account.

DELETE FROM azure.datalake_store.accounts
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --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.datalake_store.accounts.enable_key_vault 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;