Share via

az dls fs

  • Preview
  • Reference

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

Manage a Data Lake Store filesystem.

Commands

Name Description Type Status
az dls fs access

Manage Data Lake Store filesystem access and permissions.

 Core Preview
az dls fs access remove-all

Remove the access control list for a file or folder.

 Core Preview
az dls fs access remove-entry

Remove entries for the access control list of a file or folder.

 Core Preview
az dls fs access set

Replace the existing access control list for a file or folder.

 Core Preview
az dls fs access set-entry

Update the access control list for a file or folder.

 Core Preview
az dls fs access set-owner

Set the owner information for a file or folder in a Data Lake Store account.

 Core Preview
az dls fs access set-permission

Set the permissions for a file or folder in a Data Lake Store account.

 Core Preview
az dls fs access show

Display the access control list (ACL).

 Core Preview
az dls fs append

Append content to a file in a Data Lake Store account.

 Core Preview
az dls fs create

Creates a file or folder in a Data Lake Store account.

 Core Preview
az dls fs delete

Delete a file or folder in a Data Lake Store account.

 Core Preview
az dls fs download

Download a file or folder from a Data Lake Store account to the local machine.

 Core Preview
az dls fs join

Join files in a Data Lake Store account into one file.

 Core Preview
az dls fs list

List the files and folders in a Data Lake Store account.

 Core Preview
az dls fs move

Move a file or folder in a Data Lake Store account.

 Core Preview
az dls fs preview

Preview the content of a file in a Data Lake Store account.

 Core Preview
az dls fs remove-expiry

Remove the expiration time for a file.

 Core Preview
az dls fs set-expiry

Set the expiration time for a file.

 Core Preview
az dls fs show

Get file or folder information in a Data Lake Store account.

 Core Preview
az dls fs test

Test for the existence of a file or folder in a Data Lake Store account.

 Core Preview
az dls fs upload

Upload a file or folder to a Data Lake Store account.

 Core Preview

az dls fs append

Edit
Preview

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

Append content to a file in a Data Lake Store account.

az dls fs append --content
                 --path
                 [--account]
                 [--ids]
                 [--subscription]

Required Parameters

--content

Content to be appended to the file.

--path

The path in the specified Data Lake Store account where the action should take place. In the format '/folder/file.txt', where the first '/' after the DNS indicates the root of the file system.

Optional Parameters

--account -n

Name of the Data Lake Store account.

--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.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az dls fs create

Edit
Preview

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

Creates a file or folder in a Data Lake Store account.

az dls fs create --account
                 --path
                 [--content]
                 [--folder]
                 [--force]

Examples

Creates a file or folder in a Data Lake Store account. (autogenerated)

az dls fs create --account {account} --folder  --path {path}

Required Parameters

--account -n

Name of the Data Lake Store account.

--path

The path in the specified Data Lake Store account where the action should take place. In the format '/folder/file.txt', where the first '/' after the DNS indicates the root of the file system.

Optional Parameters

--content

Content for the file to contain upon creation.

--folder

Indicates that this new item is a folder and not a file.

Default value: False
--force

Indicates that, if the file or folder exists, it should be overwritten.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az dls fs delete

Edit
Preview

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

Delete a file or folder in a Data Lake Store account.

az dls fs delete --path
                 [--account]
                 [--ids]
                 [--recurse]
                 [--subscription]

Examples

Delete a file or folder in a Data Lake Store account. (autogenerated)

az dls fs delete --account {account} --path {path}

Required Parameters

--path

The path in the specified Data Lake Store account where the action should take place. In the format '/folder/file.txt', where the first '/' after the DNS indicates the root of the file system.

Optional Parameters

--account -n

Name of the Data Lake Store account.

--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.

--recurse

Indicates this should be a recursive delete of the folder.

Default value: False
--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az dls fs download

Edit
Preview

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

Download a file or folder from a Data Lake Store account to the local machine.

az dls fs download --destination-path
                   --source-path
                   [--account]
                   [--block-size]
                   [--buffer-size]
                   [--chunk-size]
                   [--ids]
                   [--overwrite]
                   [--subscription]
                   [--thread-count]

Examples

Download a file or folder from a Data Lake Store account to the local machine. (autogenerated)

az dls fs download --account {account} --destination-path {destination-path} --source-path {source-path}

Required Parameters

--destination-path

The local path where the file or folder will be downloaded to.

--source-path

The full path in the Data Lake Store filesystem to download the file or folder from.

Optional Parameters

--account -n

Name of the Data Lake Store account.

--block-size

Size of a block, in bytes.

Within each chunk, a smaller block is written for each API call. A block cannot be bigger than a chunk and must be bigger than a buffer.

Default value: 4194304
--buffer-size

Size of the transfer buffer, in bytes.

A buffer cannot be bigger than a chunk and cannot be smaller than a block.

Default value: 4194304
--chunk-size

Size of a chunk, in bytes.

Large files are split into chunks. Files smaller than this size will always be transferred in a single thread.

Default value: 268435456
--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.

--overwrite

Indicates that, if the destination file or folder exists, it should be overwritten.

Default value: False
--subscription

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

--thread-count

Parallelism of the download. Default: The number of cores in the local machine.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az dls fs join

Edit
Preview

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

Join files in a Data Lake Store account into one file.

az dls fs join --destination-path
               --source-paths
               [--account]
               [--force]
               [--ids]
               [--subscription]

Required Parameters

--destination-path

The destination path in the Data Lake Store account.

--source-paths

The space-separated list of files in the Data Lake Store account to join.

Optional Parameters

--account -n

