Add Azure App Configuration client integration #8459

zhiyuanliang-ms · 2025-04-01T06:19:55Z

Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes #787

Checklist

Is this feature complete?
- [x ] Yes. Ready to ship.
- No. Follow-up changes expected.
Are you including unit tests for the changes and scenario tests if relevant?
- [ x] Yes
- No
Did you add public API?
- [ x] Yes
  - If yes, did you have an API Review for it?
    - [ x] Yes
    - No
  - Did you add <remarks /> and <code /> elements on your triple slash comments?
    - [ x] Yes
    - No
- No
Does the change make any security assumptions or guarantees?
- Yes
  - If yes, have you done a threat model and had a security review?
    - Yes
    - No
- [ x] No
Does the change require an update in our Aspire docs?
- [ x] Yes
  - Is this introducing a breaking change?
    - Yes
      - Link to aspire-docs issue (please use this breaking-change template):
    - [x ] No
      - Link to aspire-docs issue (please use this doc-idea template):
- No

Copilot

Pull Request Overview

This pull request adds Azure App Configuration support to the Aspire framework by introducing a new component for managing connection settings, health checks, client registrations, and related extension methods.

Adds configuration settings, health check, and component classes for Azure App Configuration.
Provides extension methods for both keyed and unkeyed client registration.
Updates playground projects to demonstrate usage.

Reviewed Changes

