az storage fs

  • Reference

Manage file systems in Azure Data Lake Storage Gen2 account.

Commands

az storage fs access

Manage file system access and permissions for Azure Data Lake Storage Gen2 account.
az storage fs access set

Set the access control properties of a path(directory or file) in Azure Data Lake Storage Gen2 account.
az storage fs access show

Show the access control properties of a path (directory or file) in Azure Data Lake Storage Gen2 account.
az storage fs create

Create file system for Azure Data Lake Storage Gen2 account.
az storage fs delete

Delete a file system in ADLS Gen2 account.
az storage fs directory

Manage directories in Azure Data Lake Storage Gen2 account.
az storage fs directory create

Create a directory in ADLS Gen2 file system.
az storage fs directory delete

Delete a directory in ADLS Gen2 file system.
az storage fs directory exists

Check for the existence of a directory in ADLS Gen2 file system.
az storage fs directory list

List directories in ADLS Gen2 file system.
az storage fs directory metadata

Manage the metadata for directory in file system.
az storage fs directory metadata show

Return all user-defined metadata for the specified directory.
az storage fs directory metadata update

Sets one or more user-defined name-value pairs for the specified file system.
az storage fs directory move

Move a directory in ADLS Gen2 file system.
az storage fs directory show

Show properties of a directory in ADLS Gen2 file system.
az storage fs exists

Check for the existence of a file system in ADLS Gen2 account.
az storage fs file

Manage files in Azure Data Lake Storage Gen2 account.
az storage fs file append

Append content to a file in ADLS Gen2 file system.
az storage fs file create

Create a new file in ADLS Gen2 file system.
az storage fs file delete

Delete a file in ADLS Gen2 file system.
az storage fs file download

Download a file from the specified path in ADLS Gen2 file system.
az storage fs file exists

Check for the existence of a file in ADLS Gen2 file system.
az storage fs file list

List files and directories in ADLS Gen2 file system.
az storage fs file metadata

Manage the metadata for file in file system.
az storage fs file metadata show

Returns all user-defined metadata, standard HTTP properties, and system properties for the file.
az storage fs file metadata update

Sets one or more user-defined name-value pairs for the specified file system.
az storage fs file move

Move a file in ADLS Gen2 Account.
az storage fs file show

Show properties of file in ADLS Gen2 file system.
az storage fs file upload

Upload a file to a file path in ADLS Gen2 file system.
az storage fs list

List file systems in ADLS Gen2 account.
az storage fs metadata

Manage the metadata for file system.
az storage fs metadata show

Return all user-defined metadata for the specified file system.
az storage fs metadata update

Sets one or more user-defined name-value pairs for the specified file system.
az storage fs show

Show properties of file system in ADLS Gen2 account.

az storage fs create

Edit

Create file system for Azure Data Lake Storage Gen2 account.

az storage fs create --name
                     [--account-key]
                     [--account-name]
                     [--auth-mode {key, login}]
                     [--connection-string]
                     [--metadata]
                     [--public-access {file, filesystem, off}]
                     [--sas-token]
                     [--subscription]
                     [--timeout]

Examples

Create file system for Azure Data Lake Storage Gen2 account.

az storage fs create -n fsname --account-name mystorageaccount --account-key 0000-0000

Create file system for Azure Data Lake Storage Gen2 account and enable public access.

az storage fs create -n fsname --public-access file --account-name mystorageaccount --account-key 0000-0000

Required Parameters

--name -n

File system name.

Optional Parameters

--account-key

Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.

--account-name

Storage account name. Related environment variable: AZURE_STORAGE_ACCOUNT. Must be used in conjunction with either storage account key or a SAS token. If neither are present, the command will try to query the storage account key using the authenticated Azure account. If a large number of storage commands are executed the API quota may be hit.

--auth-mode

The mode in which to run the command. "login" mode will directly use your login credentials for the authentication. The legacy "key" mode will attempt to query for an account key if no authentication parameters for the account are provided. Environment variable: AZURE_STORAGE_AUTH_MODE.

accepted values: key, login
--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--metadata

Metadata in space-separated key=value pairs. This overwrites any existing metadata.

--public-access

Specify whether data in the file system may be accessed publicly and the level of access.

accepted values: file, filesystem, off
--sas-token

A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.

--subscription

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

--timeout

Request timeout in seconds. Applies to each call to the service.

az storage fs delete

Edit

Delete a file system in ADLS Gen2 account.

az storage fs delete --name
                     [--account-key]
                     [--account-name]
                     [--auth-mode {key, login}]
                     [--connection-string]
                     [--sas-token]
                     [--subscription]
                     [--timeout]
                     [--yes]