Name of the Data Lake Store account.

--force

Indicates that, if the destination file already exists, it should be overwritten.

Default value: False
--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.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az dls fs list

Edit
Preview

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

List the files and folders in a Data Lake Store account.

az dls fs list --path
               [--account]
               [--ids]
               [--subscription]

Examples

List the files and folders in a Data Lake Store account. (autogenerated)

az dls fs list --account {account} --path {path}

Required Parameters

--path

The path in the specified Data Lake Store account where the action should take place. In the format '/folder/file.txt', where the first '/' after the DNS indicates the root of the file system.

Optional Parameters

--account -n

Name of the Data Lake Store account.

--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.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az dls fs move

Edit
Preview

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

Move a file or folder in a Data Lake Store account.

az dls fs move --destination-path
               --source-path
               [--account]
               [--force]
               [--ids]
               [--subscription]

Examples

Move a file or folder in a Data Lake Store account. (autogenerated)

az dls fs move --account {account} --destination-path {destination-path} --source-path {source-path}

Required Parameters

--destination-path

The destination path in the Data Lake Store account.

--source-path

The file or folder to move.

Optional Parameters

--account -n

Name of the Data Lake Store account.

--force

Indicates that, if the destination file or folder already exists, it should be overwritten and replaced with the file or folder being moved.

Default value: False
--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.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az dls fs preview

Edit
Preview

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

Preview the content of a file in a Data Lake Store account.

az dls fs preview --path
                  [--account]
                  [--force]
                  [--ids]
                  [--length]
                  [--offset]
                  [--subscription]

Required Parameters

--path

The path in the specified Data Lake Store account where the action should take place. In the format '/folder/file.txt', where the first '/' after the DNS indicates the root of the file system.

Optional Parameters

--account -n

Name of the Data Lake Store account.

--force

Indicates that, if the preview is larger than 1MB, still retrieve it. This can potentially be very slow, depending on how large the file is.

Default value: False
--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.

--length

The amount of data to preview in bytes.

If not specified, attempts to preview the full file. If the file is > 1MB --force must be specified.

--offset

The position in bytes to start the preview from.

Default value: 0
--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az dls fs remove-expiry

Edit
Preview

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

Remove the expiration time for a file.

az dls fs remove-expiry --path
                        [--account]
                        [--ids]
                        [--subscription]

Required Parameters

--path

The path in the specified Data Lake Store account where the action should take place. In the format '/folder/file.txt', where the first '/' after the DNS indicates the root of the file system.

Optional Parameters

--account -n

Name of the Data Lake Store account.

--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.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az dls fs set-expiry

Edit
Preview

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

Set the expiration time for a file.

az dls fs set-expiry --expiration-time
                     --path
                     [--account]
                     [--ids]
                     [--subscription]

Required Parameters

--expiration-time

The absolute value of the expiration time expressed as milliseconds since the epoch.

--path

The path in the specified Data Lake Store account where the action should take place. In the format '/folder/file.txt', where the first '/' after the DNS indicates the root of the file system.

Optional Parameters

--account -n

Name of the Data Lake Store account.

--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.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az dls fs show

Edit
Preview

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

Get file or folder information in a Data Lake Store account.

az dls fs show --path
               [--account]
               [--ids]
               [--subscription]

Examples

Get file or folder information in a Data Lake Store account. (autogenerated)

az dls fs show --account {account} --path {path}

Required Parameters

--path

The path in the specified Data Lake Store account where the action should take place. In the format '/folder/file.txt', where the first '/' after the DNS indicates the root of the file system.

Optional Parameters

--account -n

Name of the Data Lake Store account.

--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.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az dls fs test

Edit
Preview

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

Test for the existence of a file or folder in a Data Lake Store account.

az dls fs test --path
               [--account]
               [--ids]
               [--subscription]

Examples

Test for the existence of a file or folder in a Data Lake Store account. (autogenerated)

az dls fs test --account {account} --path {path}

Required Parameters

--path

The path in the specified Data Lake Store account where the action should take place. In the format '/folder/file.txt', where the first '/' after the DNS indicates the root of the file system.

Optional Parameters

--account -n

Name of the Data Lake Store account.

--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.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az dls fs upload

Edit
Preview

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

Upload a file or folder to a Data Lake Store account.

az dls fs upload --destination-path
                 --source-path
                 [--account]
                 [--block-size]
                 [--buffer-size]
                 [--chunk-size]
                 [--ids]
                 [--overwrite]
                 [--subscription]
                 [--thread-count]

Examples

Upload a file or folder to a Data Lake Store account. (autogenerated)

az dls fs upload --account {account} --destination-path {destination-path} --overwrite  --source-path {source-path}

Required Parameters

--destination-path

The full path in the Data Lake Store filesystem to upload the file or folder to.

--source-path

The path to the file or folder to upload.

Optional Parameters

--account -n

Name of the Data Lake Store account.

--block-size

Size of a block, in bytes.

Within each chunk, a smaller block is written for each API call. A block cannot be bigger than a chunk and must be bigger than a buffer.

Default value: 4194304
--buffer-size

Size of the transfer buffer, in bytes.

A buffer cannot be bigger than a chunk and cannot be smaller than a block.

Default value: 4194304
--chunk-size

Size of a chunk, in bytes.

Large files are split into chunks. Files smaller than this size will always be transferred in a single thread.

Default value: 268435456
--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.

--overwrite

Indicates that, if the destination file or folder exists, it should be overwritten.

Default value: False
--subscription

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

--thread-count

Parallelism of the upload. Default: The number of cores in the local machine.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.