Add support for Microsoft.Extensions.Configuration #53527

m-nash · 2025-10-28T00:57:53Z

Initial prototype to support Microsoft.Extensions.Configuration and Microsoft.Extensions.DependencyInjection

We don't intend to support both ClientConnection and ClientSettings we are exploring both and will choose one.

The example below shows using ApiKey credential for public openai client and azure cli credential for azure openai client. If you are using ApiKey credential for both the WithAzureCredential or GetAzureConnection is not necessary the code for public openai works for both.

OpenAIClient appsettings.json

  "OpenAIClient": {
    "Model": "gpt-5",
    "Credential": {
      "CredentialSource": "ApiKey"
    }
  }

AzureOpenAIClient-Cli appsettings.json

  "AzureOpenAIClient-Cli": {
    "Model": "gpt-4-1106-preview",
    "Endpoint": "https://my-openai-service.openai.azure.com/openai/v1/",
    "Credential": {
      "CredentialSource": "AzureCli"
    }
  }

Sample usage with configuration only using ClientConnection

        ConfigurationManager config = new();
        config.AddJsonFile("appsettings.json", optional: false);
        config.AddEnvironmentVariables();

        ClientConnection openAIConnection = config.GetConnection("OpenAIClient");
        ClientConnection azureOpenAIConnection = config.GetAzureConnection("AzureOpenAIClient-Cli");

        ChatClient openAIChatClient = openAIConnection.CreateChatClient();
        ChatClient azureOpenAIChatClient = azureOpenAIConnection.CreateChatClient();

        Console.WriteLine(openAIChatClient.CompleteChat("Hello world!").Value.Content[0].Text);
        Console.WriteLine(azureOpenAIChatClient.CompleteChat("Hello world!").Value.Content[0].Text);

Sample usage with configuration only using new ClientSettings

        ConfigurationManager config = new();
        config.AddJsonFile("appsettings.json", optional: false);
        config.AddEnvironmentVariables();

        OpenAISettings openAISettings = config.GetClientSettings<OpenAISettings>("OpenAIClient");
        OpenAISettings azureOpenAISettings = config.GetClientSettings<OpenAISettings>("AzureOpenAIClient-Cli")
            .WithAzureCredential();

        ChatClient openAIChatClient = new(openAISettings);
        ChatClient azureOpenAIChatClient = new(azureOpenAISettings);

        Console.WriteLine(openAIChatClient.CompleteChat("Hello world!").Value.Content[0].Text);
        Console.WriteLine(azureOpenAIChatClient.CompleteChat("Hello world!").Value.Content[0].Text);

Sample usage with dependency injection

        ServiceProvider provider = Host.CreateApplicationBuilder()
            .AddKeyedOpenAIChatClient("oai", "OpenAIClient")
            .AddKeyedOpenAIChatClient("aoai", "AzureOpenAIClient-Cli")
                .WithAzureCredential()
            .Services.BuildServiceProvider();

        ChatClient openAIChatClient = provider.GetRequiredKeyedService<ChatClient>("oai");
        ChatClient azureOpenAIChatClient = provider.GetRequiredKeyedService<ChatClient>("aoai");

        Console.WriteLine(openAIChatClient.CompleteChat("Hello world!").Value.Content[0].Text);
        Console.WriteLine(azureOpenAIChatClient.CompleteChat("Hello world!").Value.Content[0].Text);

sdk/core/System.ClientModel/src/Convenience/ConfigurationManagerExtensions.cs

sdk/identity/Azure.Identity/src/Credentials/DefaultAzureCredentialOptions.cs

sdk/resourcemanager/Azure.ResourceManager/src/ClientConnectionExtensions.cs

sdk/core/System.ClientModel/src/Convenience/ConfigurationManagerExtensions.cs

github-actions · 2025-10-28T21:51:33Z

API Change Check

APIView identified API level changes in this PR and created the following API reviews

Azure.Core
Azure.Identity
Azure.ResourceManager
System.ClientModel

