Aspire.Hosting.SqlServer 13.0.0

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Aspire.Hosting.SqlServer --version 13.0.0
                    


                    

                
NuGet\Install-Package Aspire.Hosting.SqlServer -Version 13.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Aspire.Hosting.SqlServer" Version="13.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Aspire.Hosting.SqlServer" Version="13.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Aspire.Hosting.SqlServer" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Aspire.Hosting.SqlServer --version 13.0.0
                    


                    

                
#r "nuget: Aspire.Hosting.SqlServer, 13.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Aspire.Hosting.SqlServer@13.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Aspire.Hosting.SqlServer&version=13.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Aspire.Hosting.SqlServer&version=13.0.0
                    


                            Install as a Cake Tool

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

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (11)

Showing the top 5 NuGet packages that depend on Aspire.Hosting.SqlServer:

Package Downloads
Aspire.Hosting.Azure.Sql

Azure SQL Database resource types for Aspire.
CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects

An Aspire hosting integration capable of deploying SQL Server Database Projects as part of your AppHost.
CommunityToolkit.Aspire.Hosting.SqlServer.Extensions

A .NET Aspire integration for extending sqlserver hosting.
FonsecaFramework.Aspire

Collection of classes and extensions for .NET Aspire
Nall.Aspire.Hosting.DependsOn.SqlServer

Aspire Healthchecks for SqlServer

GitHub repositories (14)

Showing the top 14 popular GitHub repositories that depend on Aspire.Hosting.SqlServer:

Repository Stars
DuendeSoftware/products
The most flexible and standards-compliant OpenID Connect and OAuth 2.x framework for ASP.NET Core
collinbarrett/FilterLists
:shield: The independent, comprehensive directory of filter and host lists for advertisements, trackers, malware, and annoyances.
bitfoundation/bitplatform
Build all of your apps using what you already know and love ❤️
dotnet/aspire-samples
CommunityToolkit/Aspire
A community project with additional components and extensions for .NET Aspire
mehmetozkaya/Design-Microservices-Architecture-with-Patterns-Principles
Design Microservices Architecture with Patterns & Principles. Design Microservices Architecture with Design Patterns, Principles and the Best Practices. How to handle millions of request with designing system for high availability, high scalability, low latency, and resilience to network failures on distributed microservices.
platformplatform/PlatformPlatform
A platform designed for building enterprise-grade, multi-tenant products using Azure, .NET, React, TypeScript, Infrastructure as Code, etc.
dotnet/systemweb-adapters
rstropek/Samples
SSWConsulting/SSW.VerticalSliceArchitecture
An enterprise ready solution template for Vertical Slice Architecture. This template is just one way to apply the Vertical Slice Architecture.
formcms/formcms
Open-source headless CMS built with ASP.NET Core (C#) and React, featuring REST APIs, GraphQL, and a GrapesJS page designer.
alex289/CleanArchitecture
Sample .NET 10 API project including Clean Architecture principles, Onion Architecture, MediatR, and Entity Framework with unit and integration tests using xUnit
Azure-Samples/eShopLite
eShopLite is a set of reference .NET applications implementing an eCommerce site with features like Semantic Search, MCP, Reasoning models and more.
marinasundstrom/YourBrand
Prototype enterprise system for e-commerce and consulting services
Version Downloads Last Updated
13.0.0 11,826 11/11/2025
9.5.2 55,116 10/23/2025
9.5.1 101,805 10/3/2025
9.5.0 52,864 9/25/2025
9.4.2 218,081 9/2/2025
9.4.1 72,508 8/12/2025
9.4.0 112,574 7/29/2025
9.3.2 157,322 6/20/2025
9.3.1 53,597 6/10/2025
9.3.0 101,027 5/19/2025
9.2.1 146,434 4/24/2025 9.2.1 is deprecated because it is no longer maintained.
9.2.0 89,921 4/10/2025 9.2.0 is deprecated because it is no longer maintained.
9.1.0 166,029 2/25/2025 9.1.0 is deprecated because it is no longer maintained.
9.0.0 294,877 11/12/2024 9.0.0 is deprecated because it is no longer maintained.
9.0.0-rc.1.24511.1 5,518 10/15/2024 9.0.0-rc.1.24511.1 is deprecated because it is no longer maintained.
8.2.2 37,326 10/24/2024 8.2.2 is deprecated because it is no longer maintained.
8.2.1 30,973 9/26/2024 8.2.1 is deprecated because it is no longer maintained.
8.2.0 89,675 8/29/2024 8.2.0 is deprecated because it is no longer maintained.
8.1.0 18,889 7/23/2024 8.1.0 is deprecated because it is no longer maintained.
8.0.2 17,937 6/28/2024 8.0.2 is deprecated because it is no longer maintained.
8.0.1 41,070 5/21/2024 8.0.1 is deprecated because it is no longer maintained.
8.0.0 3,544 5/21/2024 8.0.0 is deprecated because it is no longer maintained.
8.0.0-preview.7.24251.11 2,828 5/7/2024 8.0.0-preview.7.24251.11 is deprecated because it is no longer maintained.
8.0.0-preview.6.24214.1 11,596 4/23/2024 8.0.0-preview.6.24214.1 is deprecated because it is no longer maintained.
8.0.0-preview.5.24201.12 4,837 4/9/2024 8.0.0-preview.5.24201.12 is deprecated because it is no longer maintained.