Aspire.Hosting.Azure.AppService 13.0.0-preview.1.25560.3

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
This is a prerelease version of Aspire.Hosting.Azure.AppService. 
dotnet add package Aspire.Hosting.Azure.AppService --version 13.0.0-preview.1.25560.3
                    


                    

                
NuGet\Install-Package Aspire.Hosting.Azure.AppService -Version 13.0.0-preview.1.25560.3
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.Azure.AppService" Version="13.0.0-preview.1.25560.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Aspire.Hosting.Azure.AppService" Version="13.0.0-preview.1.25560.3" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Aspire.Hosting.Azure.AppService" />
                    


                            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.Azure.AppService --version 13.0.0-preview.1.25560.3
                    


                    

                
#r "nuget: Aspire.Hosting.Azure.AppService, 13.0.0-preview.1.25560.3"
#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.Azure.AppService@13.0.0-preview.1.25560.3
#: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.Azure.AppService&version=13.0.0-preview.1.25560.3&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Aspire.Hosting.Azure.AppService&version=13.0.0-preview.1.25560.3&prerelease
                    


                            Install as a Cake Tool

Aspire.Hosting.Azure.AppService library

Provides extension methods and resource definitions for an Aspire AppHost to configure Azure App Service for the compute resources (like project).

Getting started

Prerequisites

  • Azure subscription (requires Owner access to the target subscription for role assignments)

Install the package

In your AppHost project, install the Aspire Azure App Service Hosting library with NuGet:

dotnet add package Aspire.Hosting.Azure.AppService

Usage example

Then, in the AppHost.cs file of AppHost, add an Azure App Service Environment and publish your project as an Azure App Service Web App:

var builder = DistributedApplication.CreateBuilder(args);

var appServiceEnvironment = builder.AddAzureAppServiceEnvironment("env");

builder.AddProject<Projects.MyWebApp>("webapp")
    .WithExternalHttpEndpoints()
    .PublishAsAzureAppServiceWebsite((infrastructure, website) =>
    {
        // Customize the App Service health check path and appsettings
        website.SiteConfig.HealthCheckPath = "/health";
        website.SiteConfig.AppSettings.Add(new AppServiceNameValuePair()
        {
            Name = "Environment",
            Value = "Production"
        });
    });

Azure App Service constraints

When deploying to Azure App Service, the following constraints apply:

  • External endpoints only: App Service only supports external endpoints. All endpoints must be configured using WithExternalHttpEndpoints().
  • HTTP/HTTPS only: Only HTTP and HTTPS endpoints are supported. Other protocols are not supported.
  • Single endpoint: App Service supports only a single target port. Resources with multiple external endpoints with different target ports are not supported. The default target port is 8000, which can be overridden using the WithHttpEndpoint extension method.

Publishing compute resources to Azure App Service

The PublishAsAzureAppServiceWebsite extension method is used to configure a compute resource (such as a project) to be published as an Azure App Service Web App when deploying to Azure. This method allows you to customize the App Service Web App configuration using the Azure Provisioning SDK.

builder.AddProject<Projects.MyApi>("api")
    .WithHttpEndpoint(targetPort: 8080)
    .WithExternalHttpEndpoints()
    .WithHealthProbe(ProbeType.Liveness, "/health")
    .WithArgs("--environment", "Production")
    .PublishAsAzureAppServiceWebsite((infrastructure, website) =>
    {
        // Customize the App Service Web App appsettings
        website.SiteConfig.IsWebSocketsEnabled = true;
        website.SiteConfig.MinTlsVersion = SupportedTlsVersions.Tls1_2;
    });

Adding an Azure App Service Environment

The Azure App Service Environment resource creates the underlying infrastructure needed to host your applications, including:

  • An Azure App Service Plan (default SKU: P0v3)
  • An Azure Container Registry for storing container images
  • A managed identity for accessing the container registry
  • Optionally, the Aspire Dashboard as an Azure App Service Web App
  • Optionally, Application Insights for monitoring and telemetry
var appServiceEnvironment = builder.AddAzureAppServiceEnvironment("env");

By default, the Aspire Dashboard is included in the App Service Environment. To disable the dashboard, use the WithDashboard extension method:

var appServiceEnvironment = builder.AddAzureAppServiceEnvironment("env")
    .WithDashboard(enable: false);

Enabling Application Insights

Application Insights can be enabled for the App Service Environment using the WithAzureApplicationInsights extension method. A different location can be specified for Application Insights using the optional location parameter:

var appServiceEnvironment = builder.AddAzureAppServiceEnvironment("env")
    .WithAzureApplicationInsights();

Customizing the App Service Plan

The App Service Plan can be customized using the ConfigureInfrastructure extension method.

The default SKU for the App Service Plan is P0V3 and can be changed using this extension method:

var appServiceEnvironment = builder.AddAzureAppServiceEnvironment("env")
    .ConfigureInfrastructure((infra) =>
    {
        var plan = infra.GetProvisionableResources().OfType<AppServicePlan>().Single();
        plan.Sku = new AppServiceSkuDescription
        {
            Name = "P2V3",
            Tier = "Premium"
        };
    });

Additional documentation

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 was computed.  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 was computed.  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

This package is not used by any NuGet packages.

GitHub repositories (2)

Showing the top 2 popular GitHub repositories that depend on Aspire.Hosting.Azure.AppService:

Repository Stars
SSWConsulting/SSW.CleanArchitecture
SSW Clean Architecture Template
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.