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 | Preview |
| az storage directory delete |
Delete the specified empty directory. |
Core | GA |
| az storage directory delete (storage-preview extension) |
Delete the specified empty directory. |
Extension | Preview |
| 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 | Preview |
| az storage directory list |
List directories in a share. |
Core | GA |
| az storage directory list (storage-preview extension) |
List directories in a share. |
Extension | Preview |
| 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 | Preview |
| 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 | Preview |
| 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 | Preview |
az storage directory create
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]
[--connection-string]
[--disallow-trailing-dot {false, true}]
[--fail-on-exist]
[--file-endpoint]
[--metadata]
[--sas-token]
[--snapshot]
[--timeout]Required Parameters
The directory name.
The file share name.
Optional Parameters
Storage account key. Must be used in conjunction with storage account name or service endpoint. Environment variable: AZURE_STORAGE_KEY.
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.
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.
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.
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
If true, the trailing dot will be trimmed from the target URI. Default to False.
Throw an exception if the directory already exists.
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.
Metadata in space-separated key=value pairs. This overwrites any existing metadata.
A Shared Access Signature (SAS). Must be used in conjunction with storage account name or service endpoint. Environment variable: AZURE_STORAGE_SAS_TOKEN.
A string that represents the snapshot version, if applicable.
Request timeout in seconds. Applies to each call to the service.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az storage directory create (storage-preview extension)
Command group 'az storage' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
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]
[--connection-string]
[--disallow-trailing-dot {false, true}]
[--fail-on-exist]
[--metadata]
[--sas-token]
[--snapshot]
[--timeout]Required Parameters
The directory name.
The file share name.
Optional Parameters
Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.
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.
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.
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.
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
If true, the trailing dot will be trimmed from the target URI. Default to False.
Throw an exception if the directory already exists.
Metadata in space-separated key=value pairs. This overwrites any existing metadata.
A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.
A string that represents the snapshot version, if applicable.
Request timeout in seconds. Applies to each call to the service.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az storage directory delete
Delete the specified empty directory.
az storage directory delete --name
--share-name
[--account-key]
[--account-name]
[--auth-mode {key, login}]
[--backup-intent]
[--connection-string]
[--disallow-trailing-dot {false, true}]
[--fail-not-exist]
[--file-endpoint]
[--sas-token]
[--snapshot]
[--timeout]Required Parameters
The directory name.
The file share name.
Optional Parameters
Storage account key. Must be used in conjunction with storage account name or service endpoint. Environment variable: AZURE_STORAGE_KEY.
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.
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.
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.
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
If true, the trailing dot will be trimmed from the target URI. Default to False.
Throw an exception if the directory does not exist.
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.
A Shared Access Signature (SAS). Must be used in conjunction with storage account name or service endpoint. Environment variable: AZURE_STORAGE_SAS_TOKEN.
A string that represents the snapshot version, if applicable.
Request timeout in seconds. Applies to each call to the service.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az storage directory delete (storage-preview extension)
Command group 'az storage' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Delete the specified empty directory.
az storage directory delete --name
--share-name
[--account-key]
[--account-name]
[--auth-mode {key, login}]
[--backup-intent]
[--connection-string]
[--disallow-trailing-dot {false, true}]
[--fail-not-exist]
[--sas-token]
[--snapshot]
[--timeout]Required Parameters
The directory name.
The file share name.
Optional Parameters
Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.
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.
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.
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.
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
If true, the trailing dot will be trimmed from the target URI. Default to False.
Throw an exception if the directory does not exist.
A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.
A string that represents the snapshot version, if applicable.
Request timeout in seconds. Applies to each call to the service.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az storage directory exists
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]
[--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 MyShareRequired Parameters
The directory name.
The file share name.
Optional Parameters
Storage account key. Must be used in conjunction with storage account name or service endpoint. Environment variable: AZURE_STORAGE_KEY.
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.
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.
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.
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
If true, the trailing dot will be trimmed from the target URI. Default to False.
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.
A Shared Access Signature (SAS). Must be used in conjunction with storage account name or service endpoint. Environment variable: AZURE_STORAGE_SAS_TOKEN.
A string that represents the snapshot version, if applicable.
Request timeout in seconds. Applies to each call to the service.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az storage directory exists (storage-preview extension)
Command group 'az storage' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
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]
[--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 MyShareRequired Parameters
The directory name.
The file share name.
Optional Parameters
Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.
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.
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.
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.
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
If true, the trailing dot will be trimmed from the target URI. Default to False.
A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.
A string that represents the snapshot version, if applicable.
Request timeout in seconds. Applies to each call to the service.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az storage directory list
List directories in a share.
az storage directory list --share-name
[--account-key]
[--account-name]
[--auth-mode {key, login}]
[--backup-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 MyShareRequired Parameters
The file share name.
Optional Parameters
Storage account key. Must be used in conjunction with storage account name or service endpoint. Environment variable: AZURE_STORAGE_KEY.
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.
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.
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.
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
If true, the trailing dot will be trimmed from the target URI. Default to False.
Specify to exclude "timestamps", "Etag", "Attributes", "PermissionKey" info from response.
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.
The directory name.
A Shared Access Signature (SAS). Must be used in conjunction with storage account name or service endpoint. Environment variable: AZURE_STORAGE_SAS_TOKEN.
Request timeout in seconds. Applies to each call to the service.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az storage directory list (storage-preview extension)
Command group 'az storage' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
List directories in a share.
az storage directory list --share-name
[--account-key]
[--account-name]
[--auth-mode {key, login}]
[--backup-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 MyShareRequired Parameters
The file share name.
Optional Parameters
Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.
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.
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.
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.
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
If true, the trailing dot will be trimmed from the target URI. Default to False.
Specify to exclude "timestamps", "Etag", "Attributes", "PermissionKey" info from response.
The directory name.
A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.
Request timeout in seconds. Applies to each call to the service.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az storage directory show
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]
[--connection-string]
[--disallow-trailing-dot {false, true}]
[--file-endpoint]
[--sas-token]
[--snapshot]
[--timeout]Required Parameters
The directory name.
The file share name.
Optional Parameters
Storage account key. Must be used in conjunction with storage account name or service endpoint. Environment variable: AZURE_STORAGE_KEY.
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.
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.
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.
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
If true, the trailing dot will be trimmed from the target URI. Default to False.
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.
A Shared Access Signature (SAS). Must be used in conjunction with storage account name or service endpoint. Environment variable: AZURE_STORAGE_SAS_TOKEN.
A string that represents the snapshot version, if applicable.
Request timeout in seconds. Applies to each call to the service.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az storage directory show (storage-preview extension)
Command group 'az storage' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
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]
[--connection-string]
[--disallow-trailing-dot {false, true}]
[--sas-token]
[--snapshot]
[--timeout]Required Parameters
The directory name.
The file share name.
Optional Parameters
Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.
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.
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.
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.
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
If true, the trailing dot will be trimmed from the target URI. Default to False.
A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.
A string that represents the snapshot version, if applicable.
Request timeout in seconds. Applies to each call to the service.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for