az storage file metadata

Manage file metadata.

Commands

az storage file metadata show Returns all user-defined metadata for the specified file.
az storage file metadata update Sets user-defined metadata for the specified file as one or more name-value pairs.

az storage file metadata show

Returns all user-defined metadata for the specified file.

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

Required Parameters

--path -p
The path to the file within the file share.
--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 file metadata update

Sets user-defined metadata for the specified file as one or more name-value pairs.

az storage file metadata update --path
--share-name
[--account-key]
[--account-name]
[--connection-string]
[--metadata]
[--sas-token]
[--timeout]

Required Parameters

--path -p
The path to the file within the file share.
--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.
--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.