Azure Storage Queues

Installation

dotnet add package Shuttle.Hopper.AzureStorageQueues

In order to make use of the AzureStorageQueue you will need access to an Azure Storage account or use the Azurite emulator for local Azure Storage development.

You may want to take a look at how to get started with Azure Queue storage using .NET.

Configuration

The URI structure is azuresq://configuration-name/queue-name.

If ConnectionString is specified the StorageAccount setting will be ignored. When StorageAccount is specified the DefaultAzureCredential will be used to authenticate.

services.AddHopper(hopperBuilder =>
{
    hopperBuilder.UseAzureStorageQueues(builder =>
    {
        var azureStorageQueueOptions = new AzureStorageQueueOptions
        {
            StorageAccount = "devstoreaccount1",
            ConnectionString = "UseDevelopmentStorage=true",
            MaxMessages = 20,
            VisibilityTimeout = null
        };

        builder.AddOptions("azure", azureStorageQueueOptions);
    });
});

The default JSON settings structure is as follows:

{
  "Shuttle": {
    "AzureStorageQueues": {
      "azure": {
        "StorageAccount": "devstoreaccount1",
        "ConnectionString": "UseDevelopmentStorage=true",
        "MaxMessages": 32,
        "VisibilityTimeout": "00:00:30"
      }
    }
  }
}

Options

Segment / Argument	Default	Description
StorageAccount		The name of the storage account.
ConnectionString		The Azure Storage Queue endpoint to connect to.
MaxMessages	32	Specifies the number of messages to fetch from the queue (between 1 and 32).
VisibilityTimeout	null	The message visibility timeout that will be used for messages that fail processing.
QueueClient	null	A QueueClientOptions instance for specific client configuration.