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]
                              [--query-examples]
                              [--sas-token]
                              [--snapshot]
                              [--subscription]
                              [--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. 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.

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

--snapshot

A string that represents the snapshot version, if applicable.

--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 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]
                                [--subscription]
                                [--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. 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.

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

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