Data Lake Store file system - az dls fs

Commands to manage a Data Lake Store filesystem.

These commands are in preview.

Commands

az dls fs access Commands to manage a Data Lake Store filesystem access and permissions.
az dls fs access remove-all Completely removes the existing ACL or default ACL on the file or folder.
az dls fs access remove-entry Updates the existing ACL on the file or folder to remove the entries specified if they exist.
az dls fs access set Replaces the existing ACL on the file or folder with the specified ACL, which must contain all unnamed entries.
az dls fs access set-entry Updates the existing ACL on the file or folder to include or update the entries specified.
az dls fs access set-owner Sets the owner and or owning group for the file or folder in the Data Lake Store account.
az dls fs access set-permission Sets the permission octal for the file or folder in the Data Lake Store account.
az dls fs access show Displays the ACL for a given file or folder.
az dls fs append Appends content to a file in the Data Lake Store account at the path.
az dls fs create Creates a file or folder in the Data Lake Store account at the path.
az dls fs delete Deletes the file or folder in the Data Lake Store account at the path.
az dls fs download Downloads a file or folder from the Data Lake Store account to the local destination path.
az dls fs join Joins the list of files in the Data Lake Store account into one file at the destination path.
az dls fs list Displays the list of files and folder information under the folder in the Data Lake Store account.
az dls fs move Moves the file or folder in the Data Lake Store account to the destination path.
az dls fs preview Previews the content of the file in the Data Lake Store account at the path.
az dls fs remove-expiry Removes the expiration time on a file, if any.
az dls fs set-expiry Sets the absolute expiration time of the file.
az dls fs show Displays file or folder information in the Data Lake Store account at the path.
az dls fs test Tests the existence of the file or folder in the Data Lake Store account at the path.
az dls fs upload Uploads a file or folder to the Data Lake Store account at the destination path.

az dls fs append

Appends content to a file in the Data Lake Store account at the path.

az dls fs append --account
--content
--path

Required Parameters

--account -n

Name of the Data Lake Store account.

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

az dls fs create

Creates a file or folder in the Data Lake Store account at the path.

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

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

Optional content for the file to contain upon creation.

--folder

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

--force

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

az dls fs delete

Deletes the file or folder in the Data Lake Store account at the path.

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

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

--recurse

Indicates this should be a recursive delete of the folder.

az dls fs download

Downloads a file or folder from the Data Lake Store account to the local destination path.

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

Required Parameters

--account -n

Name of the Data Lake Store account.

--destination-path

The full 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 in the format /path/file.txt.

Optional Parameters

--block-size

Number of bytes for a block. Within each chunk, we write a smaller block for each API call. This block cannot be bigger than a chunk.

default value: 4194304
--buffer-size

Number of bytes for internal buffer. This block cannot be bigger than a chunk and cannot be smaller than a block.

default value: 4194304
--chunk-size

Number of bytes for a chunk. Large files are split into chunks. Files smaller than this number will always be transferred in a single thread.

default value: 268435456
--overwrite

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

--thread-count

Optionally specify the parallelism of the download. Default is the number of cores in the local machine.

az dls fs join

Joins the list of files in the Data Lake Store account into one file at the destination path.

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

Required Parameters

--account -n

Name of the Data Lake Store account.

--destination-path

The destination path in the Data Lake Store account where the resulting joined files should be placed.

--source-paths

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

Optional Parameters

--force

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

az dls fs list

Displays the list of files and folder information under the folder in the Data Lake Store account.

az dls fs list --account
--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.

az dls fs move

Moves the file or folder in the Data Lake Store account to the destination path.

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

Required Parameters

--account -n

Name of the Data Lake Store account.

--destination-path

The destination path in the Data Lake Store account where the file or folder should be moved to.

--source-path

The file or folder to move.

Optional Parameters

--force

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

az dls fs preview

Previews the content of the file in the Data Lake Store account at the path.

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

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

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

--length

The optional amount of data to preview in bytes as a long. If not specified, will attempt to preview the full file. If the file is > 1MB --force must be specified.

--offset

The optional position in bytes as a long in the file to start the preview from.

az dls fs remove-expiry

Removes the expiration time on a file, if any.

az dls fs remove-expiry --account
--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.

az dls fs set-expiry

Sets the absolute expiration time of the file.

az dls fs set-expiry --account
--expiration-time
--path

Required Parameters

--account -n

Name of the Data Lake Store account.

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

az dls fs show

Displays file or folder information in the Data Lake Store account at the path.

az dls fs show --account
--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.

az dls fs test

Tests the existence of the file or folder in the Data Lake Store account at the path.

az dls fs test --account
--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.

az dls fs upload

Uploads a file or folder to the Data Lake Store account at the destination path.

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

Required Parameters

--account -n

Name of the Data Lake Store account.

--destination-path

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

--source-path

The full path to the file or folder to upload.

Optional Parameters

--block-size

Number of bytes for a block. Within each chunk, we write a smaller block for each API call. This block cannot be bigger than a chunk.

default value: 4194304
--buffer-size

Number of bytes for internal buffer. This block cannot be bigger than a chunk and cannot be smaller than a block.

default value: 4194304
--chunk-size

Number of bytes for a chunk. Large files are split into chunks. Files smaller than this number will always be transferred in a single thread.

default value: 268435456
--overwrite

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

--thread-count

Optionally specify the parallelism of the upload. Default is the number of cores in the local machine.