accounts

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

Overview

Name	accounts
Type	Resource
Id	azure.datalake_analytics.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 Analytics account name is not available, if nameAvailable is false.
nameAvailable	boolean	The Boolean value of true or false to indicate whether the Data Lake Analytics account name is available or not.
reason	string	The reason why the Data Lake Analytics 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 Analytics account.
computePolicies	array	The list of compute policies associated with this 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_100AUHours", "Commitment_500AUHours", "Commitment_1000AUHours", "Commitment_5000AUHours", "Commitment_10000AUHours", "Commitment_50000AUHours", "Commitment_100000AUHours", and "Commitment_500000AUHours".
dataLakeStoreAccounts	array	The list of Data Lake Store accounts associated with this account.
debugDataAccessLevel	string	The current state of the DebugDataAccessLevel for this account. Known values are: "All", "Customer", and "None".
defaultDataLakeStoreAccount	string	The default Data Lake Store account associated with this account.
defaultDataLakeStoreAccountType	string	The type of the default Data Lake Store account associated with this account.
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 account.
firewallState	string	The current state of the IP address firewall for this account. Known values are: "Enabled" and "Disabled".
hiveMetastores	array	The list of hiveMetastores associated with this account.
lastModifiedTime	string (date-time)	The account last modified time.
location	string	The resource location.
maxActiveJobCountPerUser	integer	The maximum supported active jobs under the account at the same time.
maxDegreeOfParallelism	integer	The maximum supported degree of parallelism for this account.
maxDegreeOfParallelismPerJob	integer	The maximum supported degree of parallelism per job for this account.
maxJobCount	integer	The maximum supported jobs running under the account at the same time.
maxJobRunningTimeInMin	integer	The maximum supported active jobs under the account at the same time.
maxQueuedJobCountPerUser	integer	The maximum supported jobs queued under the account at the same time.
minPriorityPerJob	integer	The minimum supported priority per job for this account.
newTier	string	The commitment tier for the next month. Known values are: "Consumption", "Commitment_100AUHours", "Commitment_500AUHours", "Commitment_1000AUHours", "Commitment_5000AUHours", "Commitment_10000AUHours", "Commitment_50000AUHours", "Commitment_100000AUHours", and "Commitment_500000AUHours".
provisioningState	string	The provisioning status of the Data Lake Analytics account. Known values are: "Failed", "Creating", "Running", "Succeeded", "Patching", "Suspending", "Resuming", "Deleting", "Deleted", "Undeleting", and "Canceled".
publicDataLakeStoreAccounts	array	The list of Data Lake Store accounts associated with this account.
queryStoreRetention	integer	The number of days that job metadata is retained.
state	string	The state of the Data Lake Analytics account. Known values are: "Active" and "Suspended".
storageAccounts	array	The list of Azure Blob Storage accounts associated with this account.
systemMaxDegreeOfParallelism	integer	The system defined maximum supported degree of parallelism for this account, which restricts the maximum value of parallelism the user can set for the account.
systemMaxJobCount	integer	The system defined maximum supported jobs running under the account at the same time, which restricts the maximum number of running jobs the user can set for the account.
tags	object	The resource tags.
type	string	The resource type.
virtualNetworkRules	array	The list of virtualNetwork rules associated with this 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 Analytics 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 Analytics account. Known values are: "Failed", "Creating", "Running", "Succeeded", "Patching", "Suspending", "Resuming", "Deleting", "Deleted", "Undeleting", and "Canceled".
state	string	The state of the Data Lake Analytics 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 Analytics 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 Analytics account. Known values are: "Failed", "Creating", "Running", "Succeeded", "Patching", "Suspending", "Resuming", "Deleting", "Deleted", "Undeleting", and "Canceled".
state	string	The state of the Data Lake Analytics 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 details of the specified Data Lake Analytics account.
list_by_resource_group	select	resource_group_name, subscription_id	$filter, $top, $skip, $select, $orderby, $count	Gets the first page of Data Lake Analytics accounts, if any, within a specific resource group. This includes a link to the next page, if any.
list	select	subscription_id	$filter, $top, $skip, $select, $orderby, $count	Gets the first page of Data Lake Analytics accounts, if any, within the current subscription. This includes a link to the next page, if any.
create	insert	resource_group_name, account_name, subscription_id, location, properties		Creates the specified Data Lake Analytics account. This supplies the user with computation services for Data Lake Analytics workloads.
update	update	resource_group_name, account_name, subscription_id		Updates the Data Lake Analytics account object specified by the accountName with the contents of the account object.
delete	delete	resource_group_name, account_name, subscription_id		Begins the delete process for the Data Lake Analytics account object specified by the account name.

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.
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_analytics.accounts
WHERE location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Gets details of the specified Data Lake Analytics account.

SELECT
id,
name,
accountId,
computePolicies,
creationTime,
currentTier,
dataLakeStoreAccounts,
debugDataAccessLevel,
defaultDataLakeStoreAccount,
defaultDataLakeStoreAccountType,
endpoint,
firewallAllowAzureIps,
firewallRules,
firewallState,
hiveMetastores,
lastModifiedTime,
location,
maxActiveJobCountPerUser,
maxDegreeOfParallelism,
maxDegreeOfParallelismPerJob,
maxJobCount,
maxJobRunningTimeInMin,
maxQueuedJobCountPerUser,
minPriorityPerJob,
newTier,
provisioningState,
publicDataLakeStoreAccounts,
queryStoreRetention,
state,
storageAccounts,
systemMaxDegreeOfParallelism,
systemMaxJobCount,
tags,
type,
virtualNetworkRules
FROM azure.datalake_analytics.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

Gets the first page of Data Lake Analytics accounts, if any, within a specific resource group. This includes a link to the next page, if any.

SELECT
id,
name,
accountId,
creationTime,
endpoint,
lastModifiedTime,
location,
provisioningState,
state,
tags,
type
FROM azure.datalake_analytics.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

Gets the first page of Data Lake Analytics accounts, if any, within the current subscription. This includes a link to the next page, if any.

SELECT
id,
name,
accountId,
creationTime,
endpoint,
lastModifiedTime,
location,
provisioningState,
state,
tags,
type
FROM azure.datalake_analytics.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 Analytics account. This supplies the user with computation services for Data Lake Analytics workloads.

INSERT INTO azure.datalake_analytics.accounts (
location,
tags,
properties,
resource_group_name,
account_name,
subscription_id
)
SELECT 
'{{ location }}' /* required */,
'{{ tags }}',
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
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: properties
    value:
      defaultDataLakeStoreAccount: "{{ defaultDataLakeStoreAccount }}"
      dataLakeStoreAccounts:
        - name: "{{ name }}"
          properties:
            suffix: "{{ suffix }}"
      storageAccounts:
        - name: "{{ name }}"
          properties:
            accessKey: "{{ accessKey }}"
            suffix: "{{ suffix }}"
      computePolicies:
        - name: "{{ name }}"
          properties:
            objectId: "{{ objectId }}"
            objectType: "{{ objectType }}"
            maxDegreeOfParallelismPerJob: {{ maxDegreeOfParallelismPerJob }}
            minPriorityPerJob: {{ minPriorityPerJob }}
      firewallRules:
        - name: "{{ name }}"
          properties:
            startIpAddress: "{{ startIpAddress }}"
            endIpAddress: "{{ endIpAddress }}"
      firewallState: "{{ firewallState }}"
      firewallAllowAzureIps: "{{ firewallAllowAzureIps }}"
      newTier: "{{ newTier }}"
      maxJobCount: {{ maxJobCount }}
      maxDegreeOfParallelism: {{ maxDegreeOfParallelism }}
      maxDegreeOfParallelismPerJob: {{ maxDegreeOfParallelismPerJob }}
      minPriorityPerJob: {{ minPriorityPerJob }}
      queryStoreRetention: {{ queryStoreRetention }}

UPDATE examples

update

Updates the Data Lake Analytics account object specified by the accountName with the contents of the account object.

UPDATE azure.datalake_analytics.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,
location,
properties,
tags,
type;

DELETE examples

delete

Begins the delete process for the Data Lake Analytics account object specified by the account name.

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