Aspire.Hosting.Nats 13.0.0

Aspire.Hosting.NATS library

Provides extension methods and resource definitions for an Aspire AppHost to configure a NATS resource.

Getting started

Install the package

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

dotnet add package Aspire.Hosting.Nats

Usage example

Then, in the AppHost.cs file of AppHost, add a NATS resource and consume the connection using the following methods:

var nats = builder.AddNats("nats");

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

Connection Properties

When you reference a NATS resource using WithReference, the following connection properties are made available to the consuming project:

NATS server

The NATS server resource exposes the following connection properties:

Property Name Description
Host The hostname or IP address of the NATS server
Port The port number the NATS server is listening on
Username The username for authentication
Password The password for authentication
Uri The connection URI with the format nats://{Username}:{Password}@{Host}:{Port}

Aspire exposes each property as an environment variable named [RESOURCE]_[PROPERTY]. For instance, the Uri property of a resource called db1 becomes DB1_URI.

Additional documentation

Feedback & contributing

https://github.com/dotnet/aspire

No packages depend on Aspire.Hosting.Nats.

Version Downloads Last updated
13.0.1 0 11/26/2025
13.0.0 6 11/17/2025
9.5.2 6 10/26/2025
9.5.1 7 10/05/2025
9.5.0 7 09/28/2025
9.4.2 11 09/04/2025
9.4.1 11 08/15/2025
9.4.0 18 08/01/2025
9.3.1 17 06/12/2025
9.3.0 19 06/04/2025
9.2.1 16 06/04/2025
9.2.0 18 06/05/2025
9.1.0 16 06/05/2025
9.0.0 17 06/05/2025
9.0.0-rc.1.24511.1 20 06/05/2025
8.2.2 17 06/05/2025
8.2.1 15 06/05/2025
8.2.0 16 06/05/2025
8.1.0 16 06/05/2025
8.0.2 16 06/04/2025
8.0.1 16 06/05/2025
8.0.0 15 06/05/2025
8.0.0-preview.7.24251.11 16 06/05/2025
8.0.0-preview.6.24214.1 17 06/05/2025
8.0.0-preview.5.24201.12 17 06/05/2025