Azure.Storage.Queues 12.17.1

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Azure.Storage.Queues --version 12.17.1
NuGet\Install-Package Azure.Storage.Queues -Version 12.17.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Azure.Storage.Queues" Version="12.17.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Azure.Storage.Queues --version 12.17.1
#r "nuget: Azure.Storage.Queues, 12.17.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Azure.Storage.Queues as a Cake Addin
#addin nuget:?package=Azure.Storage.Queues&version=12.17.1

// Install Azure.Storage.Queues as a Cake Tool
#tool nuget:?package=Azure.Storage.Queues&version=12.17.1

Azure Storage Queues client library for .NET

Server Version: 2021-02-12, 2020-12-06, 2020-10-02, 2020-08-04, 2020-06-12, 2020-04-08, 2020-02-10, 2019-12-12, 2019-07-07, and 2019-02-02

Azure Queue storage is a service for storing large numbers of messages that can be accessed from anywhere in the world via authenticated calls using HTTP or HTTPS. A single queue message can be up to 64 KB in size, and a queue can contain millions of messages, up to the total capacity limit of a storage account.

Source code | Package (NuGet) | API reference documentation | REST API documentation | Product documentation

Getting started

Install the package

Install the Azure Storage Queues client library for .NET with NuGet:

dotnet add package Azure.Storage.Queues

Prerequisites

You need an Azure subscription and a Storage Account to use this package.

To create a new Storage Account, you can use the Azure Portal, Azure PowerShell, or the Azure CLI. Here's an example using the Azure CLI:

az storage account create --name MyStorageAccount --resource-group MyResourceGroup --location westus --sku Standard_LRS

Authenticate the client

In order to interact with the Azure Queue Storage service, you'll need to create an instance of the QueueClient class. The Azure Identity library makes it easy to add Azure Active Directory support for authenticating Azure SDK clients with their corresponding Azure services.

// Create a QueueClient that will authenticate through Active Directory
Uri queueUri = new Uri("https://MYSTORAGEACCOUNT.queue.core.windows.net/QUEUENAME");
QueueClient queue = new QueueClient(queueUri, new DefaultAzureCredential());

Learn more about enabling Azure Active Directory for authentication with Azure Storage in our documentation and our samples.

Key concepts

Common uses of Queue storage include:

  • Creating a backlog of work to process asynchronously
  • Passing messages between different parts of a distributed application

Thread safety

We guarantee that all client instance methods are thread-safe and independent of each other (guideline). This ensures that the recommendation of reusing client instances is always safe, even across threads.

Additional concepts

Client options | Accessing the response | Long-running operations | Handling failures | Diagnostics | Mocking | Client lifetime

Examples

Send messages

// We'll need a connection string to your Azure Storage account.
// You can obtain your connection string from the Azure Portal
// (click Access Keys under Settings in the Portal Storage account
// blade) or using the Azure CLI with:
//
//     az storage account show-connection-string --name <account_name> --resource-group <resource_group>
//
// You would normally provide the connection string to your
// application using an environment variable.
string connectionString = "<connection_string>";

// Name of the queue we'll send messages to
string queueName = "sample-queue";

// Get a reference to a queue and then create it
QueueClient queue = new QueueClient(connectionString, queueName);
queue.Create();

// Send a message to our queue
queue.SendMessage("Hello, Azure!");

Receive messages

// We'll need a connection string to your Azure Storage account.
string connectionString = "<connection_string>";

// Name of an existing queue we'll operate on
string queueName = "sample-queue";

// Get a reference to a queue and then fill it with messages
QueueClient queue = new QueueClient(connectionString, queueName);
queue.SendMessage("first");
queue.SendMessage("second");
queue.SendMessage("third");

// Get the next messages from the queue
foreach (QueueMessage message in queue.ReceiveMessages(maxMessages: 10).Value)
{
    // "Process" the message
    Console.WriteLine($"Message: {message.Body}");

    // Let the service know we're finished with the message and
    // it can be safely deleted.
    queue.DeleteMessage(message.MessageId, message.PopReceipt);
}

Async APIs

We fully support both synchronous and asynchronous APIs.

// We'll need a connection string to your Azure Storage account.
string connectionString = "<connection_string>";

// Name of the queue we'll send messages to
string queueName = "sample-queue";

// Get a reference to a queue and then create it
QueueClient queue = new QueueClient(connectionString, queueName);
await queue.CreateAsync();

// Send a message to our queue
await queue.SendMessageAsync("Hello, Azure!");

Message encoding

This version of library does not encode message by default. V11 and prior versions as well as Azure Functions use base64-encoded messages by default. Therefore it's recommended to use this feature for interop scenarios.

QueueClientOptions queueClientOptions = new QueueClientOptions()
{
    MessageEncoding = QueueMessageEncoding.Base64
};

QueueClient queueClient = new QueueClient(connectionString, queueName, queueClientOptions);

Troubleshooting

All Azure Storage Queue service operations will throw a RequestFailedException on failure with helpful ErrorCodes. Many of these errors are recoverable.

// We'll need a connection string to your Azure Storage account.
string connectionString = "<connection_string>";

