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
 135
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.
 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.
 135
Microsoft.Extensions.Diagnostics
This package includes the default implementation of IMeterFactory and additional extension methods to easily register it with the Dependency Injection framework.
 135
Microsoft.Extensions.Diagnostics
This package includes the default implementation of IMeterFactory and additional extension methods to easily register it with the Dependency Injection framework.
 143
Microsoft.Extensions.Diagnostics
This package includes the default implementation of IMeterFactory and additional extension methods to easily register it with the Dependency Injection framework.
 147
Microsoft.Extensions.Diagnostics
This package includes the default implementation of IMeterFactory and additional extension methods to easily register it with the Dependency Injection framework.
 153
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 132
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 133
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 134
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.
 203
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging. When using NuGet 3.x this package requires at least version 3.4.
 132
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
 136
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
 142
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
 148
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
 235

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