Microsoft.Extensions.Options.ConfigurationExtensions 9.0.21

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.
 176
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.
 160
R4Mvc.Tools
R4Mvc is a tool that generates strongly typed helpers for ASP.NET Core MVC.
 160
R4Mvc.Tools
R4Mvc is a tool that generates strongly typed helpers for ASP.NET Core MVC.
 159
R4Mvc.Tools
R4Mvc is a tool that generates strongly typed helpers for ASP.NET Core MVC.
 157
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 156
R4Mvc.Tools
R4Mvc is a tool that generates strongly typed helpers for ASP.NET Core MVC.
 154
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.
 152
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 151
Microsoft.Extensions.Logging.Console
Console logger provider implementation for Microsoft.Extensions.Logging.
 150
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 148
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 147
R4Mvc.Tools
R4Mvc is a tool that generates strongly typed helpers for ASP.NET Core MVC.
 147
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 146
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.
 146
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 145
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 144
R4Mvc.Tools
R4Mvc is a tool that generates strongly typed helpers for ASP.NET Core MVC.
 144
Microsoft.Extensions.Logging.Console
Console logger provider implementation for Microsoft.Extensions.Logging.
 144
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
 144

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

.NET Framework 4.6.2

.NET 8.0

.NET 9.0

.NET Standard 2.0

