✨ Implement Azure App Service and SQL Server configuration in AppHost (#202)

🔥 Merged without review

This pull request introduces significant improvements to Azure
deployment support and infrastructure configuration, along with some
minor documentation and naming updates. The main changes include adding
Azure-specific packages and resources, refactoring the distributed
application setup to use the Aspire Azure hosting model, and updating
naming conventions for database connection strings and contexts.

**Azure Deployment & Infrastructure Enhancements:**

* Added Azure-specific package references
(`Aspire.Hosting.Azure.ApplicationInsights`,
`Aspire.Hosting.Azure.AppService`, `Aspire.Hosting.Azure.Sql`) to both
`Directory.Packages.props` and `tools/AppHost/AppHost.csproj` to enable
Azure resource provisioning.
[[1]](diffhunk://#diff-5baf5f9e448ad54ab25a091adee0da05d4d228481c9200518fcb1b53a65d4156R6-R8)
[[2]](diffhunk://#diff-cda82b6742843f6c1767221e433612d9fa582a55058b1f5ee6a5563151ba4656R13-R15)
* Refactored the distributed application setup in
`tools/AppHost/AppHost.cs` to use Azure App Service, Azure SQL Server,
Application Insights, and Log Analytics, including configuration for
local and publish modes.
* Implemented a new extension method `WithDropDatabaseCommand` for Azure
SQL databases in `tools/AppHost/Commands/SqlServerCommandExt.cs`,
replacing the previous implementation for local SQL Server databases and
supporting Azure-native operations.
[[1]](diffhunk://#diff-0c530e56451cfeca684c61f595b381fa8f2e1df518c3e435e1a7f03f8720599bR1-R30)
[[2]](diffhunk://#diff-f7dbe3d8251b808d699d5786c9229041916af26d475bf23b34311ee77b385f3eL1-L40)
* Removed the old program setup in `tools/AppHost/Program.cs` in favor
of the new Azure-oriented configuration.

**Naming & Consistency Updates:**

* Standardized database connection string and context names from
`"app-db"` to `"AppDb"` across infrastructure registration and test
configuration files for consistency with Azure resource naming.
(`src/WebApi/Common/Persistence/DependencyInjection.cs`,
`tests/WebApi.IntegrationTests/Common/Infrastructure/Web/WebApiTestFactory.cs`,
`tools/MigrationService/Program.cs`)
[[1]](diffhunk://#diff-87636dbcff301e838a1382effcf2568766855b5a0cd02f8d46e12b3ae66939ceL16-R16)
[[2]](diffhunk://#diff-50cf933f50db73c5b021cfdf9e67b3ed988d49aa11fcc492be8f2a94d2daeff3L31-R31)
[[3]](diffhunk://#diff-b89afcf1c319e2f2497507ca4d2a43d2ac1633c94c1ac7e042ee454fcbe8b1d6L24-R24)

**Documentation Improvements:**

* Updated `README.md` to include detailed Azure deployment instructions
using the Azure Developer CLI (AZD), and improved formatting for notes
and versioning information.
[[1]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L173-L175)
[[2]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L211-R254)

These changes collectively modernize the project's deployment workflow,
making it easier to provision and manage resources in Azure while
ensuring consistency and clarity throughout the codebase and
documentation.

Author: danielmackay

Directory.Packages.props

@@ -3,6 +3,9 @@
     <ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
   </PropertyGroup>
   <ItemGroup>
+    <PackageVersion Include="Aspire.Hosting.Azure.ApplicationInsights" Version="9.5.1" />
+    <PackageVersion Include="Aspire.Hosting.Azure.AppService" Version="9.5.1-preview.1.25502.11" />
+    <PackageVersion Include="Aspire.Hosting.Azure.Sql" Version="9.5.1" />
     <PackageVersion Include="FastEndpoints.Swagger" Version="7.0.1" />
     <PackageVersion Include="Microsoft.AspNetCore.OpenApi" Version="9.0.10" />
     <PackageVersion Include="Microsoft.EntityFrameworkCore.Design" Version="9.0.10">

README.md

@@ -170,9 +170,52 @@ To speed up development there is a `dotnet new` template to create a full Vertic
    dotnet run
    ```
 
-> **NOTE:** The first time you run the solution, it may take a while to download the docker images, create the DB, and seed the data.
+> [!NOTE] The first time you run the solution, it may take a while to download the docker images, create the DB, and seed the data.
+
+4. Open https://localhost:7255/swagger in your browser to see it running ️🏃‍♂️
+
+## Deploying to Azure
+
+The template can be deployed to Azure via
+the [Azure Developer CLI (AZD)](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd?tabs=winget-windows,brew-mac,script-linux&pivots=os-mac).
+This will setup the following:
+
+- Azure App Services: API + MigrationService
+- Azure SQL Server + Database: Data storage
+- Application Insights + Log Analytics: For monitoring and logging
+- Managed Identities: For secure access to Azure resources
+- Azure Container Registry: For storing Docker images
+
+### Steps to Deploy
+
+1. Authenticate with Azure
+
+    ```bash
+    azd auth login
+    ```
+
+2. Initialize AZD for the project
+
+    ```bash
+    azd init
+    ```
+
+3. Update environment variables
+
+    ```bash
+    azd env set ASPNETCORE_ENVIRONMENT Development
+    ```
+
+4. Deploy to Azure
+
+    ```bash
+    azd up
+    ```
+
+> [!NOTE]
+> `azd up` combines `azd provision` and `azd deploy` commands to create the resources and deploy the application. If running this from a CI/CD
+> pipeline, you can use `azd provision` and `azd deploy` separately in the appropriate places.
 
-4. Open https://localhost:7255/scalar/v1 in your browser to see it running ️🏃‍♂️
 
 ## 🎓 Learn More
 
@@ -208,7 +251,7 @@ Template will be published to NuGet.org when changes are made to `VerticalSliceA
 3. `package` GitHub Action will run and publish the new version to NuGet.org
 4. Create a GitHub release to document the changes
 
-> **NOTE:** We are now using CalVer for versioning. The version number should be in the format `YYYY.M.D` (e.g. `2024.2.12`).
+> [!NOTE] We are now using CalVer for versioning. The version number should be in the format `YYYY.M.D` (e.g. `2024.2.12`).
 
 ## 🤝 Contributing
 

src/WebApi/Common/Persistence/DependencyInjection.cs

@@ -13,7 +13,7 @@ public static void AddInfrastructure(this IHostApplicationBuilder builder)
         services.AddScoped<DispatchDomainEventsInterceptor>();
         services.AddSingleton(TimeProvider.System);
 
-        builder.AddSqlServerDbContext<ApplicationDbContext>("app-db",
+        builder.AddSqlServerDbContext<ApplicationDbContext>("AppDb",
             null,
             options =>
             {

tests/WebApi.IntegrationTests/Common/Infrastructure/Web/WebApiTestFactory.cs

@@ -28,6 +28,6 @@ protected override void ConfigureWebHost(IWebHostBuilder builder)
             // x.Services.AddSingleton<ILoggerProvider>(new XUnitLoggerProvider(Output));
         });
 
-        builder.UseSetting("ConnectionStrings:app-db", _dbConnection.ConnectionString);
+        builder.UseSetting("ConnectionStrings:AppDb", _dbConnection.ConnectionString);
     }
 }

tools/AppHost/AppHost.cs

@@ -0,0 +1,74 @@
+using AppHost.Commands;
+using Azure.Provisioning;
+using Azure.Provisioning.AppService;
+using Projects;
+
+var builder = DistributedApplication.CreateBuilder(args);
+
+// Configure the Azure App Service environment
+builder.AddAzureAppServiceEnvironment("plan").ConfigureInfrastructure(infra =>
+{
+    var plan = infra.GetProvisionableResources()
+        .OfType<AppServicePlan>()
+        .Single();
+
+    plan.Sku = new AppServiceSkuDescription
+    {
+        Name = "B1", // Basic tier, 1 core
+    };
+});
+
+var sqlServer = builder
+    .AddAzureSqlServer("sql")
+    .RunAsContainer(container =>
+    {
+        // Configure SQL Server to run locally as a container
+        container.WithLifetime(ContainerLifetime.Persistent);
+
+        // Use SQL Server 2022 as the default of SQL Server 2025 doesn't work on Linux/MacOS
+        container.WithImage("mssql/server:2022-latest");
+
+        // If desired, set SQL Server Port to a constant value
+        //container.WithHostPort(1800);
+    });
+
+var db = sqlServer
+    .AddDatabase("AppDb", "app-db")
+    .WithDropDatabaseCommand();
+
+var migrationService = builder.AddProject<MigrationService>("migrations")
+    .PublishAsAzureAppServiceWebsite((_, site) =>
+    {
+        const string envNetCoreEnvironment = "ASPNETCORE_ENVIRONMENT";
+
+        // Needed for hosted service to run
+        site.SiteConfig.IsAlwaysOn = true;
+
+        // Dynamically set environment, so we can enable seeding of data (only happens in 'development')
+        var environment = Environment.GetEnvironmentVariable(envNetCoreEnvironment);
+        if (string.IsNullOrWhiteSpace(environment))
+            return;
+
+        var envSetting = new AppServiceNameValuePair { Name = envNetCoreEnvironment, Value = environment };
+        site.SiteConfig.AppSettings.Add(new BicepValue<AppServiceNameValuePair>(envSetting));
+    })
+    .WithReference(db)
+    .WaitFor(sqlServer);
+
+var api = builder
+    .AddProject<WebApi>("api")
+    .WithExternalHttpEndpoints()
+    .WithReference(db)
+    .WaitForCompletion(migrationService);
+
+// Configure Application Insights and Log Analytics only if in publish mode
+// When running locally, use Aspire Dashboard instead
+if (builder.ExecutionContext.IsPublishMode)
+{
+    var logAnalytics = builder.AddAzureLogAnalyticsWorkspace("log-analytics");
+    var insights = builder.AddAzureApplicationInsights("insights", logAnalytics);
+    api.WithReference(insights);
+    migrationService.WithReference(insights);
+}
+
+builder.Build().Run();

tools/AppHost/AppHost.csproj

@@ -10,6 +10,9 @@
 
   <ItemGroup>
     <PackageReference Include="Aspire.Hosting.AppHost" />
+    <PackageReference Include="Aspire.Hosting.Azure.ApplicationInsights" />
+    <PackageReference Include="Aspire.Hosting.Azure.AppService" />
+    <PackageReference Include="Aspire.Hosting.Azure.Sql" />
     <PackageReference Include="Aspire.Hosting.SqlServer" />
     <PackageReference Include="Aspire.Microsoft.EntityFrameworkCore.SqlServer" />
   </ItemGroup>

tools/AppHost/Commands/SqlServerCommandExt.cs

@@ -0,0 +1,30 @@
+using Aspire.Hosting.Azure;
+using Microsoft.EntityFrameworkCore;
+
+namespace AppHost.Commands;
+
+public static class SqlServerDatabaseCommandExt
+{
+    public static IResourceBuilder<AzureSqlDatabaseResource> WithDropDatabaseCommand(
+        this IResourceBuilder<AzureSqlDatabaseResource> builder)
+    {
+        builder.WithCommand(
+            "drop-database",
+            "Drop Database",
+            async _ =>
+            {
+                var connectionString = await builder.Resource.ConnectionStringExpression.GetValueAsync(CancellationToken.None);
+                ArgumentException.ThrowIfNullOrWhiteSpace(connectionString);
+
+                var optionsBuilder = new DbContextOptionsBuilder<DbContext>();
+                optionsBuilder.UseSqlServer(connectionString);
+                var db = new DbContext(optionsBuilder.Options);
+                await db.Database.EnsureDeletedAsync();
+
+                return CommandResults.Success();
+            },
+            null); // Intentionally using 'null' for the command state resolver as this command does not require health status checks. Downstream code is expected to handle 'null' appropriately.
+
+        return builder;
+    }
+}

tools/AppHost/Extensions/SqlServerCommandExt.cs

@@ -21,7 +21,7 @@
 builder.Services.AddScoped<ICurrentUserService, MigrationUserService>();
 builder.Services.AddSingleton(TimeProvider.System);
 
-builder.AddSqlServerDbContext<ApplicationDbContext>("app-db",
+builder.AddSqlServerDbContext<ApplicationDbContext>("AppDb",
     null,
     options =>
     {