AspireServiceBusExtensions Methods

ClassMethods2 members

Provides extension methods for registering ServiceBus.ServiceBusClient as a singleton in the services provided by the Hosting.IHostApplicationBuilder.

AddAzureServiceBusClient(IHostApplicationBuilder, string, Action<AzureMessagingServiceBusSettings>, Action<IAzureClientBuilder<ServiceBusClient, ServiceBusClientOptions>>)

extension

Registers ServiceBus.ServiceBusClient as a singleton in the services provided by the builder.

public static class AspireServiceBusExtensions
{
    public static void AddAzureServiceBusClient(
        this IHostApplicationBuilder builder,
        string connectionName,
        Action<AzureMessagingServiceBusSettings>? configureSettings = null,
        Action<IAzureClientBuilder<ServiceBusClient, ServiceBusClientOptions>>? configureClientBuilder = null)
    {
        // ...
    }
}

AspireServiceBusExtensions.cs#L40-L44

Parameters

builderIHostApplicationBuilderThe Hosting.IHostApplicationBuilder to read config from and add services to.

connectionNamestringA name used to retrieve the connection string from the ConnectionStrings configuration section.

configureSettingsAction<AzureMessagingServiceBusSettings>optionalAn optional method that can be used for customizing the AzureMessagingServiceBusSettings. It's invoked after the settings are read from the configuration.

configureClientBuilderAction<IAzureClientBuilder<ServiceBusClient, ServiceBusClientOptions>>optionalAn optional method that can be used for customizing the Extensions.IAzureClientBuilder`2.

Exceptions

InvalidOperationExceptionThrown when neither AzureMessagingServiceBusSettings.ConnectionString nor AzureMessagingServiceBusSettings.FullyQualifiedNamespace is provided.

Remarks

Reads the configuration from "Aspire:Azure:Messaging:ServiceBus" section.

AddKeyedAzureServiceBusClient(IHostApplicationBuilder, string, Action<AzureMessagingServiceBusSettings>, Action<IAzureClientBuilder<ServiceBusClient, ServiceBusClientOptions>>)

extension

Registers ServiceBus.ServiceBusClient as a singleton for given name in the services provided by the builder.

public static class AspireServiceBusExtensions
{
    public static void AddKeyedAzureServiceBusClient(
        this IHostApplicationBuilder builder,
        string name,
        Action<AzureMessagingServiceBusSettings>? configureSettings = null,
        Action<IAzureClientBuilder<ServiceBusClient, ServiceBusClientOptions>>? configureClientBuilder = null)
    {
        // ...
    }
}

AspireServiceBusExtensions.cs#L61-L65