Shuttle.Esb.AzureEventHubs
15.0.0
Prefix Reserved
dotnet add package Shuttle.Esb.AzureEventHubs --version 15.0.0
NuGet\Install-Package Shuttle.Esb.AzureEventHubs -Version 15.0.0
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.Esb.AzureEventHubs" Version="15.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Shuttle.Esb.AzureEventHubs --version 15.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Shuttle.Esb.AzureEventHubs, 15.0.0"
#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.
// Install Shuttle.Esb.AzureEventHubs as a Cake Addin #addin nuget:?package=Shuttle.Esb.AzureEventHubs&version=15.0.0 // Install Shuttle.Esb.AzureEventHubs as a Cake Tool #tool nuget:?package=Shuttle.Esb.AzureEventHubs&version=15.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
AzureEventHubs
PM> Install-Package Shuttle.Esb.AzureEventHubs
Configuration
The URI structure is azureeh://configuration-name/queue-name
.
services.AddAzureEventHubs(builder =>
{
var eventHubQueueOptions = new EventHubQueueOptions
{
ConnectionString = "UseDevelopmentStorage=true",
ProcessEvents = false,
ConsumerGroup = EventHubConsumerClient.DefaultConsumerGroupName,
BlobStorageConnectionString = "{BlobStorageConnectionString}",
BlobContainerName = "{BlobContainerName}",
OperationTimeout = TimeSpan.FromSeconds(30),
ConsumeTimeout = TimeSpan.FromSeconds(30),
DefaultStartingPosition = EventPosition.Latest
};
eventHubQueueOptions.ConfigureProducer += (sender, args) =>
{
Console.WriteLine($"[event] : ConfigureProducer / Uri = '{((IQueue)sender).Uri}'");
};
eventHubQueueOptions.ConfigureBlobStorage += (sender, args) =>
{
Console.WriteLine($"[event] : ConfigureBlobStorage / Uri = '{((IQueue)sender).Uri}'");
};
eventHubQueueOptions.ConfigureConsumer += (sender, args) =>
{
Console.WriteLine($"[event] : ConfigureConsumer / Uri = '{((IQueue)sender).Uri}'");
};
builder.AddOptions("azure", eventHubQueueOptions);
});
In the Configure
events the args
arugment exposes the relevant client options directly should you need to set an values explicitly.
The default JSON settings structure is as follows:
{
"Shuttle": {
"AzureEventHubs": {
"azure": {
"ConnectionString": "UseDevelopmentStorage=true",
"ProcessEvents": false,
"ConsumerGroup": "$Default",
"BlobStorageConnectionString": "{BlobStorageConnectionString}",
"BlobContainerName": "{BlobContainerName}",
"OperationTimeout": "00:00:30",
"ConsumeTimeout": "00:00:30",
"DefaultStartingPosition": "Latest"
}
}
}
}
Options
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 |
The default starting position to use when no checkpoint exists. |
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. 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. |
.NET Core | netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.1 is compatible. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
- Azure.Messaging.EventHubs (>= 5.11.5)
- Azure.Messaging.EventHubs.Processor (>= 5.11.4)
- Shuttle.Esb (>= 15.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.