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

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.AspNetCore.All Provides a default set of APIs for building an ASP.NET Core application, and also includes API for third-party integrations with ASP.NET Core. This package requires the ASP.NET Core runtime. This runtime is installed by the .NET Core SDK, or can be acquired separately using installers available at https://aka.ms/dotnet-download.	55
Microsoft.AspNetCore.All Provides a default set of APIs for building an ASP.NET Core application, and also includes API for third-party integrations with ASP.NET Core. This package requires the ASP.NET Core runtime. This runtime is installed by the .NET Core SDK, or can be acquired separately using installers available at https://aka.ms/dotnet-download.	56
Microsoft.AspNetCore.All Provides a default set of APIs for building an ASP.NET Core application, and also includes API for third-party integrations with ASP.NET Core. This package requires the ASP.NET Core runtime. This runtime is installed by the .NET Core SDK, or can be acquired separately using installers available at https://aka.ms/dotnet-download.	57
Microsoft.Extensions.Logging.Configuration Configuration support for Microsoft.Extensions.Logging.	54
Microsoft.Extensions.Logging.Configuration Configuration support for Microsoft.Extensions.Logging.	55
Microsoft.Extensions.Logging.Configuration Configuration support for Microsoft.Extensions.Logging.	56
Microsoft.Extensions.Logging.Configuration Configuration support for Microsoft.Extensions.Logging.	58
Microsoft.Extensions.Logging.Configuration Configuration support for Microsoft.Extensions.Logging.	61
Microsoft.Extensions.Logging.Configuration Configuration support for Microsoft.Extensions.Logging.	126
Serilog.Settings.Configuration Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.	54
Serilog.Settings.Configuration Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.	55
Serilog.Settings.Configuration Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.	57
Serilog.Settings.Configuration Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.	58
Serilog.Settings.Configuration Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.	59
Serilog.Settings.Configuration Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.	63
Serilog.Settings.Configuration Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.	160

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

