Microsoft.Extensions.Options.ConfigurationExtensions 10.0.2
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:
ConfigurationChangeTokenSourceOptionsBuilderConfigurationExtensionsOptionsConfigurationServiceCollectionExtensions
Additional Documentation
Related Packages
- Microsoft.Extensions.Options
- Microsoft.Extensions.Configuration
- Microsoft.Extensions.DependencyInjection
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.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
|
11 |
|
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
|
10 |
|
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
|
9 |
|
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
|
8 |
|
Microsoft.Extensions.Diagnostics
This package includes the default implementation of IMeterFactory and additional extension methods to easily register it with the Dependency Injection framework.
|
8 |
|
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.
|
7 |
|
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
|
7 |
.NET Framework 4.6.2
- Microsoft.Extensions.Configuration.Abstractions (>= 10.0.2)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.2)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.2)
- Microsoft.Extensions.Options (>= 10.0.2)
- Microsoft.Extensions.Primitives (>= 10.0.2)
.NET 8.0
- Microsoft.Extensions.Configuration.Abstractions (>= 10.0.2)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.2)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.2)
- Microsoft.Extensions.Options (>= 10.0.2)
- Microsoft.Extensions.Primitives (>= 10.0.2)
.NET 9.0
- Microsoft.Extensions.Configuration.Abstractions (>= 10.0.2)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.2)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.2)
- Microsoft.Extensions.Options (>= 10.0.2)
- Microsoft.Extensions.Primitives (>= 10.0.2)
.NET 10.0
- Microsoft.Extensions.Configuration.Abstractions (>= 10.0.2)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.2)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.2)
- Microsoft.Extensions.Options (>= 10.0.2)
- Microsoft.Extensions.Primitives (>= 10.0.2)
.NET Standard 2.0
- Microsoft.Extensions.Configuration.Abstractions (>= 10.0.2)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.2)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.2)
- Microsoft.Extensions.Options (>= 10.0.2)
- Microsoft.Extensions.Primitives (>= 10.0.2)
| Version | Downloads | Last updated |
|---|---|---|
| 10.0.2 | 1 | 01/16/2026 |
| 10.0.1 | 0 | 12/09/2025 |
| 10.0.0 | 1 | 01/16/2026 |
| 10.0.0-rc.2.25502.107 | 0 | 10/14/2025 |
| 10.0.0-rc.1.25451.107 | 0 | 09/09/2025 |
| 10.0.0-preview.7.25380.108 | 2 | 09/15/2025 |
| 10.0.0-preview.6.25358.103 | 2 | 09/15/2025 |
| 10.0.0-preview.5.25277.114 | 3 | 06/24/2025 |
| 10.0.0-preview.4.25258.110 | 2 | 05/30/2025 |
| 10.0.0-preview.3.25171.5 | 2 | 05/31/2025 |
| 10.0.0-preview.2.25163.2 | 2 | 05/31/2025 |
| 10.0.0-preview.1.25080.5 | 3 | 02/27/2025 |
| 9.0.12 | 1 | 01/16/2026 |
| 9.0.11 | 0 | 11/11/2025 |
| 9.0.10 | 0 | 10/14/2025 |
| 9.0.9 | 0 | 09/09/2025 |
| 9.0.8 | 0 | 08/04/2025 |
| 9.0.7 | 0 | 07/08/2025 |
| 9.0.6 | 2 | 06/24/2025 |
| 9.0.5 | 1 | 05/30/2025 |
| 9.0.4 | 2 | 05/30/2025 |
| 9.0.3 | 3 | 03/11/2025 |
| 9.0.2 | 1 | 05/30/2025 |
| 9.0.1 | 1 | 05/30/2025 |
| 9.0.0 | 1 | 05/30/2025 |
| 9.0.0-rc.2.24473.5 | 6 | 02/18/2025 |
| 9.0.0-rc.1.24431.7 | 6 | 02/18/2025 |
| 9.0.0-preview.7.24405.7 | 2 | 05/31/2025 |
| 9.0.0-preview.6.24327.7 | 2 | 05/31/2025 |
| 9.0.0-preview.5.24306.7 | 2 | 05/31/2025 |
| 9.0.0-preview.4.24266.19 | 3 | 02/27/2025 |
| 9.0.0-preview.3.24172.9 | 2 | 05/31/2025 |
| 9.0.0-preview.2.24128.5 | 2 | 05/31/2025 |
| 9.0.0-preview.1.24080.9 | 2 | 05/31/2025 |
| 8.0.0 | 6 | 05/30/2025 |
| 8.0.0-rc.2.23479.6 | 6 | 02/18/2025 |
| 8.0.0-rc.1.23419.4 | 8 | 02/18/2025 |
| 8.0.0-preview.7.23375.6 | 2 | 05/31/2025 |
| 8.0.0-preview.6.23329.7 | 2 | 05/31/2025 |
| 8.0.0-preview.5.23280.8 | 2 | 02/27/2025 |
| 8.0.0-preview.4.23259.5 | 2 | 05/31/2025 |
| 8.0.0-preview.3.23174.8 | 2 | 05/31/2025 |
| 8.0.0-preview.2.23128.3 | 3 | 05/31/2025 |
| 8.0.0-preview.1.23110.8 | 1 | 07/11/2025 |
| 7.0.0 | 2 | 05/30/2025 |
| 7.0.0-rc.2.22472.3 | 6 | 02/18/2025 |
| 7.0.0-rc.1.22426.10 | 4 | 02/18/2025 |
| 7.0.0-preview.7.22375.6 | 2 | 05/31/2025 |
| 7.0.0-preview.6.22324.4 | 2 | 05/31/2025 |
| 7.0.0-preview.5.22301.12 | 2 | 05/31/2025 |
| 7.0.0-preview.4.22229.4 | 1 | 07/11/2025 |
| 7.0.0-preview.3.22175.4 | 2 | 05/31/2025 |
| 7.0.0-preview.2.22152.2 | 3 | 07/11/2025 |
| 7.0.0-preview.1.22076.8 | 2 | 05/31/2025 |
| 6.0.1 | 2 | 05/30/2025 |
| 6.0.0 | 1 | 05/30/2025 |
| 6.0.0-rc.2.21480.5 | 6 | 02/18/2025 |
| 6.0.0-rc.1.21451.13 | 4 | 02/18/2025 |
| 6.0.0-preview.7.21377.19 | 2 | 05/31/2025 |
| 6.0.0-preview.6.21352.12 | 2 | 05/31/2025 |
| 6.0.0-preview.5.21301.5 | 2 | 05/31/2025 |
| 6.0.0-preview.4.21253.7 | 2 | 05/31/2025 |
| 6.0.0-preview.3.21201.4 | 3 | 05/31/2025 |
| 6.0.0-preview.2.21154.6 | 3 | 05/31/2025 |
| 6.0.0-preview.1.21102.12 | 3 | 02/18/2025 |
| 5.0.0 | 2 | 05/30/2025 |
| 5.0.0-rc.2.20475.5 | 6 | 02/18/2025 |
| 5.0.0-rc.1.20451.14 | 4 | 02/18/2025 |
| 5.0.0-preview.8.20407.11 | 2 | 05/31/2025 |
| 5.0.0-preview.7.20364.11 | 2 | 05/31/2025 |
| 5.0.0-preview.6.20305.6 | 2 | 07/11/2025 |
| 5.0.0-preview.5.20278.1 | 2 | 05/31/2025 |
| 5.0.0-preview.4.20251.6 | 2 | 05/31/2025 |
| 5.0.0-preview.3.20215.2 | 1 | 07/11/2025 |
| 5.0.0-preview.2.20160.3 | 3 | 05/31/2025 |
| 5.0.0-preview.1.20120.4 | 3 | 05/31/2025 |
| 3.1.32 | 4 | 02/18/2025 |
| 3.1.31 | 4 | 02/18/2025 |
| 3.1.30 | 5 | 02/18/2025 |
| 3.1.29 | 4 | 02/18/2025 |
| 3.1.28 | 5 | 02/18/2025 |
| 3.1.27 | 4 | 02/18/2025 |
| 3.1.26 | 4 | 02/18/2025 |
| 3.1.25 | 4 | 02/18/2025 |
| 3.1.24 | 4 | 02/18/2025 |
| 3.1.23 | 4 | 02/18/2025 |
| 3.1.22 | 4 | 02/18/2025 |
| 3.1.21 | 4 | 02/18/2025 |
| 3.1.20 | 5 | 02/18/2025 |
| 3.1.19 | 5 | 02/18/2025 |
| 3.1.18 | 4 | 02/18/2025 |
| 3.1.17 | 4 | 02/18/2025 |
| 3.1.16 | 5 | 02/18/2025 |
| 3.1.15 | 5 | 02/18/2025 |
| 3.1.14 | 5 | 02/18/2025 |
| 3.1.13 | 5 | 02/18/2025 |
| 3.1.12 | 4 | 02/18/2025 |
| 3.1.11 | 5 | 02/18/2025 |
| 3.1.10 | 4 | 02/18/2025 |
| 3.1.9 | 1 | 05/30/2025 |
| 3.1.8 | 2 | 05/30/2025 |
| 3.1.7 | 3 | 02/27/2025 |
| 3.1.6 | 3 | 05/30/2025 |
| 3.1.5 | 3 | 02/27/2025 |
| 3.1.4 | 1 | 05/30/2025 |
| 3.1.3 | 1 | 05/30/2025 |
| 3.1.2 | 2 | 05/30/2025 |
| 3.1.1 | 1 | 05/30/2025 |
| 3.1.0 | 1 | 05/30/2025 |
| 3.1.0-preview3.19553.2 | 3 | 05/30/2025 |
| 3.1.0-preview2.19525.4 | 2 | 05/30/2025 |
| 3.1.0-preview1.19506.1 | 2 | 05/30/2025 |
| 3.0.3 | 1 | 05/30/2025 |
| 3.0.2 | 1 | 05/30/2025 |
| 3.0.1 | 1 | 05/30/2025 |
| 3.0.0 | 2 | 05/30/2025 |
| 3.0.0-rc1.19456.10 | 2 | 05/31/2025 |
| 3.0.0-preview9.19423.4 | 2 | 05/30/2025 |
| 3.0.0-preview8.19405.4 | 3 | 05/30/2025 |
| 3.0.0-preview7.19362.4 | 2 | 05/30/2025 |
| 3.0.0-preview6.19304.6 | 2 | 05/30/2025 |
| 3.0.0-preview5.19227.9 | 3 | 02/27/2025 |
| 3.0.0-preview4.19216.2 | 2 | 05/30/2025 |
| 3.0.0-preview3.19153.1 | 3 | 05/30/2025 |
| 3.0.0-preview.19074.2 | 2 | 05/30/2025 |
| 3.0.0-preview.18572.1 | 2 | 05/30/2025 |
| 2.2.0 | 2 | 05/30/2025 |
| 2.2.0-preview3-35497 | 2 | 05/30/2025 |
| 2.2.0-preview2-35157 | 4 | 05/30/2025 |
| 2.2.0-preview1-35029 | 2 | 05/30/2025 |
| 2.1.1 | 3 | 02/27/2025 |
| 2.1.0 | 6 | 01/14/2025 |
| 2.1.0-rc1-final | 1 | 05/30/2025 |
| 2.1.0-preview2-final | 5 | 02/27/2025 |
| 2.1.0-preview1-final | 1 | 05/30/2025 |
| 2.0.2 | 2 | 05/30/2025 |
| 2.0.1 | 1 | 05/30/2025 |
| 2.0.0 | 4 | 02/27/2025 |
| 2.0.0-preview2-final | 2 | 05/30/2025 |
| 2.0.0-preview1-final | 1 | 05/30/2025 |
| 1.1.2 | 1 | 05/30/2025 |
| 1.1.1 | 3 | 02/27/2025 |
| 1.1.0 | 2 | 05/30/2025 |
| 1.1.0-preview1-final | 1 | 05/30/2025 |
| 1.0.2 | 2 | 05/30/2025 |
| 1.0.1 | 1 | 05/30/2025 |
| 1.0.0 | 1 | 05/30/2025 |
| 1.0.0-rc2-final | 1 | 05/30/2025 |