Azure Storage Queues Transport Configuration

Configuration parameters

The Azure Storage Queues Transport can be configured using the following parameters:

ConnectionString

Defaults: none

PeekInterval

The amount of time that the transport waits before polling the input queue, in milliseconds.

Defaults: 125 ms

MaximumWaitTimeWhenIdle

In order to save money on the transaction operations, the transport optimizes wait times according to the expected load. The transport will back off when no messages can be found on the queue. The wait time will be increased linearly, but it will never exceed the value specified here, in milliseconds.

Defaults: 30000 ms (30 seconds)

PurgeOnStartup

Instructs the transport to remove any existing messages from the input queue on startup.

Defaults: false, i.e. messages are not removed when endpoint starts.

MessageInvisibleTime

The visibilitytimeout mechanism, supported by Azure Storage Queues, causes the message to become invisible after read for a specified period of time. If the processing unit fails to delete the message in the specified time, the message will reappear on the queue. Then another process can retry the message.

Defaults: 30,000 ms (i.e. 30 seconds)

BatchSize

The number of messages that the transport tries to pull at once from the storage queue. Depending on the expected load, the value should vary between 1 and 32 (the maximum).

Starting from version 8.1.3 of the transport (and from version 7.5.6 for the 7.x version of the transport), the batch size is dynamically calculated based on the endpoints message processing concurrency limit unless explicitly specified. The batch size is calculated based on the following formula

If the message processing concurrency limit is higher than the maximum batch size the degree of parallelism is dynamically increased, unless explicitly specified, to fulfill the concurrency needs of the endpoint while avoiding over fetching of messages. This is done to decrease the likelihood of message visibility timeouts.

Versions 7.x to 7.5.5 and 8.x to 8.1.2 default to a batch size of 32.

DegreeOfReceiveParallelism

The number of parallel receive operations that the transport is issuing against the storage queue to pull messages out of it.

Versions 8.1.3 and higher of the transport (or versions 7.5.6 and higher for the 7.x version of the transport) calculate the value at start-up based on the endpoints message processing concurrency limit, using the following formula:

When the DegreeOfReceiveParallelism is explicitly set, the batch size is dynamically adjusted to fulfill the endpoints message processing limits, if possible, up to the allowed maximum of 32. For example, with a maximum concurrency set to 100 and a DegreeOfReceiveParallelism fixed to 3 an underfetching of 4 messages might occur. Therefore it is advised to tweak both DegreeOfReceiveParallelism to be in alignment with the BatchSize if required. In most cases, the dynamic calculation should be sufficient and no adjustment is required.

Versions 7.x to 7.5.5, and 8.x to 8.1.2, dynamically calculate the value based on the endpoints message processing concurrency limit, using the following equation:

Degree of parallelism = square root of MaxConcurrency

This means that DegreeOfReceiveParallelism message processing loops will receive up to the configured BatchSize number of messages in parallel. For example, using a BatchSize of 32 (the default) and parallelism set to 10 will allow the transport to receive 320 messages from the storage queue at the same time.

SerializeMessageWrapperWith

Messages are wrapped in a transport specific structure containing message metadata. By default, Azure Storage Queues Transport uses the same serializer for the message wrapper as configured for the contained message. It is possible to configure a different serializer for the wrapper using the SerializeMessageWrapperWith option

// serialize the messages using the XML serializer:
endpointConfiguration.UseSerialization<XmlSerializer>();

var transport = new AzureStorageQueueTransport("connection string")
{
    // wrap messages in JSON
    MessageWrapperSerializationDefinition = new NewtonsoftJsonSerializer()
};

endpointConfiguration.UseTransport(transport);

Setting configuration parameters

Settings should be set when instantiating the transport:

var queueServiceClient = new QueueServiceClient("connectionString", new QueueClientOptions());
var blobServiceClient = new BlobServiceClient("connectionString", new BlobClientOptions());
var cloudStorageAccount = CloudStorageAccount.Parse("connectionString");
var cloudTableClient = cloudStorageAccount.CreateCloudTableClient();

var transport = new AzureStorageQueueTransport(queueServiceClient, blobServiceClient, cloudTableClient)
{
    ReceiverBatchSize = 20,
    MaximumWaitTimeWhenIdle = TimeSpan.FromSeconds(1),
    DegreeOfReceiveParallelism = 16,
    PeekInterval = TimeSpan.FromMilliseconds(100),
    MessageInvisibleTime = TimeSpan.FromSeconds(30)
};

endpointConfiguration.UseTransport(transport);

Use the QueueServiceClient, BlobServiceClient or TableServiceClient constructor overload that suits the authentication needs when creating the clients passed to the transport.

Native publish/subscribe

SubscriptionTableName

To control the subscription table name, use

var transport = new AzureStorageQueueTransport("connectionString");
transport.Subscriptions.SubscriptionTableName = "NewName";

Caching

Configure the duration of subscription caching using. The default value is 5 seconds.

var transport = new AzureStorageQueueTransport("connectionString");
transport.Subscriptions.CacheInvalidationPeriod = TimeSpan.FromSeconds(10);

Or disable caching entirely

var transport = new AzureStorageQueueTransport("connectionString");
transport.Subscriptions.DisableCaching = true;

Connection strings

Note that multiple connection string formats apply when working with Azure storage services. When running against the emulated environment the format is UseDevelopmentStorage=true, but when running against a cloud hosted storage account the format is DefaultEndpointsProtocol=https;AccountName=myAccount;AccountKey=myKey;

For more details refer to Configuring Azure Connection Strings document.

Using aliases for connection strings to storage accounts

Storage account aliases are enforced by default. The alias is mapped to the physical storage account represented by a QueueServiceClient or a connection string (for backward compatibility).

See also Using aliases instead of connection strings for multi-account support.

Token-credentials

Enables usage of Microsoft Entra ID authentication such as managed identities for Azure resources instead of the shared secret in the connection string.

Use the corresponding QueueServiceClient, BlobServiceClient or TableServiceClient constructor overload when creating the clients passed to the transport.

Sanitization

If a queue name is longer than 63 characters, the Azure Storage Queues Transport will fail to start. The endpoint name would needs to be shortened following the sanitization rules enforced by the Storage queue service.

For more details refer to Sanitization document.

Serialization

Azure Storage Queues Transport changes the default serializer to JSON. The serializer can be changed using the serialization API.