Microsoft.Extensions.Options.ConfigurationExtensions 9.0.10

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
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 9
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 8
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging. This package was built from the source at: https://github.com/aspnet/Logging/tree/bdd33cdcfd6345c01f820ae0726c49b2c3bc4939
 8
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging. This package was built from the source code at https://github.com/aspnet/Extensions/tree/0de62ae930da31048ba7e54c8cd0c6c0bcbd9095
 8

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

.NET Framework 4.6.2

.NET Standard 2.0

.NET 9.0

.NET 8.0

Version Downloads Last updated
10.0.1 1 12/15/2025
10.0.0 1 12/15/2025
10.0.0-rc.2.25502.107 2 11/05/2025
10.0.0-rc.1.25451.107 3 09/14/2025
10.0.0-preview.7.25380.108 3 09/14/2025
10.0.0-preview.6.25358.103 4 08/06/2025
10.0.0-preview.5.25277.114 4 07/01/2025
10.0.0-preview.4.25258.110 6 05/23/2025
10.0.0-preview.3.25171.5 6 05/23/2025
10.0.0-preview.2.25163.2 7 03/20/2025
10.0.0-preview.1.25080.5 7 03/20/2025
9.0.11 1 12/15/2025
9.0.10 2 11/05/2025
9.0.9 3 09/14/2025
9.0.8 3 09/14/2025
9.0.7 4 08/06/2025
9.0.6 5 07/01/2025
9.0.5 6 05/23/2025
9.0.4 6 05/23/2025
9.0.3 7 03/20/2025
9.0.2 7 03/20/2025
9.0.1 7 03/20/2025
9.0.0 7 03/20/2025
9.0.0-rc.2.24473.5 7 03/20/2025
9.0.0-rc.1.24431.7 7 03/20/2025
9.0.0-preview.7.24405.7 7 03/20/2025
9.0.0-preview.6.24327.7 7 03/20/2025
9.0.0-preview.5.24306.7 7 03/20/2025
9.0.0-preview.4.24266.19 7 03/20/2025
9.0.0-preview.3.24172.9 7 03/20/2025
9.0.0-preview.2.24128.5 7 03/20/2025
9.0.0-preview.1.24080.9 8 03/20/2025
8.0.0 7 03/20/2025
8.0.0-rc.2.23479.6 7 03/20/2025
8.0.0-rc.1.23419.4 7 03/20/2025
8.0.0-preview.7.23375.6 7 03/20/2025
8.0.0-preview.6.23329.7 7 03/20/2025
8.0.0-preview.5.23280.8 7 03/20/2025
8.0.0-preview.4.23259.5 7 03/20/2025
8.0.0-preview.3.23174.8 8 03/20/2025
8.0.0-preview.2.23128.3 7 03/20/2025
8.0.0-preview.1.23110.8 7 03/20/2025
7.0.0 7 03/20/2025
7.0.0-rc.2.22472.3 7 03/20/2025
7.0.0-rc.1.22426.10 7 03/20/2025
7.0.0-preview.7.22375.6 7 03/20/2025
7.0.0-preview.6.22324.4 7 03/20/2025
7.0.0-preview.5.22301.12 7 03/20/2025
7.0.0-preview.4.22229.4 7 03/20/2025
7.0.0-preview.3.22175.4 7 03/20/2025
7.0.0-preview.2.22152.2 7 03/20/2025
7.0.0-preview.1.22076.8 7 03/20/2025
6.0.1 7 03/20/2025
6.0.0 7 03/20/2025
6.0.0-rc.2.21480.5 7 03/20/2025
6.0.0-rc.1.21451.13 8 03/20/2025
6.0.0-preview.7.21377.19 7 03/20/2025
6.0.0-preview.6.21352.12 7 03/20/2025
6.0.0-preview.5.21301.5 7 03/20/2025
6.0.0-preview.4.21253.7 7 03/20/2025
6.0.0-preview.3.21201.4 7 03/20/2025
6.0.0-preview.2.21154.6 7 03/20/2025
6.0.0-preview.1.21102.12 7 03/20/2025
5.0.0 7 03/20/2025
5.0.0-rc.2.20475.5 7 03/20/2025
5.0.0-rc.1.20451.14 7 03/20/2025
5.0.0-preview.8.20407.11 7 03/20/2025
5.0.0-preview.7.20364.11 7 03/20/2025
5.0.0-preview.6.20305.6 7 03/20/2025
5.0.0-preview.5.20278.1 7 03/20/2025
5.0.0-preview.4.20251.6 7 03/20/2025
5.0.0-preview.3.20215.2 8 03/20/2025
5.0.0-preview.2.20160.3 7 03/20/2025
5.0.0-preview.1.20120.4 7 03/20/2025
3.1.32 7 03/20/2025
3.1.31 7 03/20/2025
3.1.30 7 03/20/2025
3.1.29 7 03/20/2025
3.1.28 7 03/20/2025
3.1.27 8 03/20/2025
3.1.26 8 03/20/2025
3.1.25 7 03/20/2025
3.1.24 7 03/20/2025
3.1.23 7 03/20/2025
3.1.22 7 03/20/2025
3.1.21 7 03/20/2025
3.1.20 7 03/20/2025
3.1.19 7 03/20/2025
3.1.18 7 03/20/2025
3.1.17 8 03/20/2025
3.1.16 7 03/20/2025
3.1.15 7 03/20/2025
3.1.14 7 03/20/2025
3.1.13 7 03/20/2025
3.1.12 7 03/20/2025
3.1.11 7 03/20/2025
3.1.10 7 03/20/2025
3.1.9 7 03/20/2025
3.1.8 7 03/20/2025
3.1.7 7 03/20/2025
3.1.6 7 03/20/2025
3.1.5 7 03/20/2025
3.1.4 7 03/20/2025
3.1.3 7 03/20/2025
3.1.2 7 03/20/2025
3.1.1 7 03/20/2025
3.1.0 7 03/20/2025
3.1.0-preview3.19553.2 7 03/20/2025
3.1.0-preview2.19525.4 7 03/20/2025
3.1.0-preview1.19506.1 7 03/20/2025
3.0.3 7 03/20/2025
3.0.2 7 03/20/2025
3.0.1 7 03/20/2025
3.0.0 7 03/20/2025
3.0.0-rc1.19456.10 7 03/20/2025
3.0.0-preview9.19423.4 7 03/20/2025
3.0.0-preview8.19405.4 7 03/20/2025
3.0.0-preview7.19362.4 7 03/20/2025
3.0.0-preview6.19304.6 7 03/20/2025
3.0.0-preview5.19227.9 7 03/20/2025
3.0.0-preview4.19216.2 7 03/20/2025
3.0.0-preview3.19153.1 7 03/20/2025
3.0.0-preview.19074.2 7 03/20/2025
3.0.0-preview.18572.1 7 03/20/2025
2.2.0 7 03/20/2025
2.2.0-preview3-35497 7 03/20/2025
2.2.0-preview2-35157 7 03/20/2025
2.2.0-preview1-35029 7 03/20/2025
2.1.1 7 03/20/2025
2.1.0 7 03/20/2025
2.1.0-rc1-final 8 03/20/2025
2.1.0-preview2-final 7 03/20/2025
2.1.0-preview1-final 7 03/20/2025
2.0.2 7 03/20/2025
2.0.1 7 03/20/2025
2.0.0 6 03/20/2025
2.0.0-preview2-final 7 03/20/2025
2.0.0-preview1-final 7 03/20/2025
1.1.2 7 03/20/2025
1.1.1 7 03/20/2025
1.1.0 7 03/20/2025
1.1.0-preview1-final 7 03/20/2025
1.0.2 7 03/20/2025
1.0.1 7 03/20/2025
1.0.0 8 03/20/2025
1.0.0-rc2-final 7 03/20/2025