Use configuration providers

The Aspire RabbitMQ component supports Microsoft.Extensions.Configuration. It loads the RabbitMQClientSettings from configuration by using the Aspire:RabbitMQ:Client key. Example appsettings.json that configures some of the options:

{
  "Aspire": {
    "RabbitMQ": {
      "Client": {
        "DisableHealthChecks": true
      }
    }
  }
}

Use inline delegates

Also you can pass the Action<RabbitMQClientSettings> configureSettings delegate to set up some or all the options inline, for example to disable health checks from code:

builder.AddRabbitMQClient("messaging", settings => settings.DisableHealthChecks = true);

You can also setup the ConnectionFactory using the Action<ConnectionFactory> configureConnectionFactory delegate parameter of the AddRabbitMQClient method. For example to set the client provided name for connections:

builder.AddRabbitMQClient("messaging", configureConnectionFactory: factory => factory.ClientProvidedName = "MyApp");

AppHost extensions

In your AppHost project, install the Aspire.Hosting.RabbitMQ library with NuGet:

dotnet add package Aspire.Hosting.RabbitMQ

Then, in the AppHost.cs file of AppHost, register a RabbitMQ server and consume the connection using the following methods:

var messaging = builder.AddRabbitMQ("messaging");

var myService = builder.AddProject<Projects.MyService>()
                       .WithReference(messaging);

The WithReference method configures a connection in the MyService project named messaging. In the Program.cs file of MyService, the RabbitMQ connection can be consumed using:

builder.AddRabbitMQClient("messaging");

Additional documentation

• https://rabbitmq.github.io/rabbitmq-dotnet-client/
• https://github.com/dotnet/aspire/tree/main/src/Components/README.md

Feedback & contributing

https://github.com/dotnet/aspire