Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

lsiddiquee
Copy link
Member

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.

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.
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@lsiddiquee lsiddiquee marked this pull request as draft June 24, 2025 18:51
@github-actions github-actions bot added the Storage Storage Service (Queues, Blobs, Files) label Jun 24, 2025
Copy link

API Change Check

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

azure_storage_queue

@lsiddiquee lsiddiquee changed the title Initial implementation of the queue sdk (#2730) Added sdk/storage/azure_storage_queue (#2730) Jun 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Storage Storage Service (Queues, Blobs, Files)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support storage queues
1 participant