Get started with the Azure App Configuration integrations

Azure App Configuration provides a service to centrally manage application settings and feature flags. Modern programs, especially programs running in a cloud, generally have many components that are distributed in nature. Spreading configuration settings across these components can lead to hard-to-troubleshoot errors during an application deployment. The Aspire Azure App Configuration integration enables you to connect to existing App Configuration instances or create new instances all from your AppHost.

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

Nota

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 Configuration Hosting integration in your Aspire AppHost project. This integration allows you to create and manage Azure App Configuration resources from your Aspire hosting projects:

Aspire CLI

Aspire CLI — Adicionar pacote Aspire.Hosting.Azure.AppConfiguration

aspire add azure-appconfiguration

A Aspire CLI é interativa; escolha o resultado adequado quando solicitado:

Aspire CLI — Exemplo de saída

Select an integration to add:

> azure-appconfiguration (Aspire.Hosting.Azure.AppConfiguration)
> Other results listed as selectable options...

Nota

Se houver apenas um resultado ele será escolhido automaticamente. Confirme a versão mesmo assim.

apphost.cs (C# file-based app)

C# — AppHost.cs

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

PackageReference (*.csproj)

XML — Adicionar referência de pacote Aspire.Hosting.Azure.AppConfiguration

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

Next, in the AppHost project, create an Azure App Configuration resource and pass it to the consuming client projects:

C# — AppHost.cs

var builder = DistributedApplication.CreateBuilder(args);

var appConfig = builder.AddAzureAppConfiguration("config");

builder.AddProject<Projects.WebApplication>("web")
    .WithReference(appConfig);

// After adding all resources, run the app...

builder.Build().Run();

Cuidado

When you call AddAzureAppConfiguration, 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.

Set up client integration

To get started with the Aspire Azure App Configuration client integration, install the 📦 Aspire.Microsoft.Extensions.Configuration.AzureAppConfiguration NuGet package in the client-consuming project:

.NET CLI

.NET CLI — Add Aspire.Microsoft.Extensions.Configuration.AzureAppConfiguration package

dotnet add package Aspire.Microsoft.Extensions.Configuration.AzureAppConfiguration

Program.cs (C# file-based app)

Program.cs

#:package Aspire.Microsoft.Extensions.Configuration.AzureAppConfiguration@*

PackageReference (*.csproj)

XML — Add Aspire.Microsoft.Extensions.Configuration.AzureAppConfiguration package reference

<PackageReference Include="Aspire.Microsoft.Extensions.Configuration.AzureAppConfiguration" Version="*" />

In the Program.cs file of your client-consuming project, call the AddAzureAppConfiguration extension method to register the required services:

C# — Program.cs

builder.AddAzureAppConfiguration(connectionName: "config");

Dica

The connectionName parameter must match the name used when adding the App Configuration resource in the AppHost project.

You can then retrieve the IConfiguration instance using dependency injection:

C# — ExampleService.cs

public class ExampleService(IConfiguration configuration)
{
    private readonly string _someValue = configuration["SomeKey"];
}

See also

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

Azure App Configuration Client integration Learn about Azure App Configuration client integration, including feature flags, configuration, and telemetry.