Share via

az storage directory

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Manage file storage directories.

Commands

Name Description Type Status
az storage directory create

Create a new directory under the specified share or parent directory.

 Core GA
az storage directory create (storage-preview extension)

Create a new directory under the specified share or parent directory.

 Extension GA
az storage directory delete

Delete the specified empty directory.

 Core GA
az storage directory delete (storage-preview extension)

Delete the specified empty directory.

 Extension GA
az storage directory exists

Check for the existence of a storage directory.

 Core GA
az storage directory exists (storage-preview extension)

Check for the existence of a storage directory.

 Extension GA
az storage directory list

List directories in a share.

 Core GA
az storage directory list (storage-preview extension)

List directories in a share.

 Extension GA
az storage directory metadata

Manage file storage directory metadata.

 Core and Extension GA
az storage directory metadata show

Get all user-defined metadata for the specified directory.

 Core GA
az storage directory metadata show (storage-preview extension)

Get all user-defined metadata for the specified directory.

 Extension GA
az storage directory metadata update

Set one or more user-defined name-value pairs for the specified directory.

 Core GA
az storage directory metadata update (storage-preview extension)

Set one or more user-defined name-value pairs for the specified directory.

 Extension GA
az storage directory show

Get all user-defined metadata and system properties for the specified directory.

 Core GA
az storage directory show (storage-preview extension)

Get all user-defined metadata and system properties for the specified directory.

 Extension GA

az storage directory create

Edit

Create a new directory under the specified share or parent directory.

az storage directory create --name
                            --share-name
                            [--account-key]
                            [--account-name]
                            [--auth-mode {key, login}]
                            [--backup-intent --enable-file-backup-request-intent]
                            [--connection-string]
                            [--disallow-trailing-dot {false, true}]
                            [--fail-on-exist]
                            [--file-endpoint]
                            [--file-mode]
                            [--group]
                            [--metadata]
                            [--owner]
                            [--sas-token]
                            [--snapshot]
                            [--timeout]

Examples

Create a new directory under the specified NFS share with file-mode, owner, group

az storage directory create --account-name mystorageaccount --name dir --share-name myshare
--file-mode rwxr--r-- --owner 1 --group 2

Required Parameters

--name -n

The directory name.

--share-name -s

The file share name.

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

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

Property Value
Parameter group: Storage Account Arguments
--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.

Property Value
Parameter group: Storage Account Arguments
--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.

Property Value
Accepted values: key, login
--backup-intent --enable-file-backup-request-intent

Required parameter to use with OAuth (Azure AD) Authentication for Files. This will bypass any file/directory level permission checks and allow access, based on the allowed data actions, even if there are ACLs in place for those files/directories.

Property Value
Default value: False
--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

Property Value
Parameter group: Storage Account Arguments
--disallow-trailing-dot

If true, the trailing dot will be trimmed from the target URI. Default to False.

Property Value
Default value: False
Accepted values: false, true
--fail-on-exist

Throw an exception if the directory already exists.

Property Value
Default value: False
--file-endpoint

Storage data service endpoint. Must be used in conjunction with either storage account key or a SAS token. You can find each service primary endpoint with az storage account show. Environment variable: AZURE_STORAGE_SERVICE_ENDPOINT.

Property Value
Parameter group: Storage Account Arguments
--file-mode

Only applicable to NFS Directory. The mode permissions to be set on the directory. Symbolic (rwxrw-rw-) is supported. The sticky bit is also supported and its represented either by the letter t or T in the final character-place depending on whether the execution bit for the others category is set or unset respectively, absence of t or T indicates sticky bit not set.".

--group

Only applicable to NFS Directory. The owner group identifier (GID) to be set on the directory. The default value is 0 (root group).

--metadata

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

--owner

Only applicable to NFS Directory. The owner user identifier (UID) to be set on the directory. The default value is 0 (root).

--sas-token

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

Property Value
Parameter group: Storage Account Arguments
--snapshot

A string that represents the snapshot version, if applicable.

--timeout

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

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 storage directory create (storage-preview extension)

Create a new directory under the specified share or parent directory.

az storage directory create --name
                            --share-name
                            [--account-key]
                            [--account-name]
                            [--auth-mode {key, login}]
                            [--backup-intent --enable-file-backup-request-intent]
                            [--connection-string]
                            [--disallow-trailing-dot {false, true}]
                            [--fail-on-exist]
                            [--metadata]
                            [--sas-token]
                            [--snapshot]
                            [--timeout]

Required Parameters

--name -n

The directory name.

