Aspire.Hosting.SqlServer 13.0.0

Aspire.Hosting.SqlServer library

Provides extension methods and resource definitions for an Aspire AppHost to configure a SQL Server database resource.

Getting started

Install the package

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

dotnet add package Aspire.Hosting.SqlServer

Usage example

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

var db = builder.AddSqlServer("sql").AddDatabase("db")

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

Connection Properties

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

SQL Server server

The SQL Server server resource exposes the following connection properties:

Property Name Description
Host The hostname or IP address of the SQL Server
Port The port number the SQL Server is listening on
Username The username for authentication
Password The password for authentication
Uri The connection URI in mssql:// format, with the format mssql://{Username}:{Password}@{Host}:{Port}
JdbcConnectionString JDBC-format connection string, with the format jdbc:sqlserver://{Host}:{Port};trustServerCertificate=true. User and password credentials are provided as separate Username and Password properties.

SQL Server database

The SQL Server database resource inherits all properties from its parent SqlServerServerResource and adds:

Property Name Description
Uri The connection URI in mssql:// format, with the format mssql://{Username}:{Password}@{Host}:{Port}/{DatabaseName}
JdbcConnectionString JDBC connection string with database name, with the format jdbc:sqlserver://{Host}:{Port};trustServerCertificate=true;databaseName={DatabaseName}. User and password credentials are provided as separate Username and Password properties.
DatabaseName The name of the database

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

https://learn.microsoft.com/dotnet/aspire/database/sql-server-component https://learn.microsoft.com/dotnet/aspire/database/sql-server-entity-framework-component

Feedback & contributing

https://github.com/dotnet/aspire

No packages depend on Aspire.Hosting.SqlServer.

.NET 8.0

.NET 10.0

.NET 9.0

Version Downloads Last updated
13.0.1 0 11/26/2025
13.0.0 7 11/12/2025
9.5.2 6 10/29/2025
9.5.1 9 10/07/2025
9.5.0 9 09/27/2025
9.4.2 16 09/04/2025
9.4.1 18 08/14/2025
9.4.0 19 07/31/2025
9.3.2 25 06/26/2025
9.3.1 22 06/21/2025
9.3.0 28 06/04/2025
9.2.1 26 06/04/2025
9.2.0 24 06/04/2025
9.1.0 28 06/04/2025
9.0.0 24 06/04/2025
9.0.0-rc.1.24511.1 24 06/04/2025
8.2.2 24 06/04/2025
8.2.1 24 06/04/2025
8.2.0 26 06/04/2025
8.1.0 24 06/04/2025
8.0.2 25 06/04/2025
8.0.1 28 06/04/2025
8.0.0 27 06/04/2025
8.0.0-preview.7.24251.11 23 06/04/2025
8.0.0-preview.6.24214.1 22 06/04/2025
8.0.0-preview.5.24201.12 24 06/04/2025