az storage queue
This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Manage storage queues.
Commands
Name | Description | Type | Status |
---|---|---|---|
az storage queue create |
Create a queue under the given account. |
Core | Preview |
az storage queue delete |
Delete the specified queue and any messages it contains. |
Core | Preview |
az storage queue exists |
Return a boolean indicating whether the queue exists. |
Core | Preview |
az storage queue generate-sas |
Generate a shared access signature for the queue.Use the returned signature with the sas_token parameter of QueueService. |
Core | Preview |
az storage queue list |
List queues in a storage account. |
Core | Preview |
az storage queue metadata |
Manage the metadata for a storage queue. |
Core | Preview |
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 policy |
Manage shared access policies for a storage queue. |
Core | Preview |
az storage queue policy create |
Create a stored access policy on the containing object. |
Core | Preview |
az storage queue policy delete |
Delete a stored access policy on a containing object. |
Core | Preview |
az storage queue policy list |
List stored access policies on a containing object. |
Core | Preview |
az storage queue policy show |
Show a stored access policy on a containing object. |
Core | Preview |
az storage queue policy update |
Set a stored access policy on a containing object. |
Core | Preview |
az storage queue stats |
Retrieve statistics related to replication for the Queue service. It is only available when read-access geo-redundant replication is enabled for the storage account. |
Core | Preview |
az storage queue create
Command group 'storage queue' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Create a queue under the given account.
az storage queue create --name
[--account-key]
[--account-name]
[--auth-mode {key, login}]
[--connection-string]
[--fail-on-exist]
[--metadata]
[--queue-endpoint]
[--sas-token]
[--timeout]
Examples
Create a queue under the given account with metadata.
az storage queue create -n myqueue --metadata key1=value1 key2=value2 --account-name mystorageaccount
Required Parameters
The queue 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.
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 |
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 |
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.
Property | Value |
---|---|
Accepted values: | key, login |
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
Property | Value |
---|---|
Parameter group: | Storage Account Arguments |
Specify whether to throw an exception if the queue already exists.
Property | Value |
---|---|
Default value: | False |
Metadata in space-separated key=value pairs. This overwrites any existing metadata.
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 |
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 |
Request timeout in seconds. Applies to each call to the service.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
az storage queue delete
Command group 'storage queue' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Delete the specified queue and any messages it contains.
az storage queue delete --name
[--account-key]
[--account-name]
[--auth-mode {key, login}]
[--connection-string]
[--fail-not-exist]
[--queue-endpoint]
[--sas-token]
[--timeout]
Examples
Delete the specified queue, throw an exception if the queue doesn't exist.
az storage queue delete -n myqueue --fail-not-exist --account-name mystorageaccount
Required Parameters
The queue 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.
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 |
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 |
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.
Property | Value |
---|---|
Accepted values: | key, login |
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
Property | Value |
---|---|
Parameter group: | Storage Account Arguments |
Specify whether to throw an exception if the queue doesn't exist.
Property | Value |
---|---|
Default value: | 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.
Property | Value |
---|---|
Parameter group: | Storage Account Arguments |
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 |
Request timeout in seconds. Applies to each call to the service.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
az storage queue exists
Command group 'storage queue' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Return a boolean indicating whether the queue exists.
az storage queue exists --name
[--account-key]
[--account-name]
[--auth-mode {key, login}]
[--connection-string]
[--queue-endpoint]
[--sas-token]
[--timeout]
Examples
Check whether the queue exists.
az storage queue exists -n myqueue --account-name mystorageaccount
Required Parameters
The queue 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.
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 |
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 |
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.
Property | Value |
---|---|
Accepted values: | key, login |
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
Property | Value |
---|---|
Parameter group: | Storage Account Arguments |
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 |
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 |
Request timeout in seconds. Applies to each call to the service.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
az storage queue generate-sas
Command group 'storage queue' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Generate a shared access signature for the queue.Use the returned signature with the sas_token parameter of QueueService.
az storage queue generate-sas --name
[--account-key]
[--account-name]
[--connection-string]
[--expiry]
[--https-only]
[--ip]
[--permissions]
[--policy-name]
[--queue-endpoint]
[--start]
Examples
Generate a sas token for the queue with read-only permissions.
end=`date -u -d "30 minutes" '+%Y-%m-%dT%H:%MZ'`
az storage queue generate-sas -n myqueue --account-name mystorageaccount --permissions r --expiry $end --https-only
Generate a sas token for the queue with ip range specified.
end=`date -u -d "30 minutes" '+%Y-%m-%dT%H:%MZ'`
az storage queue generate-sas -n myqueue --account-name mystorageaccount --ip "176.134.171.0-176.134.171.255" --permissions r --expiry $end --https-only
Required Parameters
The queue 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.
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 |
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 |
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
Property | Value |
---|---|
Parameter group: | Storage Account Arguments |
Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes invalid. Do not use if a stored access policy is referenced with --policy-name that specifies this value.
Only permit requests made with the HTTPS protocol. If omitted, requests from both the HTTP and HTTPS protocol are permitted.
Specifies the IP address or range of IP addresses from which to accept requests. Supports only IPv4 style addresses.
The permissions the SAS grants. Allowed values: (a)dd (p)rocess (r)ead (u)pdate. Do not use if a stored access policy is referenced with --id that specifies this value. Can be combined.
The name of a stored access policy within the share's ACL.
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 |
Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes valid. Do not use if a stored access policy is referenced with --policy-name that specifies this value. Defaults to the time of the request.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
az storage queue list
Command group 'storage queue' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
List queues in a storage account.
az storage queue list [--account-key]
[--account-name]
[--auth-mode {key, login}]
[--connection-string]
[--include-metadata]
[--marker]
[--num-results]
[--prefix]
[--queue-endpoint]
[--sas-token]
[--show-next-marker]
[--timeout]
Examples
List queues whose names begin with 'myprefix' under the storage account 'mystorageaccount'(account name)
az storage queue list --prefix myprefix --account-name mystorageaccount
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
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 |
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.
Property | Value |
---|---|
Accepted values: | key, login |
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
Property | Value |
---|---|
Parameter group: | Storage Account Arguments |
Specify that queue metadata be returned in the response.
Property | Value |
---|---|
Default value: | False |
A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the NextMarker value within the response body if the listing operation did not return all containers remaining to be listed with the current page. If specified, this generator will begin returning results from the point where the previous generator stopped.
Specify the maximum number to return. If the request does not specify num_results, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remaining of the results. Provide "*" to return all.
Property | Value |
---|---|
Default value: | 5000 |
Filter the results to return only queues whose names begin with the specified prefix.
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 |
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 |
Show nextMarker in result when specified.
Request timeout in seconds. Applies to each call to the service.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
az storage queue stats
Command group 'storage queue' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Retrieve statistics related to replication for the Queue service. It is only available when read-access geo-redundant replication is enabled for the storage account.
az storage queue stats [--account-key]
[--account-name]
[--auth-mode {key, login}]
[--connection-string]
[--queue-endpoint]
[--sas-token]
[--timeout]
Examples
Show statistics related to replication for the Queue service.
az storage queue stats --account-name mystorageaccount
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
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 |
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.
Property | Value |
---|---|
Accepted values: | key, login |
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
Property | Value |
---|---|
Parameter group: | Storage Account Arguments |
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 |
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 |
Request timeout in seconds. Applies to each call to the service.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |