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

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
 133
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.
 131
Microsoft.Extensions.Diagnostics
This package includes the default implementation of IMeterFactory and additional extension methods to easily register it with the Dependency Injection framework.
 128
Microsoft.Extensions.Diagnostics
This package includes the default implementation of IMeterFactory and additional extension methods to easily register it with the Dependency Injection framework.
 131
Microsoft.Extensions.Diagnostics
This package includes the default implementation of IMeterFactory and additional extension methods to easily register it with the Dependency Injection framework.
 141
Microsoft.Extensions.Diagnostics
This package includes the default implementation of IMeterFactory and additional extension methods to easily register it with the Dependency Injection framework.
 144
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.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 129
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 130
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 131
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 134
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 136
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 139
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 200
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging. When using NuGet 3.x this package requires at least version 3.4.
 129
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
 130
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
 139
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
 140
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
 145
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
 233

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