Version Downloads Last updated
11.0.0-rc.3.26522.148 4 10/27/2026
11.0.0-rc.2.26504.105 7 10/14/2026
11.0.0-rc.1.26425.128 10 9/9/2026
11.0.0-preview.7.26381.103 19 8/13/2026
11.0.0-preview.6.26359.118 28 7/14/2026
11.0.0-preview.5.26302.115 25 6/10/2026
11.0.0-preview.4.26230.115 35 5/12/2026
11.0.0-preview.3.26207.106 38 5/4/2026
11.0.0-preview.2.26159.112 34 3/12/2026
11.0.0-preview.1.26104.118 40 2/14/2026
10.0.14 3 10/27/2026
10.0.13 7 10/14/2026
10.0.12 11 9/9/2026
10.0.11 18 8/13/2026
10.0.10 24 7/14/2026
10.0.9 26 6/10/2026
10.0.8 31 5/12/2026
10.0.7 41 5/4/2026
10.0.6 34 5/4/2026
10.0.5 39 3/14/2026
10.0.4 39 3/12/2026
10.0.3 38 2/14/2026
10.0.2 41 1/13/2026
10.0.1 53 12/11/2025
10.0.0 65 11/11/2025
10.0.0-rc.2.25502.107 80 10/17/2025
10.0.0-rc.1.25451.107 90 9/10/2025
10.0.0-preview.7.25380.108 98 8/15/2025
10.0.0-preview.6.25358.103 91 7/15/2025
10.0.0-preview.5.25277.114 98 6/8/2025
10.0.0-preview.4.25258.110 111 5/16/2025
10.0.0-preview.3.25171.5 109 4/14/2025
10.0.0-preview.2.25163.2 104 3/27/2025
10.0.0-preview.1.25080.5 126 2/27/2025
9.0.22 3 10/27/2026
9.0.21 7 10/14/2026
9.0.20 16 9/10/2026
9.0.19 21 8/13/2026
9.0.18 26 7/14/2026
9.0.17 27 6/10/2026
9.0.16 36 5/12/2026
9.0.15 38 5/4/2026
9.0.14 45 3/12/2026
9.0.13 44 2/14/2026
9.0.12 42 1/13/2026
9.0.11 69 11/11/2025
9.0.10 88 10/17/2025
9.0.9 93 9/10/2025
9.0.8 100 8/6/2025
9.0.7 85 7/8/2025
9.0.6 113 6/12/2025
9.0.5 97 5/17/2025
9.0.4 98 4/9/2025
9.0.3 106 3/11/2025
9.0.2 109 2/13/2025
9.0.1 121 1/18/2025
9.0.0 122 11/17/2024
9.0.0-rc.2.24473.5 116 10/19/2024
9.0.0-rc.1.24431.7 115 9/11/2024
9.0.0-preview.7.24405.7 109 8/14/2024
9.0.0-preview.6.24327.7 131 7/11/2024
9.0.0-preview.5.24306.7 134 6/13/2024
9.0.0-preview.4.24266.19 127 5/29/2024
9.0.0-preview.3.24172.9 124 4/13/2024
9.0.0-preview.2.24128.5 142 3/21/2024
9.0.0-preview.1.24080.9 142 2/29/2024
8.0.0 153 11/16/2023
8.0.0-rc.2.23479.6 161 10/14/2023
8.0.0-rc.1.23419.4 166 9/17/2023
8.0.0-preview.7.23375.6 157 8/23/2023
8.0.0-preview.6.23329.7 143 7/31/2023
8.0.0-preview.5.23280.8 149 7/31/2023
8.0.0-preview.4.23259.5 139 5/20/2023
8.0.0-preview.3.23174.8 122 5/12/2023
8.0.0-preview.2.23128.3 150 5/12/2023
8.0.0-preview.1.23110.8 141 2/23/2023
7.0.0 142 12/3/2022
7.0.0-rc.2.22472.3 136 12/3/2022
7.0.0-rc.1.22426.10 153 9/15/2022
7.0.0-preview.7.22375.6 140 9/15/2022
7.0.0-preview.6.22324.4 140 9/15/2022
7.0.0-preview.5.22301.12 132 6/26/2022
7.0.0-preview.4.22229.4 128 7/3/2022
7.0.0-preview.3.22175.4 142 7/3/2022
7.0.0-preview.2.22152.2 129 7/3/2022
7.0.0-preview.1.22076.8 140 7/3/2022
6.0.2-mauipre.1.22102.15 134 7/3/2022
6.0.2-mauipre.1.22054.8 155 7/3/2022
6.0.1 121 11/18/2024
6.0.0 156 7/3/2022
6.0.0-rc.2.21480.5 158 7/3/2022
6.0.0-rc.1.21451.13 153 7/3/2022
6.0.0-preview.7.21377.19 167 7/3/2022
6.0.0-preview.6.21352.12 156 7/3/2022
6.0.0-preview.5.21301.5 148 7/3/2022
6.0.0-preview.4.21253.7 135 7/3/2022
6.0.0-preview.3.21201.4 161 7/3/2022
6.0.0-preview.2.21154.6 149 7/3/2022
6.0.0-preview.1.21102.12 152 7/3/2022
5.0.0 141 7/3/2022
5.0.0-rc.2.20475.5 136 7/3/2022
5.0.0-rc.1.20451.14 147 7/3/2022
5.0.0-preview.8.20407.11 145 7/3/2022
5.0.0-preview.7.20364.11 155 7/3/2022
5.0.0-preview.6.20305.6 132 7/3/2022
5.0.0-preview.5.20278.1 132 7/3/2022
5.0.0-preview.4.20251.6 160 7/3/2022
5.0.0-preview.3.20215.2 150 7/3/2022
5.0.0-preview.2.20160.3 133 7/3/2022
5.0.0-preview.1.20120.4 146 7/3/2022
3.1.32 151 2/21/2023
3.1.31 149 12/3/2022
3.1.30 155 12/3/2022
3.1.29 151 9/15/2022
3.1.28 145 9/3/2022
3.1.27 134 9/15/2022
3.1.26 143 7/3/2022
3.1.25 144 7/3/2022
3.1.24 151 7/3/2022
3.1.23 155 7/3/2022
3.1.22 147 7/3/2022
3.1.21 152 7/3/2022
3.1.20 154 7/3/2022
3.1.19 165 7/3/2022
3.1.18 154 7/3/2022
3.1.17 140 7/3/2022
3.1.16 168 7/3/2022
3.1.15 143 7/3/2022
3.1.14 142 7/3/2022
3.1.13 177 7/3/2022
3.1.12 160 7/3/2022
3.1.11 141 7/3/2022
3.1.10 158 7/3/2022
3.1.9 142 7/3/2022
3.1.8 151 7/3/2022
3.1.7 158 7/3/2022
3.1.6 156 7/3/2022
3.1.5 134 7/3/2022
3.1.4 144 7/3/2022
3.1.3 148 7/3/2022
3.1.2 167 7/3/2022
3.1.1 152 7/3/2022
3.1.0 148 7/3/2022
3.1.0-preview3.19553.2 148 7/3/2022
3.1.0-preview2.19525.4 141 7/3/2022
3.1.0-preview1.19506.1 144 7/3/2022
3.0.3 161 7/3/2022
3.0.2 142 7/3/2022
3.0.1 147 7/3/2022
3.0.0 153 6/13/2022
3.0.0-rc1.19456.10 144 7/3/2022
3.0.0-preview9.19423.4 136 7/3/2022
3.0.0-preview8.19405.4 145 7/3/2022
3.0.0-preview7.19362.4 144 7/3/2022
3.0.0-preview6.19304.6 125 7/3/2022
3.0.0-preview5.19227.9 147 7/3/2022
3.0.0-preview4.19216.2 155 7/3/2022
3.0.0-preview3.19153.1 138 7/3/2022
3.0.0-preview.19074.2 147 7/3/2022
3.0.0-preview.18572.1 148 7/3/2022
2.2.0 131 7/3/2022
2.2.0-preview3-35497 125 7/3/2022
2.2.0-preview2-35157 131 7/3/2022
2.2.0-preview1-35029 145 7/3/2022
2.1.1 152 7/3/2022
2.1.0 152 7/3/2022
2.1.0-rc1-final 147 7/3/2022
2.1.0-preview2-final 144 7/3/2022
2.1.0-preview1-final 149 7/3/2022
2.0.2 164 7/3/2022
2.0.1 143 7/3/2022
2.0.0 138 7/3/2022
2.0.0-preview2-final 139 7/3/2022
2.0.0-preview1-final 146 7/3/2022
1.1.2 150 7/3/2022
1.1.1 142 7/3/2022
1.1.0 147 7/3/2022
1.1.0-preview1-final 142 7/3/2022
1.0.2 148 7/3/2022
1.0.1 157 7/3/2022
1.0.0 134 7/3/2022
1.0.0-rc2-final 164 7/3/2022