Examples

Delete a file system in ADLS Gen2 account.

az storage fs delete -n myfilesystem --account-name myadlsaccount --account-key 0000-0000

Required Parameters

--name -n

File system name.

Optional Parameters

--account-key

Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.

--account-name

Storage account name. Related environment variable: AZURE_STORAGE_ACCOUNT. Must be used in conjunction with either storage account key or a SAS token. If neither are present, the command will try to query the storage account key using the authenticated Azure account. If a large number of storage commands are executed the API quota may be hit.

--auth-mode

The mode in which to run the command. "login" mode will directly use your login credentials for the authentication. The legacy "key" mode will attempt to query for an account key if no authentication parameters for the account are provided. Environment variable: AZURE_STORAGE_AUTH_MODE.

accepted values: key, login
--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--sas-token

A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.

--subscription

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

--timeout

Request timeout in seconds. Applies to each call to the service.

--yes -y

Do not prompt for confirmation.

az storage fs exists

Edit

Check for the existence of a file system in ADLS Gen2 account.

az storage fs exists --name
                     [--account-key]
                     [--account-name]
                     [--auth-mode {key, login}]
                     [--connection-string]
                     [--sas-token]
                     [--subscription]
                     [--timeout]

Examples

Check for the existence of a file system in ADLS Gen2 account.

az storage fs exists -n myfilesystem --account-name myadlsaccount --account-key 0000-0000

Required Parameters

--name -n

File system name.

Optional Parameters

--account-key

Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.

--account-name

Storage account name. Related environment variable: AZURE_STORAGE_ACCOUNT. Must be used in conjunction with either storage account key or a SAS token. If neither are present, the command will try to query the storage account key using the authenticated Azure account. If a large number of storage commands are executed the API quota may be hit.

--auth-mode

The mode in which to run the command. "login" mode will directly use your login credentials for the authentication. The legacy "key" mode will attempt to query for an account key if no authentication parameters for the account are provided. Environment variable: AZURE_STORAGE_AUTH_MODE.

accepted values: key, login
--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--sas-token

A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.

--subscription

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

--timeout

Request timeout in seconds. Applies to each call to the service.

az storage fs list

Edit

List file systems in ADLS Gen2 account.

az storage fs list [--account-key]
                   [--account-name]
                   [--auth-mode {key, login}]
                   [--connection-string]
                   [--include-metadata {false, true}]
                   [--prefix]
                   [--query-examples]
                   [--sas-token]
                   [--subscription]

Examples

List file systems in ADLS Gen2 account.

az storage fs list --account-name myadlsaccount --account-key 0000-0000

Optional Parameters

--account-key

Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.

--account-name

Storage account name. Related environment variable: AZURE_STORAGE_ACCOUNT. Must be used in conjunction with either storage account key or a SAS token. If neither are present, the command will try to query the storage account key using the authenticated Azure account. If a large number of storage commands are executed the API quota may be hit.

--auth-mode

The mode in which to run the command. "login" mode will directly use your login credentials for the authentication. The legacy "key" mode will attempt to query for an account key if no authentication parameters for the account are provided. Environment variable: AZURE_STORAGE_AUTH_MODE.

accepted values: key, login
--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--include-metadata

Specify that file system metadata be returned in the response. The default value is "False".

accepted values: false, true
--prefix

Filter the results to return only file systems whose names begin with the specified prefix.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--sas-token

A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.

--subscription

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

az storage fs show

Edit

Show properties of file system in ADLS Gen2 account.

az storage fs show --name
                   [--account-key]
                   [--account-name]
                   [--auth-mode {key, login}]
                   [--connection-string]
                   [--query-examples]
                   [--sas-token]
                   [--subscription]
                   [--timeout]

Examples

Show properties of file system in ADLS Gen2 account.

az storage fs show -n myfilesystem --account-name myadlsaccount --account-key 0000-0000

Required Parameters

--name -n

File system name.

Optional Parameters

--account-key

Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.

--account-name

Storage account name. Related environment variable: AZURE_STORAGE_ACCOUNT. Must be used in conjunction with either storage account key or a SAS token. If neither are present, the command will try to query the storage account key using the authenticated Azure account. If a large number of storage commands are executed the API quota may be hit.

--auth-mode

The mode in which to run the command. "login" mode will directly use your login credentials for the authentication. The legacy "key" mode will attempt to query for an account key if no authentication parameters for the account are provided. Environment variable: AZURE_STORAGE_AUTH_MODE.

accepted values: key, login
--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--sas-token

A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.

--subscription

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

--timeout

Request timeout in seconds. Applies to each call to the service.