// Name of an existing queue we'll operate on
string queueName = "sample-queue";

try
{
    // Try to create a queue that already exists
    QueueClient queue = new QueueClient(connectionString, queueName);
    queue.Create();
}
catch (RequestFailedException ex)
    when (ex.ErrorCode == QueueErrorCode.QueueAlreadyExists)
{
    // Ignore any errors if the queue already exists
}

Next steps

Get started with our Queue samples:

  1. Hello World: Enqueue, Dequeue, Peek, and Update queue messages (or asynchronously)
  2. Auth: Authenticate with connection strings, shared keys, shared access signatures, and Azure Active Directory.

Contributing

See the Storage CONTRIBUTING.md for details on building, testing, and contributing to this library.

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit cla.microsoft.com.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (148)

Showing the top 5 NuGet packages that depend on Azure.Storage.Queues:

Package Downloads
Microsoft.Azure.DurableTask.AzureStorage The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Azure Storage provider extension for the Durable Task Framework.

Microsoft.Azure.WebJobs.Extensions.Storage.Queues The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

This extension adds bindings for Storage

Microsoft.Azure.WebJobs.Extensions.Storage.Blobs The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

This extension adds bindings for Storage

AspNetCore.HealthChecks.AzureStorage

HealthChecks.AzureStorage is the health check package for Blobs, Tables and Queues.

Microsoft.Azure.Functions.Worker.Extensions.Storage.Queues The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Azure Queue Storage extensions for .NET isolated functions

GitHub repositories (39)

Showing the top 5 popular GitHub repositories that depend on Azure.Storage.Queues:

Repository Stars
bitwarden/server
The core infrastructure backend (API, database, Docker, etc).
dotnet/AspNetCore.Docs
Documentation for ASP.NET Core
dotnet/orleans
Cloud Native application framework for .NET
dotnet/tye
Tye is a tool that makes developing, testing, and deploying microservices and distributed applications easier. Project Tye includes a local orchestrator to make developing microservices easier and the ability to deploy microservices to Kubernetes with minimal configuration.
Azure/azure-sdk-for-net
This repository is for active development of the Azure SDK for .NET. For consumers of the SDK we recommend visiting our public developer docs at https://learn.microsoft.com/dotnet/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-net.
Version Downloads Last updated
12.18.0-beta.1 11,116 12/5/2023
12.17.1 1,368,911 11/14/2023
12.17.0 96,474 11/6/2023
12.17.0-beta.1 1,781 10/16/2023
12.16.0 1,313,699 9/12/2023
12.16.0-beta.1 3,591 8/8/2023
12.15.0 1,923,219 7/11/2023
12.15.0-beta.1 13,168 5/30/2023
12.14.0 4,954,075 4/11/2023
12.14.0-beta.1 922 3/28/2023
12.13.1 1,490,173 3/24/2023
12.13.0 927,058 2/22/2023
12.13.0-beta.1 4,207 2/8/2023
12.12.0 5,102,471 10/12/2022
12.12.0-beta.1 3,621 8/23/2022
12.11.1 5,306,377 8/23/2022
12.11.0 3,404,227 7/8/2022
12.11.0-beta.1 2,368 6/15/2022
12.10.0 6,215,356 5/2/2022
12.10.0-beta.1 1,172 4/12/2022
12.9.0 1,371,212 3/10/2022
12.9.0-beta.3 30,412 2/7/2022
12.9.0-beta.2 69,299 11/30/2021
12.9.0-beta.1 5,934 11/4/2021
12.8.0 11,341,960 9/9/2021
12.8.0-beta.2 20,076 7/23/2021
12.8.0-beta.1 568 7/23/2021
12.7.0 1,741,068 6/9/2021
12.7.0-beta.4 159,395 5/12/2021
12.7.0-beta.3 5,191 4/9/2021
12.7.0-beta.2 20,014 3/10/2021
12.7.0-beta.1 27,141 2/10/2021
12.6.2 331,208 5/21/2021
12.6.1 1,408,662 3/29/2021
12.6.0 1,784,018 1/12/2021
12.6.0-beta.1 11,244 12/7/2020
12.5.0 1,752,179 11/10/2020
12.5.0-preview.1 20,066 10/1/2020
12.4.2 4,345,580 8/31/2020
12.4.1 198,230 8/18/2020
12.4.0-preview.6 17,719 7/28/2020
12.4.0-preview.5 8,715 7/3/2020
12.4.0-preview.4 3,387 6/19/2020
12.4.0-preview.1 1,800 6/8/2020
12.3.2 1,279,413 6/5/2020
12.3.1 30,707 6/2/2020
12.3.0 1,077,260 3/12/2020
12.2.0 450,000 2/11/2020
12.1.1 319,432 1/10/2020
12.1.0 30,233 12/4/2019
12.0.0 110,475 10/31/2019
12.0.0-preview.4 1,584 10/10/2019
12.0.0-preview.3 762 9/10/2019
12.0.0-preview.2 678 8/6/2019
12.0.0-preview.1 729 7/3/2019
1.0.0-preview.1 665 5/7/2019