Microsoft.Extensions.Options.ConfigurationExtensions 11.0.0-preview.3.26207.106

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
Microsoft.AspNetCore
 140
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.
 136
Microsoft.Extensions.Diagnostics
This package includes the default implementation of IMeterFactory and additional extension methods to easily register it with the Dependency Injection framework.
 140
Microsoft.Extensions.Diagnostics
This package includes the default implementation of IMeterFactory and additional extension methods to easily register it with the Dependency Injection framework.
 145
Microsoft.Extensions.Diagnostics
This package includes the default implementation of IMeterFactory and additional extension methods to easily register it with the Dependency Injection framework.
 151
Microsoft.Extensions.Diagnostics
This package includes the default implementation of IMeterFactory and additional extension methods to easily register it with the Dependency Injection framework.
 155
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 136
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 137
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 141
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 144
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 145
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 207
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
 138
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
 143
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
 144
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
 150
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
 237

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

.NET Framework 4.6.2

.NET Standard 2.0

.NET 11.0

.NET 10.0

Version Downloads Last updated
11.0.0-preview.3.26207.106 14 04/14/2026
11.0.0-preview.2.26159.112 18 03/11/2026
11.0.0-preview.1.26104.118 25 02/12/2026
10.0.7 11 04/21/2026
10.0.6 11 04/14/2026
10.0.5 15 03/12/2026
10.0.4 15 03/11/2026
10.0.3 23 02/12/2026
10.0.2 26 01/14/2026
10.0.1 51 12/10/2025
10.0.0 64 11/12/2025
10.0.0-rc.2.25502.107 76 10/14/2025
10.0.0-rc.1.25451.107 95 09/09/2025
10.0.0-preview.7.25380.108 94 08/14/2025
10.0.0-preview.6.25358.103 104 07/16/2025
10.0.0-preview.5.25277.114 110 06/07/2025
10.0.0-preview.4.25258.110 110 05/15/2025
10.0.0-preview.3.25171.5 130 04/11/2025
10.0.0-preview.2.25163.2 117 04/01/2025
10.0.0-preview.1.25080.5 111 03/30/2025
9.0.15 8 04/14/2026
9.0.14 15 03/11/2026
9.0.13 24 02/12/2026
9.0.12 26 01/14/2026
9.0.11 50 11/12/2025
9.0.10 67 10/14/2025
9.0.9 79 09/09/2025
9.0.8 79 08/06/2025
9.0.7 114 07/09/2025
9.0.6 80 06/13/2025
9.0.5 129 05/15/2025
9.0.4 108 04/09/2025
9.0.3 133 04/02/2025
9.0.2 100 04/02/2025
9.0.1 114 04/02/2025
9.0.0 106 11/14/2024
9.0.0-rc.2.24473.5 103 10/22/2024
9.0.0-rc.1.24431.7 102 09/19/2024
9.0.0-preview.7.24405.7 107 08/20/2024
9.0.0-preview.6.24327.7 124 07/19/2024
9.0.0-preview.5.24306.7 147 07/19/2024
9.0.0-preview.4.24266.19 156 07/19/2024
9.0.0-preview.3.24172.9 127 07/19/2024
9.0.0-preview.2.24128.5 121 07/19/2024
9.0.0-preview.1.24080.9 128 07/19/2024
8.0.0 138 02/13/2024
8.0.0-rc.2.23479.6 151 07/19/2024
8.0.0-rc.1.23419.4 139 07/19/2024
8.0.0-preview.7.23375.6 124 07/19/2024
8.0.0-preview.6.23329.7 127 07/19/2024
8.0.0-preview.5.23280.8 123 07/19/2024
8.0.0-preview.4.23259.5 149 07/19/2024
8.0.0-preview.3.23174.8 129 07/19/2024
8.0.0-preview.2.23128.3 137 07/19/2024
8.0.0-preview.1.23110.8 147 07/19/2024
7.0.0 127 07/19/2024
7.0.0-rc.2.22472.3 153 07/19/2024
7.0.0-rc.1.22426.10 130 07/19/2024
7.0.0-preview.7.22375.6 115 07/19/2024
7.0.0-preview.6.22324.4 125 07/19/2024
7.0.0-preview.5.22301.12 137 07/19/2024
7.0.0-preview.4.22229.4 138 07/19/2024
7.0.0-preview.3.22175.4 140 07/19/2024
7.0.0-preview.2.22152.2 141 07/19/2024
7.0.0-preview.1.22076.8 143 07/19/2024
6.0.2-mauipre.1.22102.15 109 12/04/2024
6.0.2-mauipre.1.22054.8 89 07/27/2025
6.0.1 114 11/14/2024
6.0.0 258 02/04/2024
6.0.0-rc.2.21480.5 131 07/19/2024
6.0.0-rc.1.21451.13 139 07/19/2024
6.0.0-preview.7.21377.19 151 07/19/2024
6.0.0-preview.6.21352.12 145 07/19/2024
6.0.0-preview.5.21301.5 147 07/19/2024
6.0.0-preview.4.21253.7 123 07/19/2024
6.0.0-preview.3.21201.4 138 07/19/2024
6.0.0-preview.2.21154.6 129 07/19/2024
6.0.0-preview.1.21102.12 140 07/19/2024
5.0.0 153 07/19/2024
5.0.0-rc.2.20475.5 142 07/19/2024
5.0.0-rc.1.20451.14 134 07/19/2024
5.0.0-preview.8.20407.11 121 07/19/2024
5.0.0-preview.7.20364.11 137 07/19/2024
5.0.0-preview.6.20305.6 133 07/19/2024
5.0.0-preview.5.20278.1 139 07/19/2024
5.0.0-preview.4.20251.6 134 07/19/2024
5.0.0-preview.3.20215.2 130 07/19/2024
5.0.0-preview.2.20160.3 137 07/19/2024
5.0.0-preview.1.20120.4 142 07/19/2024
3.1.32 123 07/19/2024
3.1.31 132 07/19/2024
3.1.30 117 07/19/2024
3.1.29 126 07/19/2024
3.1.28 139 07/19/2024
3.1.27 124 07/19/2024
3.1.26 136 07/19/2024
3.1.25 111 07/19/2024
3.1.24 120 07/19/2024
3.1.23 140 07/19/2024
3.1.22 114 07/19/2024
3.1.21 153 07/19/2024
3.1.20 153 07/19/2024
3.1.19 126 07/19/2024
3.1.18 148 07/19/2024
3.1.17 124 07/19/2024
3.1.16 122 07/19/2024
3.1.15 148 07/19/2024
3.1.14 138 07/19/2024
3.1.13 146 07/19/2024
3.1.12 134 07/19/2024
3.1.11 143 07/19/2024
3.1.10 118 07/19/2024
3.1.9 152 07/19/2024
3.1.8 130 07/19/2024
3.1.7 133 07/19/2024
3.1.6 131 07/19/2024
3.1.5 132 07/19/2024
3.1.4 161 07/19/2024
3.1.3 141 07/19/2024
3.1.2 123 07/19/2024
3.1.1 139 07/19/2024
3.1.0 143 07/19/2024
3.1.0-preview3.19553.2 127 07/19/2024
3.1.0-preview2.19525.4 129 07/19/2024
3.1.0-preview1.19506.1 125 07/19/2024
3.0.3 129 07/19/2024
3.0.2 130 07/19/2024
3.0.1 131 07/19/2024
3.0.0 156 07/19/2024
3.0.0-rc1.19456.10 139 07/19/2024
3.0.0-preview9.19423.4 121 07/19/2024
3.0.0-preview8.19405.4 126 07/19/2024
3.0.0-preview7.19362.4 129 07/19/2024
3.0.0-preview6.19304.6 126 07/19/2024
3.0.0-preview5.19227.9 123 07/19/2024
3.0.0-preview4.19216.2 126 07/19/2024
3.0.0-preview3.19153.1 131 07/19/2024
3.0.0-preview.19074.2 126 07/19/2024
3.0.0-preview.18572.1 123 07/19/2024
2.2.0 137 07/19/2024
2.2.0-preview3-35497 119 07/19/2024
2.2.0-preview2-35157 134 07/19/2024
2.2.0-preview1-35029 147 07/19/2024
2.1.1 144 07/19/2024
2.1.0 144 07/19/2024
2.1.0-rc1-final 118 07/19/2024
2.1.0-preview2-final 131 07/19/2024
2.1.0-preview1-final 130 07/19/2024
2.0.2 128 07/19/2024
2.0.1 124 07/19/2024
2.0.0 217 02/04/2024
2.0.0-preview2-final 132 07/19/2024
2.0.0-preview1-final 130 07/19/2024
1.1.2 115 07/19/2024
1.1.1 120 07/19/2024
1.1.0 135 07/19/2024
1.1.0-preview1-final 114 07/19/2024
1.0.2 130 07/19/2024
1.0.1 112 07/19/2024
1.0.0 130 07/19/2024
1.0.0-rc2-final 137 07/19/2024