Share via

az storage queue metadata

  • Preview
  • Reference

Command group 'storage queue' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage the metadata for a storage queue.

Commands

Name Description Type Status
az storage queue metadata show

Return all user-defined metadata for the specified queue.

 Core Preview
az storage queue metadata update

Set user-defined metadata on the specified queue.

 Core Preview

az storage queue metadata show

Edit
Preview

Command group 'storage queue' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Return all user-defined metadata for the specified queue.

az storage queue metadata show --name
                               [--account-key]
                               [--account-name]
                               [--auth-mode {key, login}]
                               [--connection-string]
                               [--queue-endpoint]
                               [--sas-token]
                               [--timeout]

Examples

Return all user-defined metadata for the specified queue.

az storage queue metadata show -n myqueue --account-name mystorageaccount

Required Parameters

--name -n

The queue name.

Optional Parameters

--account-key

Storage account key. Must be used in conjunction with storage account name or service endpoint. 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.

--auth-mode

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.

Accepted values: key, login
--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

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

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

--timeout

Request timeout in seconds. Applies to each call to the service.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az storage queue metadata update

Edit
Preview

Command group 'storage queue' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Set user-defined metadata on the specified queue.

az storage queue metadata update --name
                                 [--account-key]
                                 [--account-name]
                                 [--auth-mode {key, login}]
                                 [--connection-string]
                                 [--metadata]
                                 [--queue-endpoint]
                                 [--sas-token]
                                 [--timeout]

Examples

Set user-defined metadata on the specified queue.

az storage queue metadata update -n myqueue --metadata a=b c=d --account-name mystorageaccount

Required Parameters

--name -n

The queue name.

Optional Parameters

--account-key

Storage account key. Must be used in conjunction with storage account name or service endpoint. 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.

--auth-mode

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.

Accepted values: key, login
--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.

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

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

--timeout

Request timeout in seconds. Applies to each call to the service.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.