accounts

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

Overview

Name	accounts
Type	Resource
Id	azure.data_lake_store.accounts

Fields

vw_accounts

Name	Datatype	Description
id	text	The resource identifier.
name	text	The resource name.
accountName	text	field from the properties object
account_id	text	field from the properties object
creation_time	text	field from the properties object
current_tier	text	field from the properties object
default_group	text	field from the properties object
encryption_config	text	field from the properties object
encryption_provisioning_state	text	field from the properties object
encryption_state	text	field from the properties object
endpoint	text	field from the properties object
firewall_allow_azure_ips	text	field from the properties object
firewall_rules	text	field from the properties object
firewall_state	text	field from the properties object
identity	object	The encryption identity properties.
last_modified_time	text	field from the properties object
location	text	The resource location.
new_tier	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
state	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	The resource tags.
trusted_id_provider_state	text	field from the properties object
trusted_id_providers	text	field from the properties object
type	text	The resource type.
virtual_network_rules	text	field from the properties object

accounts

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

Methods

Name	Accessible by	Required Params	Description
get	SELECT	accountName, resourceGroupName, subscriptionId	Gets the specified Data Lake Store account.
list	SELECT	subscriptionId	Lists the Data Lake Store accounts within the subscription. The response includes a link to the next page of results, if any.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Lists the Data Lake Store accounts within a specific resource group. The response includes a link to the next page of results, if any.
create	INSERT	accountName, resourceGroupName, subscriptionId, data__location	Creates the specified Data Lake Store account.
delete	DELETE	accountName, resourceGroupName, subscriptionId	Deletes the specified Data Lake Store account.
update	UPDATE	accountName, resourceGroupName, subscriptionId	Updates the specified Data Lake Store account information.
check_name_availability	EXEC	location, subscriptionId, data__name, data__type	Checks whether the specified account name is available or taken.
enable_key_vault	EXEC	accountName, resourceGroupName, subscriptionId	Attempts to enable a user managed Key Vault for encryption of the specified Data Lake Store account.

SELECT examples

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

vw_accounts

SELECT
id,
name,
accountName,
account_id,
creation_time,
current_tier,
default_group,
encryption_config,
encryption_provisioning_state,
encryption_state,
endpoint,
firewall_allow_azure_ips,
firewall_rules,
firewall_state,
identity,
last_modified_time,
location,
new_tier,
provisioning_state,
resourceGroupName,
state,
subscriptionId,
tags,
trusted_id_provider_state,
trusted_id_providers,
type,
virtual_network_rules
FROM azure.data_lake_store.vw_accounts
WHERE subscriptionId = '{{ subscriptionId }}';

accounts

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

INSERT example

Use the following StackQL query and manifest file to create a new accounts resource.

All Properties

/*+ create */
INSERT INTO azure.data_lake_store.accounts (
accountName,
resourceGroupName,
subscriptionId,
data__location,
location,
tags,
identity,
properties
)
SELECT 
'{{ accountName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__location }}',
'{{ location }}',
'{{ tags }}',
'{{ identity }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: location
      value: string
    - name: tags
      value: object
    - name: identity
      value:
        - name: type
          value: string
        - name: principalId
          value: string
        - name: tenantId
          value: string
    - name: properties
      value:
        - name: defaultGroup
          value: string
        - name: encryptionConfig
          value:
            - name: type
              value: string
            - name: keyVaultMetaInfo
              value:
                - name: keyVaultResourceId
                  value: string
                - name: encryptionKeyName
                  value: string
                - name: encryptionKeyVersion
                  value: string
        - name: encryptionState
          value: string
        - name: firewallRules
          value:
            - - name: name
                value: string
              - name: properties
                value:
                  - name: startIpAddress
                    value: string
                  - name: endIpAddress
                    value: string
        - name: virtualNetworkRules
          value:
            - - name: name
                value: string
              - name: properties
                value:
                  - name: subnetId
                    value: string
        - name: firewallState
          value: string
        - name: firewallAllowAzureIps
          value: string
        - name: trustedIdProviders
          value:
            - - name: name
                value: string
              - name: properties
                value:
                  - name: idProvider
                    value: string
        - name: trustedIdProviderState
          value: string
        - name: newTier
          value: string

UPDATE example

Updates a accounts resource.

/*+ update */
UPDATE azure.data_lake_store.accounts
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
accountName = '{{ accountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified accounts resource.

/*+ delete */
DELETE FROM azure.data_lake_store.accounts
WHERE accountName = '{{ accountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';