KrzysztofCwalina · 2025-10-29T21:55:07Z

sdk/core/System.ClientModel/api/System.ClientModel.net8.0.cs

    }
+    public static partial class ConfigurationManagerExtensions
+    {
+        public static System.ClientModel.Primitives.ClientConnection GetConnection(this Microsoft.Extensions.Configuration.IConfigurationManager configuration, string sectionName) { throw null; }


since these apis are in SCM, should these be just static Create methods on ClientConnection, or maybe even ClientConnection ctor? This way we don't need to add a new type (the config extensions)

KrzysztofCwalina · 2025-10-29T21:57:37Z

sdk/core/System.ClientModel/src/Convenience/ConfigurationManagerExtensions.cs

+    /// <param name="configuration"></param>
+    /// <param name="sectionName"></param>
+    /// <returns></returns>
+    public static ClientConnection GetConnection(this IConfigurationManager configuration, string sectionName)


I wonder if we dont need an optional parameter called "format" (or something like that). This would allow us to add support for all the combinations in aspire. Unless we are fine with probing all the formats.

sdk/identity/Azure.Identity/src/ConfigurationManagerExtensions.cs

christothes · 2025-12-11T21:36:41Z

sdk/core/System.ClientModel/src/Convenience/CredentialSettings.cs

+    /// <summary>
+    /// .
+    /// </summary>
+    public string? CredentialSource { get; set; }


Should we name this CredentialKind or is CredentialSource already established somewhere else?

Its established in Aspire and we would like to reuse that name / enumeration if possible.

christothes · 2025-12-11T21:37:47Z

sdk/core/System.ClientModel/src/Convenience/CredentialSettings.cs

+    /// <summary>
+    /// .
+    /// </summary>
+    public IConfigurationSection? Properties { get; set; }


should we name this ConfigurationSection?

christothes · 2025-12-11T21:38:42Z

sdk/core/System.ClientModel/src/Convenience/ClientSettingsBase.cs

+    /// <summary>
+    /// .
+    /// </summary>
+    public CredentialSettings? Credential { get; set; }


should we name this CredentialSettings?

m-nash · 2025-12-11T21:44:44Z

/azp run net - pullrequest

azure-pipelines · 2025-12-11T21:44:57Z

Azure Pipelines failed to run 1 pipeline(s).

m-nash · 2025-12-11T22:22:12Z

@mokarchi This is the draft PR we are working on to work out how configuration / di can work with our non azure sdks that depend on System.ClientModel and branded sdks that depend on Azure.Core and use Azure.Identity for credentials.

Given you are working on the openai PR wanted to make you aware in case you have some comments / suggestions as well.

…o ioptions

KrzysztofCwalina · 2025-12-11T23:12:13Z

sdk/core/System.ClientModel/api/System.ClientModel.net10.0.cs

        public static System.ClientModel.ContinuationToken FromBytes(System.BinaryData bytes) { throw null; }
        public virtual System.BinaryData ToBytes() { throw null; }
    }
+    public partial class CredentialSettings


@christothes, do we need to let people configure the tenentid?

Yes, this should be possible.

KrzysztofCwalina · 2025-12-11T23:14:12Z

sdk/core/System.ClientModel/api/System.ClientModel.net10.0.cs

        protected virtual void Wait(System.TimeSpan time, System.Threading.CancellationToken cancellationToken) { }
        protected virtual System.Threading.Tasks.Task WaitAsync(System.TimeSpan time, System.Threading.CancellationToken cancellationToken) { throw null; }
    }
+    public abstract partial class ClientSettingsBase


why do we need this base class? Why si ClientSettings not enough?

I would really like to avoid it. If we cannot, we need to come up with a better name than simply suffixing it with "Base"

KrzysztofCwalina · 2025-12-11T23:15:11Z

