az-storage-queue

Create a queue

$ az storage queue create --account-name [storage_account_name] [[-n|--name]] [queue_name] --metadata [queue_metadata]

$ az storage queue generate-sas --account-name [storage_account_name] [[-n|--name]] [queue_name] --permissions [queue_permissions] --expiry [expiry_date] --https-only

$ az storage queue list --prefix [filter_prefix] --account-name [storage_account_name]

$ az storage queue delete --account-name [storage_account_name] [[-n|--name]] [queue_name] --fail-not-exist

az storage queue <command> [<options>]

Common commands:
az storage queue create - Create a storage queue.
az storage queue delete - Delete a storage queue.
az storage queue list - List storage queues.
az storage queue message add - Add a message to a queue.
az storage queue message get - Get messages from a queue.
az storage queue message peek - Peek messages from a queue without removing them.
az storage queue message delete - Delete messages from a queue.

--account-name <name>
    The name of the Azure Storage account. Required if not provided by other means like connection string or environment variables.

--account-key <key>
    The primary or secondary key of the Azure Storage account. Used for shared key authentication.

--connection-string <string>
    The connection string for the Azure Storage account. Provides all necessary authentication details.

--sas-token <token>
    A Shared Access Signature (SAS) token to authenticate requests.

--auth-mode <mode>
    The authentication mode. Supported values include key (default), login (Azure AD), and sas.

--name <queue_name>
    The name of the storage queue for operations like create, delete, or show. Used by main queue commands.

--queue-name <queue_name>
    The name of the storage queue when performing message operations (e.g., message add, message get).

--content <message_content>
    The content of the message to add to the queue (for message add).

--visibility-timeout <seconds>
    The time (in seconds) during which a retrieved message will be invisible to other processing requests. Used in message add, message get, message update.

--num-messages <count>
    The number of messages to retrieve from the queue (for message get, message peek).

--output <format>
    Output format. Accepted values: json, jsonc, none, table, tsv, yaml, yamlc. Default: json.

--query <jmespath_query>
    JMESPath query string to filter or transform command output. See http://jmespath.org/ for more information.

--help, -h
    Show help message for the command or subcommand.

The az storage queue command group within the Azure CLI provides comprehensive tools for managing Azure Storage queues and the messages within them.

Azure Storage queues are a service for storing large numbers of messages that can be accessed from anywhere in the world via authenticated HTTP or HTTPS. They are commonly used to create a backlog of work to process asynchronously. This command group allows users to create, delete, list, and show details of storage queues.

Furthermore, it enables operations on messages, such as adding messages to a queue, peeking at messages without removing them, getting and deleting messages, and updating existing messages. It supports various authentication methods, including connection strings, shared access signatures (SAS), and Azure Active Directory (AAD) authentication, making it a versatile tool for developers and administrators working with Azure Storage.

The command az-storage-queue is not a standard standalone Linux command. This analysis assumes the user is referring to the Azure CLI command group az storage queue. It requires the Azure CLI to be installed and configured with appropriate Azure credentials. Operations performed by this command group interact with cloud resources, requiring active network connectivity to Azure.

Azure Storage queue messages are often Base64 encoded, especially when they contain binary data or complex JSON structures. The az storage queue message encode and az storage queue message decode subcommands can be used to handle this encoding and decoding process, ensuring proper handling of message content.

Multiple authentication methods are supported: Shared Key (using account name and key/connection string), Shared Access Signature (SAS) for limited access, and Azure Active Directory (AAD) via az login for role-based access control. The chosen method impacts the required parameters and permissions.

The Azure CLI, developed by Microsoft, provides a command-line interface for managing Azure resources. The az storage queue command group has been a fundamental part of the az storage module since the early iterations of the Azure CLI, reflecting the critical role of message queues in scalable cloud application architectures. It has continuously evolved, incorporating new features and improvements to keep pace with updates to the Azure Storage service and broader Azure ecosystem.

az(1), az storage container(1), az storage blob(1), az storage table(1), curl(1), jq(1)