NetEvolve.Pulse.AzureQueueStorage 0.84.106

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package NetEvolve.Pulse.AzureQueueStorage --version 0.84.106
                    


                    

                
NuGet\Install-Package NetEvolve.Pulse.AzureQueueStorage -Version 0.84.106
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="NetEvolve.Pulse.AzureQueueStorage" Version="0.84.106" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="NetEvolve.Pulse.AzureQueueStorage" Version="0.84.106" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="NetEvolve.Pulse.AzureQueueStorage" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add NetEvolve.Pulse.AzureQueueStorage --version 0.84.106
                    


                    

                
#r "nuget: NetEvolve.Pulse.AzureQueueStorage, 0.84.106"
#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. 
#:package NetEvolve.Pulse.AzureQueueStorage@0.84.106
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=NetEvolve.Pulse.AzureQueueStorage&version=0.84.106
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=NetEvolve.Pulse.AzureQueueStorage&version=0.84.106
                    


                            Install as a Cake Tool

NetEvolve.Pulse.AzureQueueStorage

NuGet Version NuGet Downloads License

Azure Queue Storage transport for the Pulse outbox pattern. A cost-effective alternative to Azure Service Bus, available in every Azure Storage account with a 48 KB raw message size limit.

Features

  • Connection Flexibility: Use a connection string or DefaultAzureCredential with a service URI.
  • Automatic Queue Creation: Optionally creates the target queue on first use via CreateQueueIfNotExists.
  • Base64 Encoding: Messages are JSON-serialized and Base64-encoded before sending, matching Azure Queue Storage requirements.
  • Size Guard: Throws InvalidOperationException when a raw message exceeds 48 KB.
  • Sequential Batch Delivery: SendBatchAsync iterates messages sequentially.
  • Dependency Injection: Single call UseAzureQueueStorageTransport wires the transport.

Installation

.NET CLI

dotnet add package NetEvolve.Pulse.AzureQueueStorage

PackageReference

<PackageReference Include="NetEvolve.Pulse.AzureQueueStorage" Version="x.x.x" />

Quick Start

Connection String

using Microsoft.Extensions.DependencyInjection;
using NetEvolve.Pulse;

var services = new ServiceCollection();

services.AddPulse(config => config.UseAzureQueueStorageTransport(
    connectionString: builder.Configuration["Storage:ConnectionString"]!
));

Managed Identity

services.AddPulse(config => config.UseAzureQueueStorageTransport(
    queueServiceUri: new Uri("https://myaccount.queue.core.windows.net")
));

Configuration

Option Description
ConnectionString Azure Storage connection string. Required when QueueServiceUri is not set.
QueueServiceUri Azure Queue Storage service URI used with managed identity (DefaultAzureCredential). Required when ConnectionString is not set.
QueueName Name of the queue to send messages to. Defaults to pulse-outbox.
MessageVisibilityTimeout Optional initial delay before a sent message becomes visible to consumers. null means zero, so messages are visible immediately. It is not a processing lock. Must be between 00:00:00 and 7.00:00:00, and smaller than a finite MessageTimeToLive. Without MessageTimeToLive, the service default of 7 days applies, so it must be smaller than 7.00:00:00.
MessageTimeToLive Optional time-to-live of each sent message. null keeps the service default of 7 days. Must be between one second and int.MaxValue seconds (about 68 years), or AzureQueueStorageTransportOptions.NeverExpires (-00:00:01) / Timeout.InfiniteTimeSpan for messages that never expire.
CreateQueueIfNotExists Automatically creates the queue on first use. Defaults to true.

Visibility Timeout and Time-to-Live

Both options map to the Put Message operation and are validated at startup.

  • MessageVisibilityTimeout delays the first delivery: the message stays invisible for this duration after it was sent. Consumers set their own visibility timeout when they receive a message.
  • Without MessageTimeToLive, the service deletes a message 7 days after it was sent, even though the outbox already marked it as delivered. Set a longer value, or NeverExpires, when consumers can be offline for longer.
  • Azure Queue Storage uses whole seconds, so fractions of a second are truncated.
services.AddPulse(config => config.UseAzureQueueStorageTransport(
    connectionString: builder.Configuration["Storage:ConnectionString"]!,
    options => options.MessageTimeToLive = AzureQueueStorageTransportOptions.NeverExpires
));

Configuration via appsettings.json

Register AzureQueueStorageTransportOptionsConfiguration to bind from the Pulse:Transports:AzureQueueStorage section:

services.AddSingleton<IConfigureOptions<AzureQueueStorageTransportOptions>, AzureQueueStorageTransportOptionsConfiguration>();

{
  "Pulse": {
    "Transports": {
      "AzureQueueStorage": {
        "QueueName": "my-outbox",
        "CreateQueueIfNotExists": true
      }
    }
  }
}

Wire Format

Each outbox message is sent as a Base64-encoded UTF-8 JSON envelope:

{
  "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "eventType": "MyApp.Events.OrderCreated, MyApp",
  "payload": "{\"orderId\":42}",
  "correlationId": "corr-123",
  "causationId": null,
  "createdAt": "2026-09-24T10:15:00+00:00"
}
Property Description
id Outbox message identifier.
eventType Outbox event type identifier of the event.
payload The event as written to the outbox by IPayloadSerializer when it was stored, embedded as a JSON string and not serialized again.
correlationId Optional correlation identifier, written as null when absent.
causationId Optional causation identifier, written as null when absent.
createdAt Creation timestamp of the outbox message.

The envelope is serialized with the JsonSerializerOptions configured through services.Configure<JsonSerializerOptions>(...), the same options the default IPayloadSerializer uses, so converters and the encoder apply, for example to createdAt. The property names are fixed and the optional identifiers are always written, and DefaultIgnoreCondition, ReferenceHandler and WriteIndented are reset for the envelope, so neither these settings nor a naming policy change its shape or size. An internal source-generated context is appended to a copy of the options as fallback resolver, so the envelope needs no reflection in trimmed or NativeAOT applications.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.84.106 56 11/8/2026
0.70.75 1,376 7/28/2026
0.70.16 393 7/27/2026
0.70.0 176 7/24/2026

https://github.com/dailydevops/pulse/releases