AspireEventHubsExtensions.AddAzureEventHubConsumerClient Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Registers EventHubConsumerClient as a singleton in the services provided by the builder.
public static void AddAzureEventHubConsumerClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string connectionName, Action<Aspire.Azure.Messaging.EventHubs.AzureMessagingEventHubsConsumerSettings>? configureSettings = default, Action<Azure.Core.Extensions.IAzureClientBuilder<Azure.Messaging.EventHubs.Consumer.EventHubConsumerClient,Azure.Messaging.EventHubs.Consumer.EventHubConsumerClientOptions>>? configureClientBuilder = default);static member AddAzureEventHubConsumerClient : Microsoft.Extensions.Hosting.IHostApplicationBuilder * string * Action<Aspire.Azure.Messaging.EventHubs.AzureMessagingEventHubsConsumerSettings> * Action<Azure.Core.Extensions.IAzureClientBuilder<Azure.Messaging.EventHubs.Consumer.EventHubConsumerClient, Azure.Messaging.EventHubs.Consumer.EventHubConsumerClientOptions>> -> unit<Extension()>
Public Sub AddAzureEventHubConsumerClient (builder As IHostApplicationBuilder, connectionName As String, Optional configureSettings As Action(Of AzureMessagingEventHubsConsumerSettings) = Nothing, Optional configureClientBuilder As Action(Of IAzureClientBuilder(Of EventHubConsumerClient, EventHubConsumerClientOptions)) = Nothing)Parameters
- builder
- IHostApplicationBuilder
The IHostApplicationBuilder to read config from and add services to.
- connectionName
- String
A name used to retrieve the connection string from the ConnectionStrings configuration section.
- configureSettings
- Action<AzureMessagingEventHubsConsumerSettings>
An optional method that can be used for customizing the AzureMessagingEventHubsConsumerSettings. It's invoked after the settings are read from the configuration.
- configureClientBuilder
- Action<IAzureClientBuilder<EventHubConsumerClient,EventHubConsumerClientOptions>>
An optional method that can be used for customizing the IAzureClientBuilder<TClient,TOptions>.
Exceptions
Thrown when neither ConnectionString nor FullyQualifiedNamespace is provided.
Remarks
Reads the configuration from "Aspire:Azure:Messaging:EventHubs:{TClient}" section, where {TClient} is the type of Event Hubs client being configured, i.e. EventProcessorClient.