Microsoft.Extensions.Options.ConfigurationExtensions 10.0.0-rc.1.25451.107

About

Microsoft.Extensions.Options.ConfigurationExtensions provides additional configuration-specific functionality related to Options.

Key Features

  • Extension methods for OptionsBuilder for configuration binding
  • Extension methods for IServiceCollection for Options configuration
  • ConfigurationChangeTokenSource for monitoring configuration changes

How to Use

Options Configuration binding

using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Options;

class Program
{
    // appsettings.json contents:
    // {
    //   "MyOptions": {
    //     "Setting1": "Value1",
    //     "Setting2": "Value2"
    //   }
    // }

    static void Main(string[] args)
    {
        IConfiguration configuration = new ConfigurationBuilder()
            .SetBasePath(Environment.CurrentDirectory)
            .AddJsonFile("appsettings.json")
            .Build();

        IServiceCollection services = new ServiceCollection();

        // Bind the configuration to MyOptions
        services.Configure<MyOptions>(configuration.GetSection("MyOptions"));

        IServiceProvider serviceProvider = services.BuildServiceProvider();

        // Retrieve MyOptions using dependency injection
        var myOptions = serviceProvider.GetRequiredService<IOptions<MyOptions>>().Value;

        // Access the bound configuration values
        Console.WriteLine($"Setting1: {myOptions.Setting1}");
        Console.WriteLine($"Setting2: {myOptions.Setting2}");
    }
}

public class MyOptions
{
    public string Setting1 { get; set; }
    public string Setting2 { get; set; }
}

Monitoring options configuration changes

// Assume we have a class that represents some options
public class MyOptions
{
    public string Name { get; set; }
    public int Age { get; set; }
}

// appsettings.json contents:
// {
//   "MyOptions": {
//     "Name": "Alice",
//     "Age": 25
//   }
// }

// Assume we have a configuration object that contains some settings
var config = new ConfigurationBuilder()
    .AddJsonFile("appsettings.json")
    .Build();

// We can use the ConfigurationChangeTokenSource to create a change token source for the options
var changeTokenSource = new ConfigurationChangeTokenSource<MyOptions>(config.GetSection("MyOptions"));

// We can register the change token source with the options monitor
services.AddOptions<MyOptions>()
    .Configure(options =>
    {
        // Configure the options with the configuration values
        config.GetSection("MyOptions").Bind(options);
    })
    .AddChangeTokenSource(changeTokenSource);

// Now we can inject the options monitor into any class that needs them
public class MyClass
{
    private readonly IOptionsMonitor<MyOptions> _optionsMonitor;

    public MyClass(IOptionsMonitor<MyOptions> optionsMonitor)
    {
        _optionsMonitor = optionsMonitor;
    }

    public void DoSomething()
    {
        // Can access the current options value like this
        var options = _optionsMonitor.CurrentValue;
        var name = options.Name;
        var age = options.Age;
        // Do something with name and age

        // Can also register a callback to be notified when the options change
        _optionsMonitor.OnChange(newOptions =>
        {
            // Do something when the options change
        });
    }
}

Main Types

The main types provided by this library are:

  • ConfigurationChangeTokenSource
  • OptionsBuilderConfigurationExtensions
  • OptionsConfigurationServiceCollectionExtensions

Additional Documentation

Feedback & Contributing

Microsoft.Extensions.Options.ConfigurationExtensions is released as open source under the MIT license. Bug reports and contributions are welcome at the GitHub repository.

Showing the top 20 packages that depend on Microsoft.Extensions.Options.ConfigurationExtensions.

Packages Downloads
EasyCaching.Core
EasyCaching is a open source caching library that contains basic usages and some advanced usages of caching which can help us to handle caching more easier!
35
Microsoft.Extensions.Diagnostics
This package includes the default implementation of IMeterFactory and additional extension methods to easily register it with the Dependency Injection framework.
347
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
37
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
48
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
58
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
225
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
5,501
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
9,086
nacos-sdk-csharp
nacos csharp sdk
72
nacos-sdk-csharp
nacos csharp sdk
99
nacos-sdk-csharp
nacos csharp sdk
109
nacos-sdk-csharp
nacos csharp sdk
414
ZhonTai.Common
中台通用库
35
ZhonTai.Common
中台通用库
36
ZhonTai.Common
中台通用库
37
ZhonTai.Common
中台通用库
38

https://go.microsoft.com/fwlink/?LinkID=799421

.NET Framework 4.6.2

.NET Standard 2.0

.NET 10.0

.NET 9.0

.NET 8.0

