# AspireServiceBusExtensions Methods

- Package: [Aspire.Azure.Messaging.ServiceBus](/reference/api/csharp/aspire.azure.messaging.servicebus.md)
- Type: [AspireServiceBusExtensions](/reference/api/csharp/aspire.azure.messaging.servicebus/aspireservicebusextensions.md)
- Kind: `Methods`
- Members: `2`

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>>)

- Name: `AddAzureServiceBusClient(IHostApplicationBuilder, string, Action<AzureMessagingServiceBusSettings>, Action<IAzureClientBuilder<ServiceBusClient, ServiceBusClientOptions>>)`
- Modifiers: `extension`
- Source: [GitHub](https://github.com/microsoft/aspire/blob/5bd693ae1897dee5e2ce71c2cc08879c1c7eff51/src/Components/Aspire.Azure.Messaging.ServiceBus/AspireServiceBusExtensions.cs#L40-L44)

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

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

## Parameters

- `builder` (`IHostApplicationBuilder`)
  The `Hosting.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<AzureMessagingServiceBusSettings>`) `optional`
  An optional method that can be used for customizing the [AzureMessagingServiceBusSettings](/reference/api/csharp/aspire.azure.messaging.servicebus/azuremessagingservicebussettings.md). It's invoked after the settings are read from the configuration.
- `configureClientBuilder` (`Action<IAzureClientBuilder<ServiceBusClient, ServiceBusClientOptions>>`) `optional`
  An optional method that can be used for customizing the `Extensions.IAzureClientBuilder`2`.

## Exceptions

- `InvalidOperationException` -- Thrown when neither [AzureMessagingServiceBusSettings.ConnectionString](/reference/api/csharp/aspire.azure.messaging.servicebus/azuremessagingservicebussettings/properties.md#connectionstring) nor [AzureMessagingServiceBusSettings.FullyQualifiedNamespace](/reference/api/csharp/aspire.azure.messaging.servicebus/azuremessagingservicebussettings/properties.md#fullyqualifiednamespace) is provided.

## Remarks

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

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

- Name: `AddKeyedAzureServiceBusClient(IHostApplicationBuilder, string, Action<AzureMessagingServiceBusSettings>, Action<IAzureClientBuilder<ServiceBusClient, ServiceBusClientOptions>>)`
- Modifiers: `extension`
- Source: [GitHub](https://github.com/microsoft/aspire/blob/5bd693ae1897dee5e2ce71c2cc08879c1c7eff51/src/Components/Aspire.Azure.Messaging.ServiceBus/AspireServiceBusExtensions.cs#L61-L65)

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

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

## Parameters

- `builder` (`IHostApplicationBuilder`)
  The `Hosting.IHostApplicationBuilder` to read config from and add services to.
- `name` (`string`)
  The name of the component, which is used as the `ServiceDescriptor.ServiceKey` of the service and also to retrieve the connection string from the ConnectionStrings configuration section.
- `configureSettings` (`Action<AzureMessagingServiceBusSettings>`) `optional`
  An optional method that can be used for customizing the [AzureMessagingServiceBusSettings](/reference/api/csharp/aspire.azure.messaging.servicebus/azuremessagingservicebussettings.md). It's invoked after the settings are read from the configuration.
- `configureClientBuilder` (`Action<IAzureClientBuilder<ServiceBusClient, ServiceBusClientOptions>>`) `optional`
  An optional method that can be used for customizing the `Extensions.IAzureClientBuilder`2`.

## Exceptions

- `InvalidOperationException` -- Thrown when neither [AzureMessagingServiceBusSettings.ConnectionString](/reference/api/csharp/aspire.azure.messaging.servicebus/azuremessagingservicebussettings/properties.md#connectionstring) nor [AzureMessagingServiceBusSettings.FullyQualifiedNamespace](/reference/api/csharp/aspire.azure.messaging.servicebus/azuremessagingservicebussettings/properties.md#fullyqualifiednamespace) is provided.

## Remarks

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