az storage directory

Manage file storage directories.

Commands

az storage directory create Creates a new directory under the specified share or parent directory.
az storage directory delete Deletes the specified empty directory.
az storage directory exists Check for the existence of a storage directory.
az storage directory list List directories in a share.
az storage directory metadata Manage file storage directory metadata.
az storage directory metadata show Returns all user-defined metadata for the specified directory.
az storage directory metadata update Sets one or more user-defined name-value pairs for the specified directory.
az storage directory show Returns all user-defined metadata and system properties for the specified directory.

az storage directory create

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

az storage directory create --name
--share-name
[--account-key]
[--account-name]
[--connection-string]
[--fail-on-exist]
[--metadata]
[--sas-token]
[--timeout]

Required Parameters

--name -n
The directory name.
--share-name -s
The file share 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. Must be used in conjunction with either storage account key or a SAS token. Environment variable: AZURE_STORAGE_ACCOUNT.
--connection-string
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
--fail-on-exist
Specify whether to throw an exception when the directory exists. False by default.
--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.
--timeout
Request timeout in seconds. Applies to each call to the service.

az storage directory delete

Deletes the specified empty directory.

az storage directory delete --name
--share-name
[--account-key]
[--account-name]
[--connection-string]
[--fail-not-exist]
[--sas-token]
[--timeout]

Required Parameters

--name -n
The directory name.
--share-name -s
The file share 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. Must be used in conjunction with either storage account key or a SAS token. Environment variable: AZURE_STORAGE_ACCOUNT.
--connection-string
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
--fail-not-exist
Specify whether to throw an exception when the directory doesn't exist.
--sas-token
A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.
--timeout
Request timeout in seconds. Applies to each call to the service.

az storage directory exists

Check for the existence of a storage directory.

az storage directory exists --name
--share-name
[--account-key]
[--account-name]
[--connection-string]
[--sas-token]
[--snapshot]
[--timeout]

Required Parameters

--name -n
The directory name.
--share-name -s
The file share 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. Must be used in conjunction with either storage account key or a SAS token. Environment variable: AZURE_STORAGE_ACCOUNT.
--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.
--snapshot
A string that represents the snapshot version, if applicable.
--timeout
Request timeout in seconds. Applies to each call to the service.

az storage directory list

List directories in a share.

az storage directory list --share-name
[--account-key]
[--account-name]
[--connection-string]
[--name]
[--sas-token]
[--timeout]

Required Parameters

--share-name -s
The file share 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. Must be used in conjunction with either storage account key or a SAS token. Environment variable: AZURE_STORAGE_ACCOUNT.
--connection-string
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
--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.
--timeout
Request timeout in seconds. Applies to each call to the service.

az storage directory show

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

az storage directory show --name
--share-name
[--account-key]
[--account-name]
[--connection-string]
[--sas-token]
[--snapshot]
[--timeout]

Required Parameters

--name -n
The directory name.
--share-name -s
The file share 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. Must be used in conjunction with either storage account key or a SAS token. Environment variable: AZURE_STORAGE_ACCOUNT.
--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.
--snapshot
A string that represents the snapshot version, if applicable.
--timeout
Request timeout in seconds. Applies to each call to the service.