Azure Storage Queues

PM> Install-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. Well StorageAccount is specified the DefaultAzureCredential will be used to authenticate.

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

    azureStorageQueueOptions.Configure += (eventArgs, cancellationToken) =>
    {
        Console.WriteLine($@"[event] : Configure / Uri = '{eventArgs.TransportUri.Uri}'");

        return Task.CompletedTask;
    };

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

The Configure event args arugment exposes the QueueClientOptions directly for any specific options that need to be set.

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.
ConnectionString		The Azure Storage Queue endpoint to connect to.
MaxMessages	32	Specifies the number of messages to fetch from the queue.
VisibilityTimeout	null