Get started with the Azure App Service integration

🧪 Preview

Azure App Service is a fully managed platform for building, deploying, and scaling web apps. Aspire apps often run locally during development but require scalable, production-ready hosting environments for staging and production. The Aspire integration allows you to provision or reference an existing Azure App Service environment (App Service Plan) and automatically deploy supported web-facing project resources and Dockerfile-backed web containers as Azure App Service websites. Backing services such as databases, caches, and brokers should use managed Azure services instead of App Service websites. Use PublishAsAzureAppServiceWebsite when you need to customize the generated website.

In this introduction, you’ll see how to install and use the Aspire Azure App Service integration in a simple configuration. If you already have this knowledge, see Azure App Service Hosting integration for full reference details.

注意

To follow this guide, you must have created an Aspire solution to work with. To learn how to do that, see Build your first Aspire app.

Set up hosting integration

To begin, install the Aspire Azure App Service Hosting integration in your Aspire AppHost project:

Aspire CLI

Aspire CLI — 添加 Aspire.Hosting.Azure.AppService 包

aspire add azure-appservice

Aspire CLI 是交互式的；按提示选择合适的搜索结果：

Aspire CLI — 输出示例

Select an integration to add:

> azure-appservice (Aspire.Hosting.Azure.AppService)
> Other results listed as selectable options...

注意

如果只有一个结果，会自动选择。仍需确认版本。

apphost.cs (C# file-based app)

C# — AppHost.cs

#:package Aspire.Hosting.Azure.AppService@*

PackageReference (*.csproj)

XML — 添加 Aspire.Hosting.Azure.AppService 包引用

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

Next, add an App Service environment to your AppHost project. The environment represents the hosting infrastructure (App Service Plan) where your apps will run:

C# — AppHost.cs

var builder = DistributedApplication.CreateBuilder(args);

var appServiceEnv = builder.AddAzureAppServiceEnvironment("app-service-env");

builder.AddProject<Projects.WebApi>("api");

builder.Build().Run();

警告

When you call AddAzureAppServiceEnvironment, it implicitly calls AddAzureProvisioning—which adds support for generating Azure resources dynamically during app startup. The app must configure the appropriate subscription and location. For more information, see Local provisioning: Configuration.

The preceding code:

• Creates an Azure App Service environment named app-service-env.
• Adds a project named api to the AppHost.
• Targets the api project to the App Service environment automatically.

During local development (when running with F5 F5 F5 F5 F5 F5 ), the project runs locally. When you publish your app, the project is deployed as an Azure App Service website within the provisioned environment.

You don’t need PublishAsAzureAppServiceWebsite for standard deployment. Use it only when you want to customize the generated website or deployment slot.

See also

Azure App Service Hosting integration Learn about Azure App Service hosting integration, including provisioning, customization, and configuration.