Shuttle.Hopper.AzureEventHubs
21.0.2
Prefix Reserved
dotnet add package Shuttle.Hopper.AzureEventHubs --version 21.0.2
NuGet\Install-Package Shuttle.Hopper.AzureEventHubs -Version 21.0.2
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="Shuttle.Hopper.AzureEventHubs" Version="21.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Shuttle.Hopper.AzureEventHubs" Version="21.0.2" />
<PackageReference Include="Shuttle.Hopper.AzureEventHubs" />
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 Shuttle.Hopper.AzureEventHubs --version 21.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Shuttle.Hopper.AzureEventHubs, 21.0.2"
#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 Shuttle.Hopper.AzureEventHubs@21.0.2
#: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=Shuttle.Hopper.AzureEventHubs&version=21.0.2
#tool nuget:?package=Shuttle.Hopper.AzureEventHubs&version=21.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Shuttle.Hopper.AzureEventHubs
Azure Event Hubs implementation for use with Shuttle.Hopper.
Installation
dotnet add package Shuttle.Hopper.AzureEventHubs
Configuration
The URI structure is azureeh://configuration-name/hub-name.
services.AddHopper()
.UseAzureEventHubs(builder =>
{
builder.Configure("azure", options =>
{
options.ConnectionString = "Endpoint=sb://{hub-namespace}.servicebus.windows.net/;SharedAccessKeyName={key-name};SharedAccessKey={key};EntityPath={hub-name}";
options.BlobStorageConnectionString = "{BlobStorageConnectionString}";
options.ProcessorClient = new() { PrefetchCount = 100 };
options.ProcessEvents = true;
options.ConsumerGroup = "$Default";
options.BlobContainerName = "{BlobContainerName}";
options.OperationTimeout = TimeSpan.FromSeconds(30);
options.ConsumeTimeout = TimeSpan.FromSeconds(30);
options.DefaultStartingPosition = EventPosition.Latest;
options.CheckpointInterval = 1;
options.ProcessError.Register(async args =>
{
Console.WriteLine($"[error] : {args.Exception.Message}");
await Task.CompletedTask;
});
});
});
The default JSON settings structure is as follows:
{
"Shuttle": {
"AzureEventHubs": {
"azure": {
"ConnectionString": "Endpoint=sb://{hub-namespace}.servicebus.windows.net/;SharedAccessKeyName={key-name};SharedAccessKey={key};EntityPath={hub-name}",
"ProcessEvents": false,
"ConsumerGroup": "$Default",
"BlobStorageConnectionString": "{BlobStorageConnectionString}",
"BlobContainerName": "{BlobContainerName}",
"OperationTimeout": "00:00:30",
"ConsumeTimeout": "00:00:30",
"DefaultStartingPosition": "Latest",
"CheckpointInterval": 1
}
}
}
}
EventHubOptions
| Segment / Argument | Default | Description |
|---|---|---|
ConnectionString |
The Azure Event Hubs endpoint to connect to. | |
ProcessEvents |
false |
Indicates whether the endpoint will process messages. If true, an EventProcessorClient is instanced and configured. |
ConsumerGroup |
"$Default" | The consumer group to use when processing events. |
BlobStorageConnectionString |
The Azure Storage Account endpoint to connect to in order to perform checkpoints. | |
BlobContainerName |
The blob container name where checkpoints will be stored. | |
OperationTimeout |
"00:00:30" | The duration to wait for relevant async methods to complete before timing out. |
ConsumeTimeout |
"00:00:30" | The duration to poll for messages before returning null. |
DefaultStartingPosition |
Latest |
The default starting position to use when no checkpoint exists. |
CheckpointInterval |
1 |
The number of events to process before performing a checkpoint. |
ClientIdentifier |
A unique identifier for the client. | |
BlobClient |
The BlobClientOptions used to configure the underlying BlobContainerClient. |
|
ProcessorClient |
The EventProcessorClientOptions used to configure the underlying EventProcessorClient. |
|
ProducerClient |
The EventHubProducerClientOptions used to configure the underlying EventHubProducerClient. |
|
ProcessError |
The AsyncEvent<EventHubProcessErrorEventArgs> triggered when an error occurs during event processing. |
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | 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.
-
net10.0
- Azure.Messaging.EventHubs (>= 5.12.2)
- Azure.Messaging.EventHubs.Processor (>= 5.12.2)
- Shuttle.Hopper (>= 21.0.2)
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 |
|---|---|---|
| 21.0.2 | 86 | 4/17/2026 |
| 21.0.1 | 84 | 4/15/2026 |
| 21.0.1-rc4 | 84 | 4/12/2026 |
| 21.0.1-rc3 | 83 | 4/11/2026 |
| 21.0.1-rc2 | 98 | 3/21/2026 |
| 21.0.1-rc1 | 91 | 2/28/2026 |
| 21.0.1-beta | 102 | 2/7/2026 |
| 21.0.0-alpha | 99 | 1/18/2026 |