Microsoft.Extensions.Options.ConfigurationExtensions 10.0.0
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.Diagnostics
This package includes the default implementation of IMeterFactory and additional extension methods to easily register it with the Dependency Injection framework.
|
379 |
|
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
|
56 |
|
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
|
68 |
|
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
|
240 |
|
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
|
5,511 |
|
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
|
9,178 |
|
nacos-sdk-csharp
nacos csharp sdk
|
81 |
|
nacos-sdk-csharp
nacos csharp sdk
|
118 |
|
nacos-sdk-csharp
nacos csharp sdk
|
132 |
|
nacos-sdk-csharp
nacos csharp sdk
|
521 |
|
ZhonTai.Common
中台通用库
|
54 |
|
ZhonTai.Common
中台通用库
|
55 |
|
ZhonTai.Common
中台通用库
|
56 |
|
ZhonTai.Common
中台通用库
|
57 |
|
ZhonTai.Common
中台通用库
|
58 |
https://go.microsoft.com/fwlink/?LinkID=799421
.NET Framework 4.6.2
- Microsoft.Extensions.Configuration.Abstractions (>= 10.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.0)
- Microsoft.Extensions.Options (>= 10.0.0)
- Microsoft.Extensions.Primitives (>= 10.0.0)
.NET Standard 2.0
- Microsoft.Extensions.Primitives (>= 10.0.0)
- Microsoft.Extensions.Options (>= 10.0.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.0)
- Microsoft.Extensions.Configuration.Abstractions (>= 10.0.0)
.NET 10.0
- Microsoft.Extensions.Primitives (>= 10.0.0)
- Microsoft.Extensions.Options (>= 10.0.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.0)
- Microsoft.Extensions.Configuration.Abstractions (>= 10.0.0)
.NET 9.0
- Microsoft.Extensions.Primitives (>= 10.0.0)
- Microsoft.Extensions.Options (>= 10.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.0)
- Microsoft.Extensions.Configuration.Abstractions (>= 10.0.0)
.NET 8.0
- Microsoft.Extensions.Configuration.Abstractions (>= 10.0.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.0)
- Microsoft.Extensions.Options (>= 10.0.0)
- Microsoft.Extensions.Primitives (>= 10.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.0)
| Version | Downloads | Last updated |
|---|---|---|
| 10.0.0 | 8 | 11/13/2025 |
| 10.0.0-rc.2.25502.107 | 13 | 10/14/2025 |
| 10.0.0-rc.1.25451.107 | 17 | 09/11/2025 |
| 10.0.0-preview.7.25380.108 | 11 | 08/14/2025 |
| 10.0.0-preview.6.25358.103 | 12 | 07/17/2025 |
| 10.0.0-preview.5.25277.114 | 15 | 06/08/2025 |
| 10.0.0-preview.4.25258.110 | 28 | 05/15/2025 |
| 10.0.0-preview.3.25171.5 | 20 | 04/15/2025 |
| 10.0.0-preview.2.25163.2 | 20 | 03/28/2025 |
| 10.0.0-preview.1.25080.5 | 20 | 03/12/2025 |
| 9.0.11 | 7 | 11/14/2025 |
| 9.0.10 | 10 | 10/14/2025 |
| 9.0.9 | 13 | 09/11/2025 |
| 9.0.8 | 16 | 08/08/2025 |
| 9.0.7 | 16 | 07/09/2025 |
| 9.0.6 | 18 | 06/14/2025 |
| 9.0.5 | 22 | 05/16/2025 |
| 9.0.4 | 25 | 04/16/2025 |
| 9.0.3 | 21 | 03/15/2025 |
| 9.0.2 | 25 | 02/18/2025 |
| 9.0.1 | 29 | 01/24/2025 |
| 9.0.0 | 37 | 11/29/2024 |
| 9.0.0-rc.2.24473.5 | 29 | 11/29/2024 |
| 9.0.0-rc.1.24431.7 | 22 | 12/04/2024 |
| 9.0.0-preview.7.24405.7 | 25 | 12/02/2024 |
| 9.0.0-preview.6.24327.7 | 25 | 12/08/2024 |
| 9.0.0-preview.5.24306.7 | 26 | 12/04/2024 |
| 9.0.0-preview.4.24266.19 | 25 | 12/09/2024 |
| 9.0.0-preview.3.24172.9 | 42 | 05/09/2024 |
| 9.0.0-preview.2.24128.5 | 37 | 04/30/2024 |
| 9.0.0-preview.1.24080.9 | 27 | 05/02/2024 |
| 8.0.0 | 215 | 12/18/2023 |
| 8.0.0-rc.2.23479.6 | 30 | 05/18/2024 |
| 8.0.0-rc.1.23419.4 | 30 | 05/06/2024 |
| 8.0.0-preview.7.23375.6 | 24 | 12/08/2024 |
| 8.0.0-preview.6.23329.7 | 43 | 08/08/2023 |
| 8.0.0-preview.5.23280.8 | 22 | 12/07/2024 |
| 8.0.0-preview.4.23259.5 | 26 | 05/20/2024 |
| 8.0.0-preview.3.23174.8 | 33 | 05/02/2024 |
| 8.0.0-preview.2.23128.3 | 32 | 05/02/2024 |
| 8.0.0-preview.1.23110.8 | 25 | 05/09/2024 |
| 7.0.0 | 53 | 09/08/2023 |
| 7.0.0-rc.2.22472.3 | 29 | 05/09/2024 |
| 7.0.0-rc.1.22426.10 | 29 | 05/08/2024 |
| 7.0.0-preview.7.22375.6 | 29 | 05/16/2024 |
| 7.0.0-preview.6.22324.4 | 28 | 05/09/2024 |
| 7.0.0-preview.5.22301.12 | 30 | 05/18/2024 |
| 7.0.0-preview.4.22229.4 | 28 | 12/01/2024 |
| 7.0.0-preview.3.22175.4 | 27 | 05/17/2024 |
| 7.0.0-preview.2.22152.2 | 27 | 05/04/2024 |
| 7.0.0-preview.1.22076.8 | 27 | 12/02/2024 |
| 6.0.1 | 27 | 12/02/2024 |
| 6.0.0 | 302 | 07/01/2022 |
| 6.0.0-rc.2.21480.5 | 33 | 05/03/2024 |
| 6.0.0-rc.1.21451.13 | 30 | 05/22/2024 |
| 6.0.0-preview.7.21377.19 | 25 | 12/11/2024 |
| 6.0.0-preview.6.21352.12 | 27 | 12/04/2024 |
| 6.0.0-preview.5.21301.5 | 33 | 05/08/2024 |
| 6.0.0-preview.4.21253.7 | 28 | 05/26/2024 |
| 6.0.0-preview.3.21201.4 | 26 | 12/10/2024 |
| 6.0.0-preview.2.21154.6 | 32 | 05/04/2024 |
| 6.0.0-preview.1.21102.12 | 28 | 12/04/2024 |
| 5.0.0-rc.2.20475.5 | 32 | 05/02/2024 |
| 5.0.0-rc.1.20451.14 | 30 | 05/19/2024 |
| 5.0.0-preview.8.20407.11 | 28 | 05/04/2024 |
| 5.0.0-preview.6.20305.6 | 24 | 12/02/2024 |
| 5.0.0-preview.5.20278.1 | 37 | 05/11/2024 |
| 5.0.0-preview.4.20251.6 | 28 | 12/06/2024 |
| 5.0.0-preview.3.20215.2 | 29 | 05/05/2024 |
| 5.0.0-preview.1.20120.4 | 31 | 05/24/2024 |
| 3.1.32 | 9,146 | 05/12/2023 |
| 3.1.31 | 27 | 05/20/2024 |
| 3.1.30 | 5,482 | 11/03/2022 |
| 3.1.29 | 33 | 05/09/2024 |
| 3.1.28 | 33 | 05/27/2024 |
| 3.1.27 | 28 | 05/27/2024 |
| 3.1.26 | 29 | 05/09/2024 |
| 3.1.25 | 21 | 05/01/2024 |
| 3.1.23 | 41 | 06/08/2023 |
| 3.1.22 | 23 | 12/04/2024 |
| 3.1.19 | 25 | 07/07/2022 |
| 3.1.18 | 31 | 05/05/2024 |
| 3.1.17 | 30 | 05/05/2024 |
| 3.1.16 | 37 | 06/22/2022 |
| 3.1.14 | 29 | 05/11/2024 |
| 3.1.11 | 30 | 05/15/2024 |
| 3.1.7 | 25 | 12/04/2024 |
| 3.1.5 | 32 | 05/25/2024 |
| 3.1.4 | 30 | 12/01/2024 |
| 3.1.3 | 29 | 05/05/2024 |
| 3.1.1 | 26 | 05/06/2024 |
| 3.1.0-preview3.19553.2 | 36 | 11/04/2022 |
| 3.1.0-preview2.19525.4 | 24 | 12/02/2024 |
| 3.1.0-preview1.19506.1 | 28 | 12/02/2024 |
| 3.0.3 | 29 | 12/02/2024 |
| 3.0.0-rc1.19456.10 | 28 | 05/14/2024 |
| 3.0.0-preview9.19423.4 | 25 | 05/10/2024 |
| 3.0.0-preview8.19405.4 | 30 | 12/01/2024 |
| 3.0.0-preview5.19227.9 | 25 | 12/08/2024 |
| 3.0.0-preview3.19153.1 | 30 | 12/02/2024 |
| 3.0.0-preview.19074.2 | 29 | 05/01/2024 |
| 3.0.0-preview.18572.1 | 28 | 05/10/2024 |
| 2.2.0-preview3-35497 | 35 | 05/02/2024 |
| 2.2.0-preview2-35157 | 30 | 05/15/2024 |
| 2.2.0-preview1-35029 | 30 | 05/14/2024 |
| 2.1.1 | 33 | 01/31/2024 |
| 2.1.0 | 30 | 01/04/2024 |
| 2.1.0-rc1-final | 32 | 05/16/2024 |
| 2.1.0-preview2-final | 37 | 05/12/2024 |
| 2.1.0-preview1-final | 27 | 12/02/2024 |
| 2.0.2 | 29 | 05/26/2024 |
| 2.0.1 | 27 | 05/21/2024 |
| 2.0.0-preview2-final | 28 | 05/02/2024 |
| 1.1.2 | 28 | 05/24/2024 |
| 1.1.1 | 29 | 05/22/2024 |
| 1.1.0 | 25 | 05/02/2024 |
| 1.1.0-preview1-final | 30 | 05/07/2024 |
| 1.0.2 | 28 | 05/01/2024 |
| 1.0.0 | 29 | 05/21/2024 |
| 1.0.0-rc2-final | 39 | 05/01/2024 |