Added sdk/storage/azure_storage_queue (#2730)

[lsiddiquee]

Fixes #2708

Added support for the 2018-03-28 Queue API. The following functions have been created on the new QueueClient, roughly following the pattern in the .Net SDK:

QueueServiceClient

The QueueServiceClient provides operations to interact with the Azure Storage Queue service at the account level.

Method	Parameters	Return Type	Description
new	endpoint: &str credential: Arc<dyn TokenCredential> options: Option<QueueServiceClientOptions>	Result<Self>	Creates a new QueueServiceClient using Entra ID authentication
endpoint	&self	&Url	Returns the endpoint URL of the Azure storage account
queue_client	&self queue_name: String	QueueClient	Returns a new QueueClient instance for a specific queue
create_queue	&self queue_name: &str options: Option<QueueClientCreateOptions<'_>>	Result<Response<(), NoFormat>>	Creates a new queue under the account
delete_queue	&self queue_name: &str options: Option<QueueClientDeleteOptions<'_>>	Result<Response<(), NoFormat>>	Permanently deletes the specified queue
get_properties	&self options: Option<QueueServiceClientGetPropertiesOptions<'_>>	Result<Response<StorageServiceProperties, XmlFormat>>	Retrieves the properties of the queue service
set_properties	&self storage_service_properties: RequestContent<StorageServiceProperties> options: Option<QueueServiceClientSetPropertiesOptions<'_>>	Result<Response<(), NoFormat>>	Sets the properties of the queue service
list_queues_segment	&self options: Option<QueueServiceClientListQueuesSegmentOptions<'_>>	Result<PageIterator<Response<ListQueuesSegmentResponse, XmlFormat>>>	Lists queues in the storage account with pagination
get_statistics	&self options: Option<QueueServiceClientGetStatisticsOptions<'_>>	Result<Response<StorageServiceStats, XmlFormat>>	Retrieves statistics related to replication for the Queue service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account

---

QueueClient

The QueueClient provides operations to interact with a specific Azure Storage Queue.

Method	Parameters	Return Type	Description
new	endpoint: &str queue_name: &str credential: Arc<dyn TokenCredential> options: Option<QueueClientOptions>	Result<Self>	Creates a new QueueClient using Entra ID authentication
endpoint	&self	&Url	Returns the endpoint URL of the Azure storage account
queue_name	&self	&str	Returns the name of the queue this client is associated with

Queue Management

Method	Parameters	Return Type	Description
create	&self options: Option<QueueClientCreateOptions<'_>>	Result<Response<(), NoFormat>>	Creates a new queue
create_if_not_exists	&self options: Option<QueueClientCreateOptions<'_>>	Result<Response<(), NoFormat>>	Creates a queue if it doesn't already exist
delete	&self options: Option<QueueClientDeleteOptions<'_>>	Result<Response<(), NoFormat>>	Permanently deletes the queue
delete_if_exists	&self options: Option<QueueClientDeleteOptions<'_>>	Result<Response<(), NoFormat>>	Deletes the queue if it exists
exists	&self	Result<bool>	Checks if the queue exists
clear	&self options: Option<QueueClientClearOptions<'_>>	Result<Response<(), NoFormat>>	Clears all messages in the queue

Metadata Operations

Method	Parameters	Return Type	Description
set_metadata	&self options: Option<QueueClientSetMetadataOptions<'_>>	Result<Response<(), NoFormat>>	Sets the metadata for the queue
get_metadata	&self options: Option<QueueClientGetMetadataOptions<'_>>	Result<Response<QueueClientGetMetadataResult, NoFormat>>	Retrieves the metadata of the queue

Message Operations

Method	Parameters	Return Type	Description
enqueue_message	&self message: &str options: Option<QueueClientEnqueueOptions<'_>>	Result<Response<Option<EnqueuedMessage>, XmlFormat>>	Enqueues a message to the queue
dequeue_message	&self options: Option<QueueClientDequeueOptions<'_>>	Result<Response<Option<DequeuedMessage>, XmlFormat>>	Retrieves a single message from the front of the queue
dequeue_messages	&self options: Option<QueueClientDequeueOptions<'_>>	Result<Response<ListOfDequeuedMessage, XmlFormat>>	Retrieves multiple messages from the front of the queue
peek_message	&self options: Option<QueueClientPeekOptions<'_>>	Result<Response<Option<PeekedMessage>, XmlFormat>>	Peeks a single message without removing it
peek_messages	&self options: Option<QueueClientPeekOptions<'_>>	Result<Response<ListOfPeekedMessage, XmlFormat>>	Peeks multiple messages without removing them
delete_message	&self message_id: &str pop_receipt: &str options: Option<QueueClientDeleteMessageOptions<'_>>	Result<Response<(), NoFormat>>	Deletes a specific message from the queue
update_message	&self message_id: &str pop_receipt: &str visibility_timeout: i32 options: Option<QueueClientUpdateOptions<'_>>	Result<Response<(), NoFormat>>	Updates a specific message in the queue

Access Policy Operations

Method	Parameters	Return Type	Description
get_access_policy	&self options: Option<QueueClientGetAccessPolicyOptions<'_>>	Result<Response<ListOfSignedIdentifier, XmlFormat>>	Retrieves the access policy for the queue
set_access_policy	&self queue_acl: RequestContent<ListOfSignedIdentifier> options: Option<QueueClientSetAccessPolicyOptions<'_>>	Result<Response<QueueClientSetAccessPolicyResult, NoFormat>>	Sets the access policy for the queue

Examples of how to use each method has been provided in the sdk/storage/examples/queue_client.rs file.

Recorded tests has also been pushed to the repo Azure/azure-sdk-assets and the assets.json updated.

The client is generated using tsp-client using remote Azure/azure-rest-api-specs repo.

[Copilot]

Pull Request Overview

This PR implements initial support for the 2018-03-28 Queue API in the Azure Storage Queue SDK for Rust. Key changes include the introduction of new client functions for managing queues, a comprehensive test suite covering the new operations, and several example programs and documentation updates.

Reviewed Changes

Copilot reviewed 18 out of 36 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
sdk/storage/azure_storage_queue/tsp-location.yaml	Adds configuration metadata for the queue API
sdk/storage/azure_storage_queue/tests/queue_service_client.rs	Introduces recorded tests for queue service
sdk/storage/azure_storage_queue/src/lib.rs	Sets up module exports for clients and models
sdk/storage/azure_storage_queue/src/clients/queue_service_client.rs	Implements QueueServiceClient API functions
sdk/storage/azure_storage_queue/examples/*	Provides usage examples and helper functions
sdk/storage/azure_storage_queue/Cargo.toml	Configures the crate with required dependencies and features
sdk/storage/azure_storage_queue/CHANGELOG.md	Documents the initial supported release
sdk/storage/assets.json	Updates asset references
sdk/storage/.dict.txt	Updates custom dictionary with new terms
Cargo.toml	Adds the queue SDK to the workspace members

Comments suppressed due to low confidence (1)

sdk/storage/azure_storage_queue/src/clients/queue_service_client.rs:90

• The documentation for the 'queue_name' parameter in the delete_queue function incorrectly states that it is 'to create' the queue. Please update the description to indicate that it is the name of the queue to delete.

    /// * `queue_name` - The name of the queue to create

[github-actions]

API Change Check

APIView identified API level changes in this PR and created the following API reviews

azure_storage_queue