Shuttle.Esb.AzureEventHubs 20.0.0

Prefix Reserved
dotnet add package Shuttle.Esb.AzureEventHubs --version 20.0.0                
NuGet\Install-Package Shuttle.Esb.AzureEventHubs -Version 20.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="20.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 20.0.0                
#r "nuget: Shuttle.Esb.AzureEventHubs, 20.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=20.0.0

// Install Shuttle.Esb.AzureEventHubs as a Cake Tool
#tool nuget:?package=Shuttle.Esb.AzureEventHubs&version=20.0.0                

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 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 was computed.  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. 
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
20.0.0 70 2/2/2025
15.0.0 95 8/5/2024
14.0.3 528 5/3/2024
14.0.0 122 4/30/2024
13.2.1 4,560 12/1/2022
13.2.0 362 11/6/2022