--share-name -s

The file share name.

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

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

Property Value
Parameter group: Storage Account Arguments
--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.

Property Value
Parameter group: Storage Account Arguments
--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.

Property Value
Accepted values: key, login
--backup-intent --enable-file-backup-request-intent

Required parameter to use with OAuth (Azure AD) Authentication for Files. This will bypass any file/directory level permission checks and allow access, based on the allowed data actions, even if there are ACLs in place for those files/directories.

Property Value
Default value: False
--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

Property Value
Parameter group: Storage Account Arguments
--disallow-trailing-dot

If true, the trailing dot will be trimmed from the target URI. Default to False.

Property Value
Default value: False
Accepted values: false, true
--fail-on-exist

Throw an exception if the directory already exists.

Property Value
Default value: False
--metadata

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

--sas-token

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

Property Value
Parameter group: Storage Account Arguments
--snapshot

A string that represents the snapshot version, if applicable.

--timeout

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

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 storage directory delete

Edit

Delete the specified empty directory.

az storage directory delete --name
                            --share-name
                            [--account-key]
                            [--account-name]
                            [--auth-mode {key, login}]
                            [--backup-intent --enable-file-backup-request-intent]
                            [--connection-string]
                            [--disallow-trailing-dot {false, true}]
                            [--fail-not-exist]
                            [--file-endpoint]
                            [--sas-token]
                            [--snapshot]
                            [--timeout]

Required Parameters

--name -n

The directory name.

--share-name -s

The file share name.

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

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

Property Value
Parameter group: Storage Account Arguments
--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.

Property Value
Parameter group: Storage Account Arguments
--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.

Property Value
Accepted values: key, login
--backup-intent --enable-file-backup-request-intent

Required parameter to use with OAuth (Azure AD) Authentication for Files. This will bypass any file/directory level permission checks and allow access, based on the allowed data actions, even if there are ACLs in place for those files/directories.

Property Value
Default value: False
--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

Property Value
Parameter group: Storage Account Arguments
--disallow-trailing-dot

If true, the trailing dot will be trimmed from the target URI. Default to False.

Property Value
Default value: False
Accepted values: false, true
--fail-not-exist

Throw an exception if the directory does not exist.

Property Value
Default value: False
--file-endpoint

Storage data service endpoint. Must be used in conjunction with either storage account key or a SAS token. You can find each service primary endpoint with az storage account show. Environment variable: AZURE_STORAGE_SERVICE_ENDPOINT.

Property Value
Parameter group: Storage Account Arguments
--sas-token

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

Property Value
Parameter group: Storage Account Arguments
--snapshot

A string that represents the snapshot version, if applicable.

--timeout

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

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 storage directory delete (storage-preview extension)

Delete the specified empty directory.

az storage directory delete --name
                            --share-name
                            [--account-key]
                            [--account-name]
                            [--auth-mode {key, login}]
                            [--backup-intent --enable-file-backup-request-intent]
                            [--connection-string]
                            [--disallow-trailing-dot {false, true}]
                            [--fail-not-exist]
                            [--sas-token]
                            [--snapshot]
                            [--timeout]

Required Parameters

--name -n

The directory name.

--share-name -s

The file share name.

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

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

Property Value
Parameter group: Storage Account Arguments
--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.

Property Value
Parameter group: Storage Account Arguments
--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.

Property Value
Accepted values: key, login
--backup-intent --enable-file-backup-request-intent

Required parameter to use with OAuth (Azure AD) Authentication for Files. This will bypass any file/directory level permission checks and allow access, based on the allowed data actions, even if there are ACLs in place for those files/directories.

Property Value
Default value: False
--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

Property Value
Parameter group: Storage Account Arguments
--disallow-trailing-dot

If true, the trailing dot will be trimmed from the target URI. Default to False.

Property Value
Default value: False
Accepted values: false, true
--fail-not-exist

Throw an exception if the directory does not exist.

Property Value
Default value: False
--sas-token

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

Property Value
Parameter group: Storage Account Arguments
--snapshot

A string that represents the snapshot version, if applicable.

--timeout

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

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 storage directory exists

Edit

Check for the existence of a storage directory.

az storage directory exists --name
                            --share-name
                            [--account-key]
                            [--account-name]
                            [--auth-mode {key, login}]
                            [--backup-intent --enable-file-backup-request-intent]
                            [--connection-string]
                            [--disallow-trailing-dot {false, true}]
                            [--file-endpoint]
                            [--sas-token]
                            [--snapshot]
                            [--timeout]

Examples

