Share via

az dls account

  • Preview

Command group 'dls' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage Data Lake Store accounts.

Commands

Name Description Type Status
az dls account create

Creates a Data Lake Store account.

 Core Preview
az dls account delete

Delete a Data Lake Store account.

 Core Preview
az dls account enable-key-vault

Enable the use of Azure Key Vault for encryption of a Data Lake Store account.

 Core Preview
az dls account firewall

Manage Data Lake Store account firewall rules.

 Core Preview
az dls account firewall create

Creates a firewall rule in a Data Lake Store account.

 Core Preview
az dls account firewall delete

Deletes a firewall rule in a Data Lake Store account.

 Core Preview
az dls account firewall list

Lists firewall rules in a Data Lake Store account.

 Core Preview
az dls account firewall show

Get the details of a firewall rule in a Data Lake Store account.

 Core Preview
az dls account firewall update

Updates a firewall rule in a Data Lake Store account.

 Core Preview
az dls account list

Lists available Data Lake Store accounts.

 Core Preview
az dls account show

Get the details of a Data Lake Store account.

 Core Preview
az dls account trusted-provider

Manage Data Lake Store account trusted identity providers.

 Core Preview
az dls account trusted-provider create

Creates or updates the specified trusted identity provider.

 Core Preview
az dls account trusted-provider delete

Deletes the specified trusted identity provider from the specified Data Lake Store account.

 Core Preview
az dls account trusted-provider list

Lists the Data Lake Store trusted identity providers within the specified Data Lake Store account.

 Core Preview
az dls account trusted-provider show

Gets the specified Data Lake Store trusted identity provider.

 Core Preview
az dls account trusted-provider update

Updates the specified trusted identity provider.

 Core Preview
az dls account update

Updates a Data Lake Store account.

 Core Preview

az dls account create

Edit
Preview

Command group 'dls' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Creates a Data Lake Store account.

az dls account create --account
                      [--default-group]
                      [--disable-encryption]
                      [--encryption-type {ServiceManaged, UserManaged}]
                      [--key-name]
                      [--key-vault-id]
                      [--key-version]
                      [--location]
                      [--resource-group]
                      [--tags]
                      [--tier {Commitment_100TB, Commitment_10TB, Commitment_1PB, Commitment_1TB, Commitment_500TB, Commitment_5PB, Consumption}]

Examples

Creates a Data Lake Store account. (autogenerated)

az dls account create --account mydatalakestoragegen1 --resource-group MyResourceGroup

Required Parameters

--account -n

Name of the Data Lake Store account.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--default-group

Name of the default group to give permissions to for freshly created files and folders in the Data Lake Store account.

--disable-encryption

Indicates that the account will not have any form of encryption applied to it.

Property Value
Default value: False
--encryption-type

Indicates what type of encryption to provision the account with. By default, encryption is ServiceManaged. If no encryption is desired, it must be explicitly set with the --disable-encryption flag.

Property Value
Default value: ServiceManaged
Accepted values: ServiceManaged, UserManaged
--key-name

Key name for the user-assigned encryption type.

--key-vault-id

Key vault for the user-assigned encryption type.

--key-version

Key version for the user-assigned encryption type.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--tier

The desired commitment tier for this account to use.

Property Value
Accepted values: Commitment_100TB, Commitment_10TB, Commitment_1PB, Commitment_1TB, Commitment_500TB, Commitment_5PB, Consumption
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az dls account delete

Edit
Preview

Command group 'dls' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a Data Lake Store account.

az dls account delete [--account]
                      [--ids]
                      [--resource-group]
                      [--subscription]

Examples

Delete a Data Lake Store account. (autogenerated)

az dls account delete --account mydatalakestoragegen1

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account -n

Name of the Data Lake Store account.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

If not specified, will attempt to discover the resource group for the specified Data Lake Store account.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az dls account enable-key-vault

Edit
Preview

Command group 'dls' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Enable the use of Azure Key Vault for encryption of a Data Lake Store account.

az dls account enable-key-vault [--account]
                                [--ids]
                                [--resource-group]
                                [--subscription]

Examples

Enable the use of Azure Key Vault for encryption of a Data Lake Store account. (autogenerated)

az dls account enable-key-vault --account mydatalakestoragegen1

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account -n

Name of the Data Lake Store account.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

If not specified, will attempt to discover the resource group for the specified Data Lake Store account.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az dls account list

Edit
Preview

Command group 'dls' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Lists available Data Lake Store accounts.

az dls account list [--resource-group]

Examples

Lists available Data Lake Store accounts. (autogenerated)

az dls account list --resource-group MyResourceGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az dls account show

Edit
Preview

Command group 'dls' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the details of a Data Lake Store account.

az dls account show [--account]
                    [--ids]
                    [--resource-group]
                    [--subscription]

Examples

Get the details of a Data Lake Store account. (autogenerated)

az dls account show --account mydatalakestoragegen1

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account -n

Name of the Data Lake Store account.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

If not specified, will attempt to discover the resource group for the specified Data Lake Store account.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az dls account update

Edit
Preview

Command group 'dls' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Updates a Data Lake Store account.

az dls account update [--account]
                      [--allow-azure-ips {Disabled, Enabled}]
                      [--default-group]
                      [--firewall-state {Disabled, Enabled}]
                      [--ids]
                      [--key-version]
                      [--resource-group]
                      [--subscription]
                      [--tags]
                      [--tier {Commitment_100TB, Commitment_10TB, Commitment_1PB, Commitment_1TB, Commitment_500TB, Commitment_5PB, Consumption}]
                      [--trusted-id-provider-state {Disabled, Enabled}]

Examples

Updates a Data Lake Store account. (autogenerated)

az dls account update --account mydatalakestoragegen1 --allow-azure-ips Enabled --firewall-state Enabled --resource-group MyResourceGroup --subscription MySubscription --tags key=value

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account -n

Name of the Data Lake Store account.

Property Value
Parameter group: Resource Id Arguments
--allow-azure-ips

Allow/block Azure originating IPs through the firewall.

Property Value
Accepted values: Disabled, Enabled
--default-group

Name of the default group to give permissions to for freshly created files and folders in the Data Lake Store account.

--firewall-state

Enable/disable existing firewall rules.

Property Value
Accepted values: Disabled, Enabled
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--key-version

Key version for the user-assigned encryption type.

--resource-group -g

If not specified, will attempt to discover the resource group for the specified Data Lake Store account.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--tier

The desired commitment tier for this account to use.

Property Value
Accepted values: Commitment_100TB, Commitment_10TB, Commitment_1PB, Commitment_1TB, Commitment_500TB, Commitment_5PB, Consumption
--trusted-id-provider-state

Enable/disable the existing trusted ID providers.

Property Value
Accepted values: Disabled, Enabled
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False