Microsoft.Extensions.Options.ConfigurationExtensions 10.0.4

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
R4Mvc.Tools
R4Mvc is a tool that generates strongly typed helpers for ASP.NET Core MVC.
 149
Microsoft.Extensions.Logging.Console
Console logger provider implementation for Microsoft.Extensions.Logging. When using NuGet 3.x this package requires at least version 3.4.
 135
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 135
R4Mvc.Tools
R4Mvc is a tool that generates strongly typed helpers for ASP.NET Core MVC.
 134
Microsoft.Extensions.Logging.Console
Console logger provider implementation for Microsoft.Extensions.Logging. When using NuGet 3.x this package requires at least version 3.4.
 133
R4Mvc.Tools
R4Mvc is a tool that generates strongly typed helpers for ASP.NET Core MVC.
 133
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 131
R4Mvc.Tools
R4Mvc is a tool that generates strongly typed helpers for ASP.NET Core MVC.
 130
R4Mvc.Tools
R4Mvc is a tool that generates strongly typed helpers for ASP.NET Core MVC.
 128
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 126
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/9bc79b2f25a3724376d7af19617c33749a30ea3a
 124
Microsoft.Extensions.Logging.Console
Console logger provider implementation for Microsoft.Extensions.Logging.
 123
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 123
Microsoft.Extensions.Logging.Console
Console logger provider implementation for Microsoft.Extensions.Logging. When using NuGet 3.x this package requires at least version 3.4.
 123
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 121
R4Mvc.Tools
R4Mvc is a tool that generates strongly typed helpers for ASP.NET Core MVC.
 121
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 119

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

.NET Framework 4.6.2

.NET 8.0

.NET 9.0

.NET 10.0

.NET Standard 2.0