Check for the existence of a storage directory. (autogenerated)

az storage directory exists --account-key 00000000 --account-name MyAccount --name MyDirectory --share-name MyShare

Required Parameters

--name -n

The directory name.

--share-name -s

The file share name.

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

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

Property Value
Parameter group: Storage Account Arguments
--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.

Property Value
Parameter group: Storage Account Arguments
--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.

Property Value
Accepted values: key, login
--backup-intent --enable-file-backup-request-intent

Required parameter to use with OAuth (Azure AD) Authentication for Files. This will bypass any file/directory level permission checks and allow access, based on the allowed data actions, even if there are ACLs in place for those files/directories.

Property Value
Default value: False
--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

Property Value
Parameter group: Storage Account Arguments
--disallow-trailing-dot

If true, the trailing dot will be trimmed from the target URI. Default to False.

Property Value
Default value: False
Accepted values: false, true
--file-endpoint

Storage data service endpoint. Must be used in conjunction with either storage account key or a SAS token. You can find each service primary endpoint with az storage account show. Environment variable: AZURE_STORAGE_SERVICE_ENDPOINT.

Property Value
Parameter group: Storage Account Arguments
--sas-token

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

Property Value
Parameter group: Storage Account Arguments
--snapshot

A string that represents the snapshot version, if applicable.

--timeout

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

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 storage directory exists (storage-preview extension)

Check for the existence of a storage directory.

az storage directory exists --name
                            --share-name
                            [--account-key]
                            [--account-name]
                            [--auth-mode {key, login}]
                            [--backup-intent --enable-file-backup-request-intent]
                            [--connection-string]
                            [--disallow-trailing-dot {false, true}]
                            [--sas-token]
                            [--snapshot]
                            [--timeout]

Examples

Check for the existence of a storage directory. (autogenerated)

az storage directory exists --account-key 00000000 --account-name MyAccount --name MyDirectory --share-name MyShare

Required Parameters

--name -n

The directory name.

--share-name -s

The file share name.

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

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

Property Value
Parameter group: Storage Account Arguments
--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.

Property Value
Parameter group: Storage Account Arguments
--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.

Property Value
Accepted values: key, login
--backup-intent --enable-file-backup-request-intent

Required parameter to use with OAuth (Azure AD) Authentication for Files. This will bypass any file/directory level permission checks and allow access, based on the allowed data actions, even if there are ACLs in place for those files/directories.

Property Value
Default value: False
--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

Property Value
Parameter group: Storage Account Arguments
--disallow-trailing-dot

If true, the trailing dot will be trimmed from the target URI. Default to False.

Property Value
Default value: False
Accepted values: false, true
--sas-token

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

Property Value
Parameter group: Storage Account Arguments
--snapshot

A string that represents the snapshot version, if applicable.

--timeout

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

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 storage directory list

Edit

List directories in a share.

az storage directory list --share-name
                          [--account-key]
                          [--account-name]
                          [--auth-mode {key, login}]
                          [--backup-intent --enable-file-backup-request-intent]
                          [--connection-string]
                          [--disallow-trailing-dot {false, true}]
                          [--exclude-extended-info]
                          [--file-endpoint]
                          [--name]
                          [--sas-token]
                          [--timeout]

Examples

List directories in a share. (autogenerated)

az storage directory list --account-key 00000000 --account-name MyAccount --share-name MyShare

Required Parameters

--share-name -s

The file share name.

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

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

Property Value
Parameter group: Storage Account Arguments
--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.

Property Value
Parameter group: Storage Account Arguments
--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.

Property Value
Accepted values: key, login
--backup-intent --enable-file-backup-request-intent

Required parameter to use with OAuth (Azure AD) Authentication for Files. This will bypass any file/directory level permission checks and allow access, based on the allowed data actions, even if there are ACLs in place for those files/directories.

Property Value
Default value: False
--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

Property Value
Parameter group: Storage Account Arguments
--disallow-trailing-dot

If true, the trailing dot will be trimmed from the target URI. Default to False.

Property Value
Default value: False
Accepted values: false, true
--exclude-extended-info

Specify to exclude "timestamps", "Etag", "Attributes", "PermissionKey" info from response.

Property Value
Default value: False
--file-endpoint

Storage data service endpoint. Must be used in conjunction with either storage account key or a SAS token. You can find each service primary endpoint with az storage account show. Environment variable: AZURE_STORAGE_SERVICE_ENDPOINT.

Property Value
Parameter group: Storage Account Arguments
--name -n

The directory name.

--sas-token

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