Version	Downloads	Last updated
10.0.0-preview.5.25277.114	8	06/07/2025
10.0.0-preview.4.25258.110	13	05/15/2025
10.0.0-preview.3.25171.5	25	04/11/2025
10.0.0-preview.2.25163.2	24	04/01/2025
10.0.0-preview.1.25080.5	19	03/30/2025
9.0.6	7	06/13/2025
9.0.5	14	05/15/2025
9.0.4	24	04/09/2025
9.0.3	24	04/02/2025
9.0.2	25	04/02/2025
9.0.1	20	04/02/2025
9.0.0	27	11/14/2024
9.0.0-rc.2.24473.5	27	10/22/2024
9.0.0-rc.1.24431.7	28	09/19/2024
9.0.0-preview.7.24405.7	30	08/20/2024
9.0.0-preview.6.24327.7	49	07/19/2024
9.0.0-preview.5.24306.7	49	07/19/2024
9.0.0-preview.4.24266.19	48	07/19/2024
9.0.0-preview.3.24172.9	40	07/19/2024
9.0.0-preview.2.24128.5	53	07/19/2024
9.0.0-preview.1.24080.9	52	07/19/2024
8.0.0	63	02/13/2024
8.0.0-rc.2.23479.6	57	07/19/2024
8.0.0-rc.1.23419.4	54	07/19/2024
8.0.0-preview.7.23375.6	47	07/19/2024
8.0.0-preview.6.23329.7	51	07/19/2024
8.0.0-preview.5.23280.8	42	07/19/2024
8.0.0-preview.4.23259.5	51	07/19/2024
8.0.0-preview.3.23174.8	53	07/19/2024
8.0.0-preview.2.23128.3	41	07/19/2024
8.0.0-preview.1.23110.8	47	07/19/2024
7.0.0	46	07/19/2024
7.0.0-rc.2.22472.3	49	07/19/2024
7.0.0-rc.1.22426.10	56	07/19/2024
7.0.0-preview.7.22375.6	45	07/19/2024
7.0.0-preview.6.22324.4	49	07/19/2024
7.0.0-preview.5.22301.12	56	07/19/2024
7.0.0-preview.4.22229.4	42	07/19/2024
7.0.0-preview.3.22175.4	52	07/19/2024
7.0.0-preview.2.22152.2	54	07/19/2024
7.0.0-preview.1.22076.8	52	07/19/2024
6.0.2-mauipre.1.22102.15	24	12/04/2024
6.0.1	26	11/14/2024
6.0.0	150	02/04/2024
6.0.0-rc.2.21480.5	49	07/19/2024
6.0.0-rc.1.21451.13	49	07/19/2024
6.0.0-preview.7.21377.19	57	07/19/2024
6.0.0-preview.6.21352.12	53	07/19/2024
6.0.0-preview.5.21301.5	52	07/19/2024
6.0.0-preview.4.21253.7	47	07/19/2024
6.0.0-preview.3.21201.4	56	07/19/2024
6.0.0-preview.2.21154.6	47	07/19/2024
6.0.0-preview.1.21102.12	55	07/19/2024
5.0.0	58	07/19/2024
5.0.0-rc.2.20475.5	51	07/19/2024
5.0.0-rc.1.20451.14	55	07/19/2024
5.0.0-preview.8.20407.11	42	07/19/2024
5.0.0-preview.7.20364.11	51	07/19/2024
5.0.0-preview.6.20305.6	63	07/19/2024
5.0.0-preview.5.20278.1	53	07/19/2024
5.0.0-preview.4.20251.6	47	07/19/2024
5.0.0-preview.3.20215.2	51	07/19/2024
5.0.0-preview.2.20160.3	44	07/19/2024
5.0.0-preview.1.20120.4	44	07/19/2024
3.1.32	57	07/19/2024
3.1.31	50	07/19/2024
3.1.30	49	07/19/2024
3.1.29	50	07/19/2024
3.1.28	56	07/19/2024
3.1.27	59	07/19/2024
3.1.26	52	07/19/2024
3.1.25	50	07/19/2024
3.1.24	52	07/19/2024
3.1.23	54	07/19/2024
3.1.22	44	07/19/2024
3.1.21	60	07/19/2024
3.1.20	50	07/19/2024
3.1.19	55	07/19/2024
3.1.18	53	07/19/2024
3.1.17	46	07/19/2024
3.1.16	47	07/19/2024
3.1.15	52	07/19/2024
3.1.14	53	07/19/2024
3.1.13	54	07/19/2024
3.1.12	55	07/19/2024
3.1.11	58	07/19/2024
3.1.10	49	07/19/2024
3.1.9	47	07/19/2024
3.1.8	51	07/19/2024
3.1.7	47	07/19/2024
3.1.6	44	07/19/2024
3.1.5	59	07/19/2024
3.1.4	61	07/19/2024
3.1.3	55	07/19/2024
3.1.2	50	07/19/2024
3.1.1	48	07/19/2024
3.1.0	53	07/19/2024
3.1.0-preview3.19553.2	49	07/19/2024
3.1.0-preview2.19525.4	45	07/19/2024
3.1.0-preview1.19506.1	49	07/19/2024
3.0.3	54	07/19/2024
3.0.2	50	07/19/2024
3.0.1	55	07/19/2024
3.0.0	62	07/19/2024
3.0.0-rc1.19456.10	59	07/19/2024
3.0.0-preview9.19423.4	52	07/19/2024
3.0.0-preview8.19405.4	44	07/19/2024
3.0.0-preview7.19362.4	52	07/19/2024
3.0.0-preview6.19304.6	46	07/19/2024
3.0.0-preview5.19227.9	46	07/19/2024
3.0.0-preview4.19216.2	50	07/19/2024
3.0.0-preview3.19153.1	55	07/19/2024
3.0.0-preview.19074.2	57	07/19/2024
3.0.0-preview.18572.1	52	07/19/2024
2.2.0	46	07/19/2024
2.2.0-preview3-35497	48	07/19/2024
2.2.0-preview2-35157	41	07/19/2024
2.2.0-preview1-35029	57	07/19/2024
2.1.1	51	07/19/2024
2.1.0	57	07/19/2024
2.1.0-rc1-final	45	07/19/2024
2.1.0-preview2-final	49	07/19/2024
2.1.0-preview1-final	49	07/19/2024
2.0.2	47	07/19/2024
2.0.1	53	07/19/2024
2.0.0	142	02/04/2024
2.0.0-preview2-final	48	07/19/2024
2.0.0-preview1-final	52	07/19/2024
1.1.2	47	07/19/2024
1.1.1	52	07/19/2024
1.1.0	61	07/19/2024
1.1.0-preview1-final	44	07/19/2024
1.0.2	46	07/19/2024
1.0.1	45	07/19/2024
1.0.0	52	07/19/2024
1.0.0-rc2-final	54	07/19/2024

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

Readme

About

Key Features

How to Use

Options Configuration binding

Monitoring options configuration changes

Main Types

Additional Documentation

Related Packages

Feedback & Contributing

Used By

Release Notes

Dependencies

.NET Framework 4.6.2

.NET Standard 2.0

.NET 10.0

.NET 9.0

.NET 8.0

Versions