az storage share metadata

Manage the metadata of a file share.

Commands

Name	Description	Type	Status
az storage share metadata show	Return all user-defined metadata for the specified share.	Core	GA
az storage share metadata update	Set one or more user-defined name-value pairs for the specified share.	Core	GA

az storage share metadata show

Return all user-defined metadata for the specified share.

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

Required Parameters

--name -n

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

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

Property	Value
Parameter group:	Storage Account Arguments

--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 share metadata update

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

Each call to this operation replaces all existing metadata attached to the share. To remove all metadata from the share, call this operation with no metadata dict.

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

Required Parameters

--name -n

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

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

Property	Value
Parameter group:	Storage Account Arguments

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

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