Property Value
Parameter group: Storage Account Arguments
--timeout

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

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 storage directory list (storage-preview extension)

List directories in a share.

az storage directory list --share-name
                          [--account-key]
                          [--account-name]
                          [--auth-mode {key, login}]
                          [--backup-intent --enable-file-backup-request-intent]
                          [--connection-string]
                          [--disallow-trailing-dot {false, true}]
                          [--exclude-extended-info]
                          [--name]
                          [--sas-token]
                          [--timeout]

Examples

List directories in a share. (autogenerated)

az storage directory list --account-key 00000000 --account-name MyAccount --share-name MyShare

Required Parameters

--share-name -s

The file share name.

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

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

Property Value
Parameter group: Storage Account Arguments
--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.

Property Value
Parameter group: Storage Account Arguments
--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.

Property Value
Accepted values: key, login
--backup-intent --enable-file-backup-request-intent

Required parameter to use with OAuth (Azure AD) Authentication for Files. This will bypass any file/directory level permission checks and allow access, based on the allowed data actions, even if there are ACLs in place for those files/directories.

Property Value
Default value: False
--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

Property Value
Parameter group: Storage Account Arguments
--disallow-trailing-dot

If true, the trailing dot will be trimmed from the target URI. Default to False.

Property Value
Default value: False
Accepted values: false, true
--exclude-extended-info

Specify to exclude "timestamps", "Etag", "Attributes", "PermissionKey" info from response.

Property Value
Default value: False
--name -n

The directory name.

--sas-token

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

Property Value
Parameter group: Storage Account Arguments
--timeout

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

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 storage directory show

Edit

Get all user-defined metadata and system properties for the specified directory.

az storage directory show --name
                          --share-name
                          [--account-key]
                          [--account-name]
                          [--auth-mode {key, login}]
                          [--backup-intent --enable-file-backup-request-intent]
                          [--connection-string]
                          [--disallow-trailing-dot {false, true}]
                          [--file-endpoint]
                          [--sas-token]
                          [--snapshot]
                          [--timeout]

Required Parameters

--name -n

The directory name.

--share-name -s

The file share name.

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

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

Property Value
Parameter group: Storage Account Arguments
--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.

Property Value
Parameter group: Storage Account Arguments
--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.

Property Value
Accepted values: key, login
--backup-intent --enable-file-backup-request-intent

Required parameter to use with OAuth (Azure AD) Authentication for Files. This will bypass any file/directory level permission checks and allow access, based on the allowed data actions, even if there are ACLs in place for those files/directories.

Property Value
Default value: False
--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

Property Value
Parameter group: Storage Account Arguments
--disallow-trailing-dot

If true, the trailing dot will be trimmed from the target URI. Default to False.

Property Value
Default value: False
Accepted values: false, true
--file-endpoint

Storage data service endpoint. Must be used in conjunction with either storage account key or a SAS token. You can find each service primary endpoint with az storage account show. Environment variable: AZURE_STORAGE_SERVICE_ENDPOINT.

Property Value
Parameter group: Storage Account Arguments
--sas-token

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

Property Value
Parameter group: Storage Account Arguments
--snapshot

A string that represents the snapshot version, if applicable.

--timeout

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

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 storage directory show (storage-preview extension)

Get all user-defined metadata and system properties for the specified directory.

az storage directory show --name
                          --share-name
                          [--account-key]
                          [--account-name]
                          [--auth-mode {key, login}]
                          [--backup-intent --enable-file-backup-request-intent]
                          [--connection-string]
                          [--disallow-trailing-dot {false, true}]
                          [--sas-token]
                          [--snapshot]
                          [--timeout]

Required Parameters

--name -n

The directory name.

--share-name -s

The file share name.

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

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

Property Value
Parameter group: Storage Account Arguments
--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.

Property Value
Parameter group: Storage Account Arguments
--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.

Property Value
Accepted values: key, login
--backup-intent --enable-file-backup-request-intent

Required parameter to use with OAuth (Azure AD) Authentication for Files. This will bypass any file/directory level permission checks and allow access, based on the allowed data actions, even if there are ACLs in place for those files/directories.

Property Value
Default value: False
--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

Property Value
Parameter group: Storage Account Arguments
--disallow-trailing-dot

If true, the trailing dot will be trimmed from the target URI. Default to False.

Property Value
Default value: False
Accepted values: false, true
--sas-token

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

Property Value
Parameter group: Storage Account Arguments
--snapshot

A string that represents the snapshot version, if applicable.

--timeout

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

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