Version Downloads Last updated
10.0.0-rc.1.25451.107 7 09/11/2025
10.0.0-preview.7.25380.108 6 08/14/2025
10.0.0-preview.6.25358.103 10 07/17/2025
10.0.0-preview.5.25277.114 9 06/08/2025
10.0.0-preview.4.25258.110 17 05/15/2025
10.0.0-preview.3.25171.5 14 04/15/2025
10.0.0-preview.2.25163.2 15 03/28/2025
10.0.0-preview.1.25080.5 14 03/12/2025
9.0.9 6 09/11/2025
9.0.8 7 08/08/2025
9.0.7 8 07/09/2025
9.0.6 13 06/14/2025
9.0.5 16 05/16/2025
9.0.4 14 04/16/2025
9.0.3 16 03/15/2025
9.0.2 19 02/18/2025
9.0.1 20 01/24/2025
9.0.0 29 11/29/2024
9.0.0-rc.2.24473.5 21 11/29/2024
9.0.0-rc.1.24431.7 17 12/04/2024
9.0.0-preview.7.24405.7 22 12/02/2024
9.0.0-preview.6.24327.7 19 12/08/2024
9.0.0-preview.5.24306.7 22 12/04/2024
9.0.0-preview.4.24266.19 23 12/09/2024
9.0.0-preview.3.24172.9 32 05/09/2024
9.0.0-preview.2.24128.5 29 04/30/2024
9.0.0-preview.1.24080.9 23 05/02/2024
8.0.0 203 12/18/2023
8.0.0-rc.2.23479.6 26 05/18/2024
8.0.0-rc.1.23419.4 26 05/06/2024
8.0.0-preview.7.23375.6 21 12/08/2024
8.0.0-preview.6.23329.7 35 08/08/2023
8.0.0-preview.5.23280.8 18 12/07/2024
8.0.0-preview.4.23259.5 21 05/20/2024
8.0.0-preview.3.23174.8 21 05/02/2024
8.0.0-preview.2.23128.3 26 05/02/2024
8.0.0-preview.1.23110.8 20 05/09/2024
7.0.0 44 09/08/2023
7.0.0-rc.2.22472.3 25 05/09/2024
7.0.0-rc.1.22426.10 25 05/08/2024
7.0.0-preview.7.22375.6 22 05/16/2024
7.0.0-preview.6.22324.4 24 05/09/2024
7.0.0-preview.5.22301.12 27 05/18/2024
7.0.0-preview.4.22229.4 22 12/01/2024
7.0.0-preview.3.22175.4 23 05/17/2024
7.0.0-preview.2.22152.2 23 05/04/2024
7.0.0-preview.1.22076.8 21 12/02/2024
6.0.1 22 12/02/2024
6.0.0 293 07/01/2022
6.0.0-rc.2.21480.5 28 05/03/2024
6.0.0-rc.1.21451.13 23 05/22/2024
6.0.0-preview.7.21377.19 21 12/11/2024
6.0.0-preview.6.21352.12 20 12/04/2024
6.0.0-preview.5.21301.5 24 05/08/2024
6.0.0-preview.4.21253.7 25 05/26/2024
6.0.0-preview.3.21201.4 20 12/10/2024
6.0.0-preview.2.21154.6 23 05/04/2024
6.0.0-preview.1.21102.12 22 12/04/2024
5.0.0-rc.2.20475.5 26 05/02/2024
5.0.0-rc.1.20451.14 25 05/19/2024
5.0.0-preview.8.20407.11 23 05/04/2024
5.0.0-preview.6.20305.6 19 12/02/2024
5.0.0-preview.5.20278.1 26 05/11/2024
5.0.0-preview.4.20251.6 21 12/06/2024
5.0.0-preview.3.20215.2 22 05/05/2024
5.0.0-preview.1.20120.4 24 05/24/2024
3.1.32 9,047 05/12/2023
3.1.31 23 05/20/2024
3.1.30 5,472 11/03/2022
3.1.29 28 05/09/2024
3.1.28 21 05/27/2024
3.1.27 24 05/27/2024
3.1.26 24 05/09/2024
3.1.25 17 05/01/2024
3.1.23 37 06/08/2023
3.1.22 19 12/04/2024
3.1.19 20 07/07/2022
3.1.18 26 05/05/2024
3.1.17 23 05/05/2024
3.1.16 30 06/22/2022
3.1.14 24 05/11/2024
3.1.11 27 05/15/2024
3.1.7 21 12/04/2024
3.1.5 25 05/25/2024
3.1.4 20 12/01/2024
3.1.3 24 05/05/2024
3.1.1 22 05/06/2024
3.1.0-preview3.19553.2 28 11/04/2022
3.1.0-preview2.19525.4 18 12/02/2024
3.1.0-preview1.19506.1 21 12/02/2024
3.0.3 24 12/02/2024
3.0.0-rc1.19456.10 23 05/14/2024
3.0.0-preview9.19423.4 22 05/10/2024
3.0.0-preview8.19405.4 22 12/01/2024
3.0.0-preview5.19227.9 22 12/08/2024
3.0.0-preview3.19153.1 23 12/02/2024
3.0.0-preview.19074.2 25 05/01/2024
3.0.0-preview.18572.1 22 05/10/2024
2.2.0-preview3-35497 28 05/02/2024
2.2.0-preview2-35157 25 05/15/2024
2.2.0-preview1-35029 24 05/14/2024
2.1.1 25 01/31/2024
2.1.0 26 01/04/2024
2.1.0-rc1-final 28 05/16/2024
2.1.0-preview2-final 30 05/12/2024
2.1.0-preview1-final 19 12/02/2024
2.0.2 26 05/26/2024
2.0.1 22 05/21/2024
2.0.0-preview2-final 21 05/02/2024
1.1.2 23 05/24/2024
1.1.1 22 05/22/2024
1.1.0 21 05/02/2024
1.1.0-preview1-final 25 05/07/2024
1.0.2 24 05/01/2024
1.0.0 24 05/21/2024
1.0.0-rc2-final 33 05/01/2024