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
`delete`	`&self` `options: Option<QueueClientDeleteOptions<'_>>`	`Result<Response<(), NoFormat>>`	Permanently deletes the queue
`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
`send_message`	`&self` `queue_message: RequestContent<QueueMessage>` `options: Option<QueueClientSendMessageOptions<'_>>`	`Result<Response<Option<SentMessage>, XmlFormat>>`	Enqueues a message to the queue
`receive_messages`	`&self` `options: Option<QueueClientReceiveMessagesOptions<'_>>`	`Result<Response<ListOfReceivedMessage, XmlFormat>>`	Retrieves multiple messages from the front of the queue
`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

sdk/storage/azure_storage_queue/CHANGELOG.md

sdk/storage/azure_storage_queue/README.md

sdk/storage/azure_storage_queue/examples/README.md

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

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

sdk/storage/azure_storage_queue/src/lib.rs

sdk/storage/azure_storage_queue/tests/queue_client.rs

sdk/storage/azure_storage_queue/tsp-location.yaml

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

sdk/storage/azure_storage_queue/tests/queue_client.rs

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

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.

- Updated change logs to mention unreleased - Removed all functions list from the README.md - Renaming examples to samples to match pattern in other languages - Removed singular helper functions and exists helper functions - Adjusting code based on update to the dependencies - Changed StorageServiceProperties to QueueServiceProperties - Exposing clients and client options from the crate root - Update test names to reflect operation

…argument in the method directly rather than in the option bag.

…Credential`.

…ceStats`. Updated `QueueClient::send_message` to return `Result<Response<SentMessage, XmlFormat>>` in place of `Result<Response<Option<SentMessage>, XmlFormat>>`

…date

heaths

Most nits/questions, but there is one blocker. After that, doesn't have to be perfect, but I'd like to see some tracking issues opened for other work like missing docs, fixing up the dead_code, etc.

heaths · 2025-08-19T00:45:58Z

sdk/storage/azure_storage_queue/README.md

+# Azure Queue client library for Rust
+
+Azure Queue Storage is a service for storing large numbers of messages.


Nit: some disagreement on branding here. Is it "Azure Queue" or "Azure Queue Storage"? I thought it was actually "Azure Storage Queue".

heaths · 2025-08-19T00:47:31Z

sdk/storage/azure_storage_queue/Cargo.toml

+# Manual example definitions pointing to samples/ directory
+[[example]]
+name = "queue_client"
+path = "samples/queue_client.rs"
+
+[[example]]
+name = "queue_service_client"
+path = "samples/queue_service_client.rs"


That's not idiomatic. Put them in the "examples/" directory and get rid of these entries. It's just extra maintenance for no reason.

heaths · 2025-08-19T00:48:40Z

sdk/storage/azure_storage_queue/Cargo.toml

+
+[features]
+default = ["reqwest"]
+reqwest = ["dep:reqwest"]


Why are you taking a direct dependency on reqwest? This is highly sus. So long as you're HTTP-based, you must use the types in azure_core only so that we have consistent HTTP client override support across all HTTP-based crates: same as any other Azure SDK language.

blocker

heaths · 2025-08-19T00:52:12Z

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

+/// A client to interact with a specific Azure storage queue, although that queue may not yet exist.
+pub struct QueueClient {
+    pub(super) endpoint: Url,
+    pub(super) client: GeneratedQueueClient,


Is wrapping the generated client necessary? I know why Blob is doing it - to "smooth" out the DX - but is that true for Queue as well? Ideally, we're just generating.

heaths · 2025-08-19T00:54:21Z

sdk/storage/azure_storage_queue/src/lib.rs

+#![allow(dead_code)]
+#![allow(unused_imports)]


These are code smells in a lib crate. If you have some code that is surfacing as public in the lib crate or unused imports, you need to fix them. dead_code indicates something isn't used and isn't public. If this is model types, then add #[allow(dead_code)] to that module. Don't do a whole-lib suppression.

heaths · 2025-08-19T00:54:29Z

sdk/storage/azure_storage_queue/src/lib.rs

+#[expect(deprecated, reason = "requires emitter update")]
+mod generated;
+
+pub mod models {


Public modules must be documented.

heaths · 2025-08-19T00:56:28Z

sdk/storage/azure_storage_queue/src/lib.rs

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


Guidelines are that you must make this public and then expose your wrapped clients from there. Instead, do something like:

Suggested change

mod clients;

pub use crate::clients::QueueClient;

pub use crate::clients::QueueServiceClient;

pub use crate::generated::clients::{QueueClientOptions, QueueServiceClientOptions};

//! Necessary documentation

pub mod clients;

Thern in clients/mod.rs, just define the types as pub struct and re-export the queue service client from there.

heaths · 2025-08-19T00:57:34Z

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

+    /// Returns an error if the queue doesn't exist or if the request fails
+    pub async fn set_metadata(
+        &self,
+        metadata: HashMap<String, String>,


Body parameters - if this is a body parameter - must be RequestContent<T>.

heaths · 2025-08-19T01:09:53Z

sdk/storage/azure_storage_queue/samples/helpers/mod.rs

This raises the question of who these samples are for. Are they full-blown EXEs customers can use - like what Cosmos has - or more for copy and pastability? If the latter, a bunch of helpers not within a single source isn't going to be very useful.

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 4 times, most recently from 1833dda to 114ff2e Compare July 1, 2025 13:24

jalauzon-msft reviewed Jul 22, 2025

View reviewed changes

lsiddiquee force-pushed the feature/queue-sdk branch 3 times, most recently from 2a7798a to 334d48f Compare August 7, 2025 15:08

jalauzon-msft reviewed Aug 7, 2025

View reviewed changes

sdk/storage/azure_storage_queue/src/clients/queue_client.rs Show resolved Hide resolved

sdk/storage/azure_storage_queue/tests/queue_client.rs Outdated Show resolved Hide resolved

lsiddiquee force-pushed the feature/queue-sdk branch 2 times, most recently from 439ef72 to fbc34b4 Compare August 8, 2025 14:34

lsiddiquee commented Aug 11, 2025

View reviewed changes

sdk/storage/azure_storage_queue/src/clients/queue_service_client.rs Outdated Show resolved Hide resolved

lsiddiquee added 4 commits August 14, 2025 13:01

This commit contains the following changes:

40bccd5

* 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.

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

7724108

…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 added 3 commits August 14, 2025 13:01

Regenerated client and adjusted the crate to allow metadata to be an …

701ee38

…argument in the method directly rather than in the option bag.

Switching to use DeveloperToolsCredential in place of `DefaultAzure…

5b3e38a

…Credential`.

Regenerate client after renaming StorageServiceStats to `QueueServi…

06f0ab4

…ceStats`. Updated `QueueClient::send_message` to return `Result<Response<SentMessage, XmlFormat>>` in place of `Result<Response<Option<SentMessage>, XmlFormat>>`

lsiddiquee force-pushed the feature/queue-sdk branch from 58c5800 to 06f0ab4 Compare August 14, 2025 13:45

Adding exception on Context::with_context as it requires emitted up…

7487f36

…date

lsiddiquee marked this pull request as ready for review August 14, 2025 14:31

heaths requested changes Aug 19, 2025

View reviewed changes

		# Azure Queue client library for Rust

		Azure Queue Storage is a service for storing large numbers of messages.

		#![allow(dead_code)]
		#![allow(unused_imports)]

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

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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

heaths left a comment

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