Copilot reviewed 17 out of 29 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
AzureDataAppConfigurationSettings.cs	Introduces settings class implementing connection string parsing.
AzureAppConfigurationHealthCheck.cs	Implements a health check for the ConfigurationClient.
AssemblyInfo.cs	Registers configuration schemas and logging categories.
AspireAppConfigurationExtensions.cs	Provides extension methods to register and configure the Azure App Configuration client.
AppConfigurationComponent.cs	Implements the Azure component for client creation, health checks, and configuration binding.
Playground/WorkerService/*.cs	Adds sample applications to demonstrate usage of the new component.

Files not reviewed (12)

Aspire.sln: Language not supported
Directory.Packages.props: Language not supported
playground/AzureAppConfiguration/AppHost/AppHost.csproj: Language not supported
playground/AzureAppConfiguration/AppHost/Properties/launchSettings.json: Language not supported
playground/AzureAppConfiguration/AppHost/appsettings.Development.json: Language not supported
playground/AzureAppConfiguration/AppHost/appsettings.json: Language not supported
playground/AzureAppConfiguration/WorkerService/Properties/launchSettings.json: Language not supported
playground/AzureAppConfiguration/WorkerService/WorkerService.csproj: Language not supported
playground/AzureAppConfiguration/WorkerService/appsettings.Development.json: Language not supported
playground/AzureAppConfiguration/WorkerService/appsettings.json: Language not supported
playground/Directory.Packages.props: Language not supported
src/Components/Aspire.Azure.Data.AppConfiguration/Aspire.Azure.Data.AppConfiguration.csproj: Language not supported

src/Components/Aspire.Azure.Data.AppConfiguration/AzureAppConfigurationHealthCheck.cs

playground/AzureAppConfiguration/WorkerService/Program.cs

src/Components/Aspire.Azure.Data.AppConfiguration/README.md

src/Components/Common/AzureComponent.cs

zhiyuanliang-ms · 2025-04-01T07:22:24Z

@dotnet-policy-service agree company="Microsoft"

src/Components/Aspire.Azure.Data.AppConfiguration/AzureAppConfigurationHealthCheck.cs

zhenlan · 2025-04-03T18:25:19Z

src/Components/Aspire.Azure.Data.AppConfiguration/README.md

+
+See the [Azure.Data.AppConfiguration documentation](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/appconfiguration/Azure.Data.AppConfiguration/README.md) for examples on using the `ConfigurationClient`.
+
+## Configuration


Why do all examples use the SDK? Mixing the provider and SDK is confusing.

I followed the key vault component readme

playground/Directory.Packages.props

davidfowl · 2025-04-04T04:47:03Z

playground/AzureAppConfiguration/WorkerService/Program.cs

+builder.Configuration.AddAzureAppConfiguration(
+    "appconfig",
+    configureOptions: options => {
+        options.UseFeatureFlags();
+        options.ConfigureRefresh(refresh =>
+        {
+            refresh.RegisterAll();
+        });
+        builder.Services.AddSingleton(options.GetRefresher());
+    });


Is this the minimal configuration. Why are there 3 layers of nested lambdas?

This is not the minimal configuration. The minimal configuration is just:

builder.Configuration.AddAzureAppConfiguration("appconfig");

But to use advanced feature of App Config configuration provider (e.g. feature flag, dynamic refresh), you need to configure on AzureAppConfigurationOptions

BTW, I followed the existing pattern of AddAzureKeyVaultSecrets.

So this sample is just trying to show both calls but we dont expect people to do this right?

So this sample is just trying to show both calls but we dont expect people to do this right?

If people want to use advanced features of Azure App Configuration. They should write code just like what I did in the example. We do expect people to do this if they want to use feature flag and dynamic refresh. But for simple configuration scenario, builder.Configuration.AddAzureAppConfiguration("appconfig"); is enough.

BTW, I am working on another PR: zhiyuanliang-ms#5

We decided to not implement anything for ConfigurationClient from .net azure sdk. This PR should be deprecated.

The new API will be an extension method on IHostApplicationBuilder.
builder.AddAzureAppConfiguration("appconfig");

zhiyuanliang-ms · 2025-04-24T06:21:05Z

Move to #8945

zhiyuanliang-ms added 10 commits March 17, 2025 17:50

client integration for Azure App Config

7f3fc99

update

aaac4cc

add readme

14bbfc0

update configuration schema

d347f91

add conformance test

803de74

fix project path

59b1dc2

update

0b0baf9

fix testcases

24a3b56

finished unit test

b98b94d

use empty token credential in the testcase

d628c7a

Copilot AI review requested due to automatic review settings April 1, 2025 06:19

zhiyuanliang-ms requested review from radical, eerhardt and sebastienros as code owners April 1, 2025 06:19

github-actions bot added the area-integrations Issues pertaining to Aspire Integrations packages label Apr 1, 2025

Copilot AI reviewed Apr 1, 2025

View reviewed changes

src/Components/Aspire.Azure.Data.AppConfiguration/AzureAppConfigurationHealthCheck.cs Outdated Show resolved Hide resolved

dotnet-policy-service bot added the community-contribution Indicates that the PR has been added by a community member label Apr 1, 2025

zhiyuanliang-ms added 2 commits April 1, 2025 14:28

merge main

21a6f75

update example

316eb9d

davidfowl changed the title ~~Add Azure App Configuration component~~ Add Azure App Configuration client integration Apr 1, 2025

davidfowl reviewed Apr 1, 2025

View reviewed changes

playground/AzureAppConfiguration/WorkerService/Program.cs Outdated Show resolved Hide resolved

davidfowl reviewed Apr 1, 2025

View reviewed changes

src/Components/Aspire.Azure.Data.AppConfiguration/README.md Outdated Show resolved Hide resolved

davidfowl reviewed Apr 1, 2025

View reviewed changes

src/Components/Common/AzureComponent.cs Outdated Show resolved Hide resolved

zhiyuanliang-ms force-pushed the zhiyuanliang/app-config-component branch from a792085 to 316eb9d Compare April 1, 2025 07:16

zhiyuanliang-ms added 2 commits April 1, 2025 15:18

remove dead code

2cf4ec8

fix typo in readme

9ff3572

zhiyuanliang-ms mentioned this pull request Apr 1, 2025

Client integration for Azure App Config zhiyuanliang-ms/aspire#3

Closed

18 tasks

update test project

f5a5732

zhiyuanliang-ms commented Apr 1, 2025

View reviewed changes

src/Components/Aspire.Azure.Data.AppConfiguration/AzureAppConfigurationHealthCheck.cs Outdated Show resolved Hide resolved

zhiyuanliang-ms commented Apr 1, 2025

View reviewed changes

src/Components/Aspire.Azure.Data.AppConfiguration/AzureAppConfigurationHealthCheck.cs Outdated Show resolved Hide resolved

zhiyuanliang-ms added 2 commits April 2, 2025 11:07

improve health check

3a893f7

merge main

2a7a62e

zhenlan reviewed Apr 3, 2025

View reviewed changes

eerhardt reviewed Apr 3, 2025

View reviewed changes

playground/Directory.Packages.props Outdated Show resolved Hide resolved

davidfowl reviewed Apr 4, 2025

View reviewed changes

zhiyuanliang-ms added 3 commits April 5, 2025 16:28

update Directory.Packages

2e4382f

add configuration provider logging category

f808da4

update configurationschema

b15edf8

zhiyuanliang-ms closed this Apr 24, 2025

github-actions bot locked and limited conversation to collaborators May 24, 2025

zhiyuanliang-ms deleted the zhiyuanliang/app-config-component branch June 2, 2025 14:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add Azure App Configuration client integration #8459

Add Azure App Configuration client integration #8459

Uh oh!

zhiyuanliang-ms commented Apr 1, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

zhiyuanliang-ms commented Apr 1, 2025

Uh oh!

Uh oh!

Uh oh!

zhenlan Apr 3, 2025

Uh oh!

zhiyuanliang-ms Apr 5, 2025

Uh oh!

Uh oh!

davidfowl Apr 4, 2025

Uh oh!

zhiyuanliang-ms Apr 5, 2025

Uh oh!

davidfowl Apr 15, 2025

Uh oh!

zhiyuanliang-ms Apr 16, 2025 •

edited

Loading

Uh oh!

zhiyuanliang-ms commented Apr 24, 2025

Uh oh!

Uh oh!


		See the [Azure.Data.AppConfiguration documentation](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/appconfiguration/Azure.Data.AppConfiguration/README.md) for examples on using the `ConfigurationClient`.

		## Configuration

Add Azure App Configuration client integration #8459

Add Azure App Configuration client integration #8459

Uh oh!

Conversation

zhiyuanliang-ms commented Apr 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

zhiyuanliang-ms commented Apr 1, 2025

Uh oh!

Uh oh!

Uh oh!

zhenlan Apr 3, 2025

Choose a reason for hiding this comment

Uh oh!

zhiyuanliang-ms Apr 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

davidfowl Apr 4, 2025

Choose a reason for hiding this comment

Uh oh!

zhiyuanliang-ms Apr 5, 2025

Choose a reason for hiding this comment

Uh oh!

davidfowl Apr 15, 2025

Choose a reason for hiding this comment

Uh oh!

zhiyuanliang-ms Apr 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zhiyuanliang-ms commented Apr 24, 2025

Uh oh!

Uh oh!

zhiyuanliang-ms commented Apr 1, 2025 •

edited

Loading

zhiyuanliang-ms Apr 16, 2025 •

edited

Loading