sdk/core/System.ClientModel/api/System.ClientModel.net10.0.cs

        protected sealed override void ProcessCore(System.ClientModel.Primitives.PipelineMessage message) { }
        protected sealed override System.Threading.Tasks.ValueTask ProcessCoreAsync(System.ClientModel.Primitives.PipelineMessage message) { throw null; }
    }
+    public partial interface IClientBuilder : Microsoft.Extensions.Hosting.IHostApplicationBuilder


do we really need it?

mokarchi · 2025-12-12T05:27:26Z

@mokarchi This is the draft PR we are working on to work out how configuration / di can work with our non azure sdks that depend on System.ClientModel and branded sdks that depend on Azure.Core and use Azure.Identity for credentials.

Given you are working on the openai PR wanted to make you aware in case you have some comments / suggestions as well.

Thanks for the heads-up! @m-nash
looks like a solid implementation from what I can tell in the changes

m-nash added 2 commits October 27, 2025 17:51

Initial draft of IConfiguration

6fe419d

merge main

7d2b64e

github-actions bot added Azure.Core Azure.Identity Mgmt This issue is related to a management package. labels Oct 28, 2025

github-project-automation bot added this to Azure Identity SDK Improvements Oct 28, 2025

github-project-automation bot moved this to Untriaged in Azure Identity SDK Improvements Oct 28, 2025

christothes reviewed Oct 28, 2025

View reviewed changes

sdk/core/System.ClientModel/src/Convenience/ConfigurationManagerExtensions.cs Outdated Show resolved Hide resolved

christothes reviewed Oct 28, 2025

View reviewed changes

sdk/core/System.ClientModel/src/Convenience/ConfigurationManagerExtensions.cs Outdated Show resolved Hide resolved

christothes reviewed Oct 28, 2025

View reviewed changes

sdk/identity/Azure.Identity/src/Credentials/DefaultAzureCredentialOptions.cs Outdated Show resolved Hide resolved

christothes reviewed Oct 28, 2025

View reviewed changes

sdk/identity/Azure.Identity/src/Credentials/DefaultAzureCredentialOptions.cs Outdated Show resolved Hide resolved

KrzysztofCwalina reviewed Oct 28, 2025

View reviewed changes

sdk/resourcemanager/Azure.ResourceManager/src/ClientConnectionExtensions.cs Outdated Show resolved Hide resolved

sdk/core/System.ClientModel/src/Convenience/ConfigurationManagerExtensions.cs Outdated Show resolved Hide resolved

m-nash added 3 commits October 28, 2025 13:24

update api

716c94f

add missing annotations

7ae7e49

add missing annotations

5fbf899

add ClientConnection ctor to ArmClient

3d9c526

KrzysztofCwalina reviewed Oct 29, 2025

View reviewed changes

m-nash added 6 commits November 6, 2025 13:53

merge main

597b783

update APIs

432a310

update api for identity

b750a42

merge main

777483c

update arm api

3db059c

update scm api

12950ab

jsquire mentioned this pull request Dec 1, 2025

[FEATURE REQ] Support keyed DI with AddAzureClients #40408

Closed

m-nash added 3 commits December 11, 2025 13:18

update with new changes

b2d8e2e

merge main

a9e627f

update api after merge

1e407a9

christothes reviewed Dec 11, 2025

View reviewed changes

Merge branch 'main' of https://github.com/Azure/azure-sdk-for-net int…

cd77cf9

…o ioptions

KrzysztofCwalina reviewed Dec 11, 2025

View reviewed changes

Add support for Microsoft.Extensions.Configuration #53527

Are you sure you want to change the base?

Add support for Microsoft.Extensions.Configuration #53527

Uh oh!

Conversation

m-nash commented Oct 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Oct 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

API Change Check

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

m-nash commented Dec 11, 2025

Uh oh!

azure-pipelines bot commented Dec 11, 2025

Uh oh!

m-nash commented Dec 11, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mokarchi commented Dec 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

m-nash commented Oct 28, 2025 •

edited

Loading

github-actions bot commented Oct 28, 2025 •

edited

Loading