.NET Aspire SDK
The .NET Aspire SDK is intended for *.AppHost projects, which serve as the .NET Aspire orchestrator. These projects as designated using the <IsAspireHost>true</IsAspireHost>
property, as well as specifying the Aspire.AppHost.Sdk
in the project file. The SDK provides a set of features that simplify the development of .NET Aspire apps.
The 📦 Aspire.AppHost.Sdk is an additive MSBuild project SDK for building .NET Aspire apps. The Aspire.AppHost.Sdk
is defined with a top-level Project/Sdk
:
<Project Sdk="Microsoft.NET.Sdk">
<Sdk Name="Aspire.AppHost.Sdk" Version="9.0.0" />
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net9.0</TargetFramework>
<IsAspireHost>true</IsAspireHost>
<!-- Omitted for brevity -->
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Aspire.Hosting.AppHost" Version="9.0.0" />
</ItemGroup>
<!-- Omitted for brevity -->
</Project>
The preceding example project defines the top-level SDK as Microsoft.NET.Sdk
and the Aspire.AppHost.Sdk
as an additive SDK. The IsAspireHost
property is set to true
to indicate that this project is an .NET Aspire app host. The project also references the Aspire.Hosting.AppHost
package which brings in a number of Aspire-related dependencies.
The .NET Aspire SDK provides several key features.
The ProjectReference
in the .NET Aspire app host project aren't treated as standard project references. This feature enables the app host to execute these projects instead as part of its orchestration. Each project reference triggers a generator to create a class
that represents the project as an IProjectMetadata. This metadata is used to populate the named projects in the generated Projects
namespace. When you call the Aspire.Hosting.ProjectResourceBuilderExtensions.AddProject API, the Projects
namespace is used to reference the project—passing the generated class as a generic-type parameter.
Suggerimento
If you need to reference a project within the app host and you want to avoid this functionality, set the IsAspireProjectResource
attribute on the ProjectReference
element to false
, as shown in the following example:
<ProjectReference Include="..\MyProject\MyProject.csproj" IsAspireProjectResource="false" />
The .NET Aspire SDK dynamically adds references to the .NET Aspire dashboard and other app host dependencies, such as, the developer control plane (DCP) packages. These dependencies are specific to the platform that the app host is built on.
When the app host project runs, the orchestrator relies on these dependencies to provide the necessary functionality to the app host. For more information, see .NET Aspire orchestration overview.
Feedback su .NET Aspire
.NET Aspire è un progetto di open source. Selezionare un collegamento per fornire feedback: