Added sdk/storage/azure_storage_queue (#2730) #2732

lsiddiquee · 2025-06-24T18:51:29Z

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 · 2025-06-24T19:02:42Z

API Change Check

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

azure_storage_queue

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: queue_client: new create create_if_not_exists clear delete delete_if_exists delete_message exists get_metadata get_properties enqueue_message dequeue_message dequeue_messages peek_message peek_messages set_metadata update_message get_access_policy set_access_policy queue_service_client: new create_queue delete_queue get_properties set_properties list_queues_segment (paginated) 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.

* Regenerated client based on new TSP * Switching set and get metadata to use the generated client. * Added get_statistics * Updated samples to show how to pass realistic parameters.

…json for the queue crate. Removing access policy api as there is issue with (de)serialization and this is also not yet implemented in blob.

jalauzon-msft · 2025-07-22T22:09:46Z

sdk/storage/azure_storage_queue/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Release History
+
+## 0.1.0 (2025-06-17)


Probably set this date to "Unreleased" for now.

jalauzon-msft · 2025-07-22T22:13:29Z

sdk/storage/azure_storage_queue/README.md

+
+You may need to specify RBAC roles to access Queues via Microsoft Entra ID. Please see [Assign an Azure role for access to queue data] for more details.
+
+## Features


I think we should probably omit this section outlining all the methods. This would be hard to maintain and should be covered by docs.

jalauzon-msft · 2025-07-22T22:15:11Z

sdk/storage/azure_storage_queue/examples/README.md

@@ -0,0 +1,10 @@
+# Storage Queue Examples


Please change the name of this whole folder to samples instead of examples. This just matches the pattern we follow in our other languages.

jalauzon-msft · 2025-07-22T22:37:22Z

sdk/storage/azure_storage_queue/src/clients/queue_client.rs

+    ///
+    /// Returns a `Result` containing the response. If the queue already exists,
+    /// returns a success response with no content (204 No Content)
+    pub async fn create_if_not_exists(


After some consideration, I think maybe we should remove all the "exists" type methods for now. (with the exception of the plain exists method below). They cannot be generated, and we are still discussing whether we want to introduce these types of methods in Rust across all of packages. Our different languages differ in whether they are included or not.

jalauzon-msft · 2025-07-22T22:38:44Z

sdk/storage/azure_storage_queue/src/clients/queue_client.rs

+    pub async fn exists(&self) -> Result<bool> {
+        match self.get_metadata(None).await {
+            Ok(_) => Ok(true),
+            Err(e) if e.http_status().unwrap() == StatusCode::NotFound => {


(This exists is fine to have)
We don't want to use unwrap in any production code was we don't want to ever panic.

jalauzon-msft · 2025-07-22T23:01:21Z

sdk/storage/azure_storage_queue/src/clients/queue_client.rs

+    /// # Errors
+    ///
+    /// Returns an error if the queue doesn't exist or if the request fails
+    pub async fn receive_message(


I think for now let's omit the "single" message APIs where we call the plural one with number_of_messages set to 1. To me, they don't add much value as the customer could just call the plural one themselves and parse the response. I know they exist in .NET, but I'm not sure they are really needed. Also, these are methods that cannot be generated. If we get feedback that they are needed, we can consider adding them back via extension methods.

Are these things that your team would really need?

jalauzon-msft · 2025-07-22T23:05:53Z

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

+    /// Returns a `Result` containing the response if successful.
+    pub async fn set_properties(
+        &self,
+        storage_service_properties: RequestContent<StorageServiceProperties>,


Can we rename this model to just QueueServiceProperties? This would also change get_properties. This can be done in the TypeSpec and we will do the same for Blob. Don't make the TypeSpec change specific to Rust, fine to completely rename the model.

jalauzon-msft · 2025-07-22T23:15:49Z

sdk/storage/azure_storage_queue/src/lib.rs

+    mod queue_service_client;
+    pub use self::queue_client::QueueClient;
+    pub use self::queue_service_client::QueueServiceClient;
+    pub use crate::generated::clients::{QueueClientOptions, QueueServiceClientOptions};


The clients and client options should be exported from the root of the crate, not inside a clients module.

jalauzon-msft · 2025-07-22T23:20:59Z

sdk/storage/azure_storage_queue/tests/queue_client.rs

+
+/// Attempts to receive the first message from an empty queue in Azure Storage Queue service.
+#[recorded::test]
+async fn test_dequeue_message_empty(ctx: TestContext) -> Result<()> {


Let's rename the dequeue test to match the APi, receive_message.

Please note if you rename or delete tests, its best to manually remove the old recordings from the assets. Unfortunately, this does not happen automatically.

jalauzon-msft · 2025-07-22T23:25:27Z

sdk/storage/azure_storage_queue/tsp-location.yaml

@@ -0,0 +1,4 @@
+directory: specification/storage/Azure.Storage.Queues


Can we keep the TypeSpec in the old folder location, Microsoft.QueueStorage?

Copilot AI review requested due to automatic review settings June 24, 2025 18:51

lsiddiquee requested review from hallipr, weshaggard, heaths, RickWinter, LarryOsterman, vincenttran-msft, jalauzon-msft and ronniegeraghty as code owners June 24, 2025 18:51

Copilot AI reviewed Jun 24, 2025

View reviewed changes

lsiddiquee marked this pull request as draft June 24, 2025 18:51

github-actions bot added the Storage Storage Service (Queues, Blobs, Files) label Jun 24, 2025

lsiddiquee changed the title ~~Initial implementation of the queue sdk (#2730)~~ Added sdk/storage/azure_storage_queue (#2730) Jun 24, 2025

lsiddiquee force-pushed the feature/queue-sdk branch 2 times, most recently from 24925f4 to ce518e5 Compare June 30, 2025 14:33

lsiddiquee added 2 commits July 1, 2025 11:43

This commit contains the following changes:

58e3d8f

* Regenerated client based on new TSP * Switching set and get metadata to use the generated client. * Added get_statistics * Updated samples to show how to pass realistic parameters.

lsiddiquee force-pushed the feature/queue-sdk branch from ce518e5 to 1833dda Compare July 1, 2025 11:43

Clients now reflect more in line to csharp. Adding a separate assets.…

114ff2e

…json for the queue crate. Removing access policy api as there is issue with (de)serialization and this is also not yet implemented in blob.

lsiddiquee force-pushed the feature/queue-sdk branch from 1833dda to 114ff2e Compare July 1, 2025 13:24

jalauzon-msft reviewed Jul 22, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Added sdk/storage/azure_storage_queue (#2730) #2732

Added sdk/storage/azure_storage_queue (#2730) #2732

Uh oh!

lsiddiquee commented Jun 24, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

github-actions bot commented Jun 24, 2025 •

edited

Loading

Uh oh!

jalauzon-msft Jul 22, 2025

Uh oh!

jalauzon-msft Jul 22, 2025

Uh oh!

jalauzon-msft Jul 22, 2025

Uh oh!

jalauzon-msft Jul 22, 2025

Uh oh!

jalauzon-msft Jul 22, 2025

Uh oh!

jalauzon-msft Jul 22, 2025

Uh oh!

jalauzon-msft Jul 22, 2025

Uh oh!

jalauzon-msft Jul 22, 2025

Uh oh!

jalauzon-msft Jul 22, 2025

Uh oh!

jalauzon-msft Jul 22, 2025

Uh oh!

Uh oh!


		You may need to specify RBAC roles to access Queues via Microsoft Entra ID. Please see [Assign an Azure role for access to queue data] for more details.

		## Features

		@@ -0,0 +1,4 @@
		directory: specification/storage/Azure.Storage.Queues

Added sdk/storage/azure_storage_queue (#2730) #2732

Are you sure you want to change the base?

Added sdk/storage/azure_storage_queue (#2730) #2732

Uh oh!

Conversation

lsiddiquee commented Jun 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

QueueServiceClient

QueueClient

Queue Management

Metadata Operations

Message Operations

Access Policy Operations

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

github-actions bot commented Jun 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

API Change Check

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

lsiddiquee commented Jun 24, 2025 •

edited

Loading

github-actions bot commented Jun 24, 2025 •

edited

Loading