Microsoft.Extensions.Options.ConfigurationExtensions 10.0.0-preview.3.25171.5

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
HttpReports.Dashboard
HttpReports is a lightweight APM system developed for Net Core
 94
HttpReports.Dashboard
HttpReports is a lightweight APM system developed for Net Core
 95
HttpReports.Dashboard
HttpReports is an lightweight APM system for microservice in .Net Core github: https://github.com/SpringLeee/HttpReports
 97
Lazy.Captcha.Core
仿EasyCaptcha和SimpleCaptcha,基于.Net Standard 2.0的图形验证码模块。版本2.0.0起绘图由ImageSharp调整为SkiaSharp。文档地址: https://gitee.com/pojianbing/lazy-captcha
 97
Microsoft.Extensions.Diagnostics
This package includes the default implementation of IMeterFactory and additional extension methods to easily register it with the Dependency Injection framework.
 463
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 92
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 294
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 5,541
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 9,430
nacos-sdk-csharp
nacos csharp sdk
 109
nacos-sdk-csharp
nacos csharp sdk
 172
nacos-sdk-csharp
nacos csharp sdk
 194
nacos-sdk-csharp
nacos csharp sdk
 807
ZhonTai.Common
中台通用库
 91
ZhonTai.Common
中台通用库
 95
ZhonTai.Common
中台通用库
 96
ZhonTai.Common
中台通用库
 99
ZhonTai.Common
中台通用库
 100

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 43 11/13/2025
10.0.0-rc.2.25502.107 35 10/14/2025
10.0.0-rc.1.25451.107 37 09/11/2025
10.0.0-preview.7.25380.108 37 08/14/2025
10.0.0-preview.6.25358.103 35 07/17/2025
10.0.0-preview.5.25277.114 48 06/08/2025
10.0.0-preview.4.25258.110 48 05/15/2025
10.0.0-preview.3.25171.5 51 04/15/2025
10.0.0-preview.2.25163.2 38 03/28/2025
10.0.0-preview.1.25080.5 38 03/12/2025
9.0.11 36 11/14/2025
9.0.10 32 10/14/2025
9.0.9 30 09/11/2025
9.0.8 35 08/08/2025
9.0.7 43 07/09/2025
9.0.6 40 06/14/2025
9.0.5 43 05/16/2025
9.0.4 49 04/16/2025
9.0.3 48 03/15/2025
9.0.2 50 02/18/2025
9.0.1 51 01/24/2025
9.0.0 57 11/29/2024
9.0.0-rc.2.24473.5 50 11/29/2024
9.0.0-rc.1.24431.7 37 12/04/2024
9.0.0-preview.7.24405.7 47 12/02/2024
9.0.0-preview.6.24327.7 45 12/08/2024
9.0.0-preview.5.24306.7 48 12/04/2024
9.0.0-preview.4.24266.19 48 12/09/2024
9.0.0-preview.3.24172.9 62 05/09/2024
9.0.0-preview.2.24128.5 54 04/30/2024
9.0.0-preview.1.24080.9 49 05/02/2024
8.0.0 284 12/18/2023
8.0.0-rc.2.23479.6 56 05/18/2024
8.0.0-rc.1.23419.4 53 05/06/2024
8.0.0-preview.7.23375.6 44 12/08/2024
8.0.0-preview.6.23329.7 58 08/08/2023
8.0.0-preview.5.23280.8 46 12/07/2024
8.0.0-preview.4.23259.5 57 05/20/2024
8.0.0-preview.3.23174.8 53 05/02/2024
8.0.0-preview.2.23128.3 52 05/02/2024
8.0.0-preview.1.23110.8 46 05/09/2024
7.0.0 72 09/08/2023
7.0.0-rc.2.22472.3 47 05/09/2024
7.0.0-rc.1.22426.10 48 05/08/2024
7.0.0-preview.7.22375.6 45 05/16/2024
7.0.0-preview.6.22324.4 51 05/09/2024
7.0.0-preview.5.22301.12 54 05/18/2024
7.0.0-preview.4.22229.4 46 12/01/2024
7.0.0-preview.3.22175.4 46 05/17/2024
7.0.0-preview.2.22152.2 48 05/04/2024
7.0.0-preview.1.22076.8 49 12/02/2024
6.0.1 49 12/02/2024
6.0.0 336 07/01/2022
6.0.0-rc.2.21480.5 53 05/03/2024
6.0.0-rc.1.21451.13 49 05/22/2024
6.0.0-preview.7.21377.19 49 12/11/2024
6.0.0-preview.6.21352.12 57 12/04/2024
6.0.0-preview.5.21301.5 56 05/08/2024
6.0.0-preview.4.21253.7 48 05/26/2024
6.0.0-preview.3.21201.4 42 12/10/2024
6.0.0-preview.2.21154.6 57 05/04/2024
6.0.0-preview.1.21102.12 50 12/04/2024
5.0.0-rc.2.20475.5 50 05/02/2024
5.0.0-rc.1.20451.14 55 05/19/2024
5.0.0-preview.8.20407.11 49 05/04/2024
5.0.0-preview.6.20305.6 42 12/02/2024
5.0.0-preview.5.20278.1 60 05/11/2024
5.0.0-preview.4.20251.6 44 12/06/2024
5.0.0-preview.3.20215.2 47 05/05/2024
5.0.0-preview.1.20120.4 49 05/24/2024
3.1.32 9,388 05/12/2023
3.1.31 52 05/20/2024
3.1.30 5,510 11/03/2022
3.1.29 73 05/09/2024
3.1.28 67 05/27/2024
3.1.27 53 05/27/2024
3.1.26 49 05/09/2024
3.1.25 42 05/01/2024
3.1.23 61 06/08/2023
3.1.22 46 12/04/2024
3.1.19 47 07/07/2022
3.1.18 50 05/05/2024
3.1.17 50 05/05/2024
3.1.16 62 06/22/2022
3.1.14 49 05/11/2024
3.1.11 49 05/15/2024
3.1.7 47 12/04/2024
3.1.5 50 05/25/2024
3.1.4 45 12/01/2024
3.1.3 47 05/05/2024
3.1.1 46 05/06/2024
3.1.0-preview3.19553.2 61 11/04/2022
3.1.0-preview2.19525.4 46 12/02/2024
3.1.0-preview1.19506.1 44 12/02/2024
3.0.3 55 12/02/2024
3.0.0-rc1.19456.10 46 05/14/2024
3.0.0-preview9.19423.4 44 05/10/2024
3.0.0-preview8.19405.4 50 12/01/2024
3.0.0-preview5.19227.9 53 12/08/2024
3.0.0-preview3.19153.1 44 12/02/2024
3.0.0-preview.19074.2 54 05/01/2024
3.0.0-preview.18572.1 51 05/10/2024
2.2.0-preview3-35497 55 05/02/2024
2.2.0-preview2-35157 51 05/15/2024
2.2.0-preview1-35029 49 05/14/2024
2.1.1 56 01/31/2024
2.1.0 51 01/04/2024
2.1.0-rc1-final 57 05/16/2024
2.1.0-preview2-final 55 05/12/2024
2.1.0-preview1-final 48 12/02/2024
2.0.2 53 05/26/2024
2.0.1 48 05/21/2024
2.0.0-preview2-final 43 05/02/2024
1.1.2 48 05/24/2024
1.1.1 49 05/22/2024
1.1.0 48 05/02/2024
1.1.0-preview1-final 59 05/07/2024
1.0.2 47 05/01/2024
1.0.0 48 05/21/2024
1.0.0-rc2-final 53 05/01/2024