Version Downloads Last updated
11.0.0-preview.2.26159.112 2 3/12/2026
11.0.0-preview.1.26104.118 6 2/14/2026
10.0.5 2 3/14/2026
10.0.4 2 3/12/2026
10.0.3 6 2/14/2026
10.0.2 9 1/13/2026
10.0.1 20 12/11/2025
10.0.0 39 11/11/2025
10.0.0-rc.2.25502.107 49 10/17/2025
10.0.0-rc.1.25451.107 63 9/10/2025
10.0.0-preview.7.25380.108 73 8/15/2025
10.0.0-preview.6.25358.103 61 7/15/2025
10.0.0-preview.5.25277.114 69 6/8/2025
10.0.0-preview.4.25258.110 81 5/16/2025
10.0.0-preview.3.25171.5 85 4/14/2025
10.0.0-preview.2.25163.2 74 3/27/2025
10.0.0-preview.1.25080.5 98 2/27/2025
9.0.14 2 3/12/2026
9.0.13 7 2/14/2026
9.0.12 8 1/13/2026
9.0.11 40 11/11/2025
9.0.10 61 10/17/2025
9.0.9 58 9/10/2025
9.0.8 68 8/6/2025
9.0.7 60 7/8/2025
9.0.6 75 6/12/2025
9.0.5 65 5/17/2025
9.0.4 70 4/9/2025
9.0.3 81 3/11/2025
9.0.2 83 2/13/2025
9.0.1 91 1/18/2025
9.0.0 92 11/17/2024
9.0.0-rc.2.24473.5 83 10/19/2024
9.0.0-rc.1.24431.7 89 9/11/2024
9.0.0-preview.7.24405.7 82 8/14/2024
9.0.0-preview.6.24327.7 103 7/11/2024
9.0.0-preview.5.24306.7 110 6/13/2024
9.0.0-preview.4.24266.19 99 5/29/2024
9.0.0-preview.3.24172.9 99 4/13/2024
9.0.0-preview.2.24128.5 110 3/21/2024
9.0.0-preview.1.24080.9 111 2/29/2024
8.0.0 128 11/16/2023
8.0.0-rc.2.23479.6 137 10/14/2023
8.0.0-rc.1.23419.4 138 9/17/2023
8.0.0-preview.7.23375.6 126 8/23/2023
8.0.0-preview.6.23329.7 115 7/31/2023
8.0.0-preview.5.23280.8 118 7/31/2023
8.0.0-preview.4.23259.5 113 5/20/2023
8.0.0-preview.3.23174.8 98 5/12/2023
8.0.0-preview.2.23128.3 121 5/12/2023
8.0.0-preview.1.23110.8 107 2/23/2023
7.0.0 112 12/3/2022
7.0.0-rc.2.22472.3 112 12/3/2022
7.0.0-rc.1.22426.10 126 9/15/2022
7.0.0-preview.7.22375.6 112 9/15/2022
7.0.0-preview.6.22324.4 116 9/15/2022
7.0.0-preview.5.22301.12 103 6/26/2022
7.0.0-preview.4.22229.4 107 7/3/2022
7.0.0-preview.3.22175.4 119 7/3/2022
7.0.0-preview.2.22152.2 103 7/3/2022
7.0.0-preview.1.22076.8 115 7/3/2022
6.0.2-mauipre.1.22102.15 109 7/3/2022
6.0.2-mauipre.1.22054.8 130 7/3/2022
6.0.1 92 11/18/2024
6.0.0 130 7/3/2022
6.0.0-rc.2.21480.5 135 7/3/2022
6.0.0-rc.1.21451.13 128 7/3/2022
6.0.0-preview.7.21377.19 140 7/3/2022
6.0.0-preview.6.21352.12 134 7/3/2022
6.0.0-preview.5.21301.5 120 7/3/2022
6.0.0-preview.4.21253.7 112 7/3/2022
6.0.0-preview.3.21201.4 130 7/3/2022
6.0.0-preview.2.21154.6 120 7/3/2022
6.0.0-preview.1.21102.12 122 7/3/2022
5.0.0 114 7/3/2022
5.0.0-rc.2.20475.5 111 7/3/2022
5.0.0-rc.1.20451.14 115 7/3/2022
5.0.0-preview.8.20407.11 124 7/3/2022
5.0.0-preview.7.20364.11 125 7/3/2022
5.0.0-preview.6.20305.6 110 7/3/2022
5.0.0-preview.5.20278.1 110 7/3/2022
5.0.0-preview.4.20251.6 133 7/3/2022
5.0.0-preview.3.20215.2 118 7/3/2022
5.0.0-preview.2.20160.3 105 7/3/2022
5.0.0-preview.1.20120.4 119 7/3/2022
3.1.32 118 2/21/2023
3.1.31 123 12/3/2022
3.1.30 126 12/3/2022
3.1.29 120 9/15/2022
3.1.28 120 9/3/2022
3.1.27 107 9/15/2022
3.1.26 117 7/3/2022
3.1.25 113 7/3/2022
3.1.24 124 7/3/2022
3.1.23 123 7/3/2022
3.1.22 121 7/3/2022
3.1.21 125 7/3/2022
3.1.20 127 7/3/2022
3.1.19 135 7/3/2022
3.1.18 127 7/3/2022
3.1.17 115 7/3/2022
3.1.16 143 7/3/2022
3.1.15 116 7/3/2022
3.1.14 116 7/3/2022
3.1.13 147 7/3/2022
3.1.12 134 7/3/2022
3.1.11 112 7/3/2022
3.1.10 130 7/3/2022
3.1.9 114 7/3/2022
3.1.8 118 7/3/2022
3.1.7 127 7/3/2022
3.1.6 129 7/3/2022
3.1.5 110 7/3/2022
3.1.4 118 7/3/2022
3.1.3 117 7/3/2022
3.1.2 136 7/3/2022
3.1.1 124 7/3/2022
3.1.0 119 7/3/2022
3.1.0-preview3.19553.2 119 7/3/2022
3.1.0-preview2.19525.4 116 7/3/2022
3.1.0-preview1.19506.1 118 7/3/2022
3.0.3 129 7/3/2022
3.0.2 118 7/3/2022
3.0.1 120 7/3/2022
3.0.0 126 6/13/2022
3.0.0-rc1.19456.10 121 7/3/2022
3.0.0-preview9.19423.4 109 7/3/2022
3.0.0-preview8.19405.4 120 7/3/2022
3.0.0-preview7.19362.4 120 7/3/2022
3.0.0-preview6.19304.6 99 7/3/2022
3.0.0-preview5.19227.9 121 7/3/2022
3.0.0-preview4.19216.2 127 7/3/2022
3.0.0-preview3.19153.1 113 7/3/2022
3.0.0-preview.19074.2 123 7/3/2022
3.0.0-preview.18572.1 121 7/3/2022
2.2.0 104 7/3/2022
2.2.0-preview3-35497 99 7/3/2022
2.2.0-preview2-35157 104 7/3/2022
2.2.0-preview1-35029 118 7/3/2022
2.1.1 124 7/3/2022
2.1.0 126 7/3/2022
2.1.0-rc1-final 120 7/3/2022
2.1.0-preview2-final 117 7/3/2022
2.1.0-preview1-final 123 7/3/2022
2.0.2 137 7/3/2022
2.0.1 118 7/3/2022
2.0.0 110 7/3/2022
2.0.0-preview2-final 112 7/3/2022
2.0.0-preview1-final 120 7/3/2022
1.1.2 120 7/3/2022
1.1.1 116 7/3/2022
1.1.0 113 7/3/2022
1.1.0-preview1-final 112 7/3/2022
1.0.2 120 7/3/2022
1.0.1 131 7/3/2022
1.0.0 108 7/3/2022
1.0.0-rc2-final 132 7/3/2022