az-storage-queue

Manage Azure Queue Storage and messages

TLDR

Create a queue

$ az storage queue create --name [myqueue] --account-name [mystorageaccount]

List all queues

$ az storage queue list --account-name [mystorageaccount]

Delete a queue

$ az storage queue delete --name [myqueue] --account-name [mystorageaccount]

Add a message to a queue

$ az storage message put -q [myqueue] --content [Hello World] --account-name [mystorageaccount]

Get (dequeue) messages, hiding them for a visibility timeout

$ az storage message get -q [myqueue] --num-messages [5] --visibility-timeout [30] --account-name [mystorageaccount]

Peek at messages without removing or hiding them

$ az storage message peek -q [myqueue] --num-messages [5] --account-name [mystorageaccount]

Delete a message from a queue

$ az storage message delete --id [message-id] --pop-receipt [receipt] -q [myqueue] --account-name [mystorageaccount]

SYNOPSIS

az storage queue subcommand [options]az storage message subcommand [options]

az storage queue manages Azure Queue Storage, which provides cloud messaging between application components. Queues enable asynchronous communication and decoupled architectures.Messages can be up to 64 KB in size and have a default time-to-live of 7 days. Individual messages are managed with the az storage message command group (put, get, peek, delete, update, clear).

PARAMETERS

--name -n

Name of the queue (for queue subcommands).

--queue-name -q

Name of the queue (for az storage message subcommands).

--account-name

Storage account name. Env: AZURESTORAGEACCOUNT.

--account-key

Storage account key. Env: AZURESTORAGEKEY.

--connection-string

Storage connection string. Env: AZURESTORAGECONNECTION_STRING.

--auth-mode value

Authentication mode: key (legacy account key) or login (Azure AD credentials).

--content

Message content for message put and message update, up to 64 KB.

--visibility-timeout seconds

Hide a retrieved message from other consumers for this many seconds (1 second to 7 days).

--time-to-live seconds

Lifetime of a message for message put. Use -1 for infinity. Default 7 days.

--num-messages value

Number of messages to get or peek, up to 32. Default 1.

SUBCOMMANDS

create

Create a queue under the given account.

delete

Delete a queue and any messages it contains.

list

List queues in a storage account.

exists

Return a boolean indicating whether the queue exists.

generate-sas

Generate a shared access signature for the queue.

stats

Retrieve replication statistics for the Queue service (requires RA-GRS).

metadata show

Return all user-defined metadata for the queue.

metadata update

Set user-defined metadata on the queue.

policy create / delete / list / show / update

Manage stored access policies for the queue.

message put / get / peek / delete / update / clear

Manage queue messages. These live under az storage message, not az storage queue.

INSTALL

sudo dnf install azure-cli

sudo pacman -S azure-cli

sudo zypper install azure-cli

brew install azure-cli

nix profile install nixpkgs#azure-cli

CAVEATS

The az storage queue and az storage message groups are in preview. Requires Azure CLI and valid storage credentials (account key, connection string, SAS token, or `--auth-mode login`). Queue names must be 3-63 characters, lowercase letters, numbers, and hyphens. After a get, a message is hidden for the visibility timeout; if not deleted before it elapses the message reappears, so consumers must delete with the returned message id and pop receipt.

RESOURCES

Documentation · Homepage · Source code