accounts

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

Overview

Name	accounts
Type	Resource
Id	azure.data_lake_analytics.accounts

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the details of the specified account.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object	The properties defined by Data Lake Analytics all properties are specific to each resource provider.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_resource_group

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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object	The properties defined by Data Lake Analytics all properties are specific to each resource provider.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

Successfully retrieved the list of Azure Data Lake Analytics accounts.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object	The properties defined by Data Lake Analytics all properties are specific to each resource provider.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName		Gets details of the specified Data Lake Analytics account.
list_by_resource_group	select	subscriptionId, resourceGroupName	$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	subscriptionId	$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	subscriptionId, resourceGroupName, accountName, data__location, data__properties		Creates the specified Data Lake Analytics account. This supplies the user with computation services for Data Lake Analytics workloads.
update	update	subscriptionId, resourceGroupName, accountName		Updates the Data Lake Analytics account object specified by the accountName with the contents of the account object.
delete	delete	subscriptionId, resourceGroupName, accountName		Begins the delete process for the Data Lake Analytics account object specified by the account name.
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 Analytics account.
location	string	The resource location without whitespace.
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 details of the specified Data Lake Analytics account.

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

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,
properties,
type
FROM azure.data_lake_analytics.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 Analytics account. This supplies the user with computation services for Data Lake Analytics workloads.

INSERT INTO azure.data_lake_analytics.accounts (
data__location,
data__tags,
data__properties,
subscriptionId,
resourceGroupName,
accountName
)
SELECT 
'{{ location }}' /* required */,
'{{ tags }}',
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}'
RETURNING
id,
name,
properties,
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: properties
      value: object
      description: |
        The Data Lake Analytics account properties to use for creating.

UPDATE examples

update

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

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

DELETE examples

delete

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

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

Lifecycle Methods

check_name_availability

Checks whether the specified account name is available or taken.

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