Microsoft.Extensions.Options.ConfigurationExtensions
10.0.0
Prefix Reserved
.NET 8.0
This package targets .NET 8.0. The package is compatible with this framework or higher.
.NET Standard 2.0
This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
.NET Framework 4.6.2
This package targets .NET Framework 4.6.2. The package is compatible with this framework or higher.
dotnet add package Microsoft.Extensions.Options.ConfigurationExtensions --version 10.0.0
NuGet\Install-Package Microsoft.Extensions.Options.ConfigurationExtensions -Version 10.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="10.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="10.0.0" />
<PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Microsoft.Extensions.Options.ConfigurationExtensions --version 10.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Microsoft.Extensions.Options.ConfigurationExtensions, 10.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Microsoft.Extensions.Options.ConfigurationExtensions@10.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Microsoft.Extensions.Options.ConfigurationExtensions&version=10.0.0
#tool nuget:?package=Microsoft.Extensions.Options.ConfigurationExtensions&version=10.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
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<TOptions> 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.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 is compatible. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETFramework 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)
-
.NETStandard 2.0
- 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)
-
net10.0
- 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)
-
net8.0
- 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)
-
net9.0
- 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)
NuGet packages (4.7K)
Showing the top 5 NuGet packages that depend on Microsoft.Extensions.Options.ConfigurationExtensions:
| Package | Downloads |
|---|---|
|
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging. |
|
|
Microsoft.Extensions.Diagnostics
This package includes the default implementation of IMeterFactory and additional extension methods to easily register it with the Dependency Injection framework. |
|
|
Microsoft.Identity.Web.TokenAcquisition
Implementation for higher level API for confidential client applications (ASP.NET Core and SDK/.NET). |
|
|
Microsoft.Extensions.AmbientMetadata.Application
Runtime information provider for application-level ambient metadata. |
|
|
Microsoft.Extensions.Resilience
Extensions to the Polly libraries to enrich telemetry with metadata and exception summaries. |
GitHub repositories (298)
Showing the top 20 popular GitHub repositories that depend on Microsoft.Extensions.Options.ConfigurationExtensions:
| Repository | Stars |
|---|---|
|
ardalis/CleanArchitecture
Clean Architecture Solution Template: A proven Clean Architecture Template for ASP.NET Core 10
|
|
|
App-vNext/Polly
Polly is a .NET resilience and transient-fault-handling library that allows developers to express policies such as Retry, Circuit Breaker, Timeout, Bulkhead Isolation, and Fallback in a fluent and thread-safe manner. From version 6.0.1, Polly targets .NET Standard 1.1 and 2.0+.
|
|
|
abpframework/abp
Open-source web application framework for ASP.NET Core! Offers an opinionated architecture to build enterprise software solutions with best practices on top of the .NET. Provides the fundamental infrastructure, cross-cutting-concern implementations, startup templates, application modules, UI themes, tooling and documentation.
|
|
|
dotnet/AspNetCore.Docs
Documentation for ASP.NET Core
|
|
|
chocolatey/choco
Chocolatey - the package manager for Windows
|
|
|
dotnet/orleans
Cloud Native application framework for .NET
|
|
|
JeffreySu/WeiXinMPSDK
微信全平台 .NET SDK， Senparc.Weixin for C#，支持 .NET Framework 及 .NET Core、.NET 10.0。已支持微信公众号、小程序、小游戏、微信支付、企业微信/企业号、开放平台、JSSDK、微信周边等全平台。 WeChat SDK for C#.
|
|
|
ThreeMammals/Ocelot
.NET API Gateway
|
|
|
RayWangQvQ/BiliBiliToolPro
B 站（bilibili）自动任务工具，支持docker、青龙、k8s等多种部署方式。敏感肌也能用。
|
|
|
elsa-workflows/elsa-core
A .NET workflows library
|
|
|
LykosAI/StabilityMatrix
Multi-Platform Package Manager for Stable Diffusion
|
|
|
ant-design-blazor/ant-design-blazor
🌈A rich set of enterprise-class UI components based on Ant Design and Blazor.
|
|
|
kurrent-io/KurrentDB
KurrentDB is a database that's engineered for modern software applications and event-driven architectures. Its event-native design simplifies data modeling and preserves data integrity while the integrated streaming engine solves distributed messaging challenges and ensures data consistency.
|
|
|
anjoy8/Blog.Core
💖 ASP.NET Core 8.0 全家桶教程，前后端分离后端接口，vue教程姊妹篇，官方文档：
|
|
|
umbraco/Umbraco-CMS
Umbraco is a free and open source .NET content management system helping you deliver delightful digital experiences.
|
|
|
opserver/Opserver
Stack Exchange's Monitoring System
|
|
|
kerryjiang/SuperSocket
SuperSocket is a high-performance, extensible socket server application framework for .NET. It provides a robust architecture for building custom network communication applications with support for multiple protocols including TCP, UDP, and WebSocket.
|
|
|
dotnetcore/BootstrapBlazor
Bootstrap Blazor is an enterprise-level UI component library based on Bootstrap and Blazor.
|
|
|
TelegramBots/Telegram.Bot
.NET Client for Telegram Bot API
|
|
|
fluentmigrator/fluentmigrator
Fluent migrations framework for .NET
|
| Version | Downloads | Last Updated | |
|---|---|---|---|
| 10.0.0 | 228,250 | 11/11/2025 | |
| 10.0.0-rc.2.25502.107 | 171,939 | 10/14/2025 | |
| 10.0.0-rc.1.25451.107 | 219,223 | 9/9/2025 | |
| 10.0.0-preview.7.25380.108 | 72,406 | 8/12/2025 | |
| 10.0.0-preview.6.25358.103 | 68,594 | 7/15/2025 | |
| 10.0.0-preview.5.25277.114 | 80,783 | 6/6/2025 | |
| 10.0.0-preview.4.25258.110 | 60,226 | 5/12/2025 | |
| 10.0.0-preview.3.25171.5 | 74,108 | 4/10/2025 | |
| 10.0.0-preview.2.25163.2 | 54,502 | 3/18/2025 | |
| 10.0.0-preview.1.25080.5 | 150,442 | 2/25/2025 | |
| 9.0.11 | 115,222 | 11/11/2025 | |
| 9.0.10 | 4,000,476 | 10/14/2025 | |
| 9.0.9 | 8,309,711 | 9/9/2025 | |
| 9.0.8 | 9,653,143 | 8/4/2025 | |
| 9.0.7 | 8,447,594 | 7/8/2025 | |
| 9.0.6 | 9,651,111 | 6/10/2025 | |
| 9.0.5 | 12,338,650 | 5/13/2025 | |
| 9.0.4 | 15,630,564 | 4/8/2025 | |
| 9.0.3 | 12,397,021 | 3/11/2025 | |
| 9.0.2 | 14,556,851 | 2/11/2025 | |
| 9.0.1 | 15,276,454 | 1/14/2025 | |
| 9.0.0 | 76,750,283 | 11/12/2024 | |
| 9.0.0-rc.2.24473.5 | 611,862 | 10/8/2024 | |
| 9.0.0-rc.1.24431.7 | 385,694 | 9/10/2024 | |
| 9.0.0-preview.7.24405.7 | 130,144 | 8/13/2024 | |
| 9.0.0-preview.6.24327.7 | 242,795 | 7/9/2024 | |
| 9.0.0-preview.5.24306.7 | 117,799 | 6/11/2024 | |
| 9.0.0-preview.4.24266.19 | 87,145 | 5/21/2024 | |
| 9.0.0-preview.3.24172.9 | 204,007 | 4/11/2024 | |
| 9.0.0-preview.2.24128.5 | 98,184 | 3/12/2024 | |
| 9.0.0-preview.1.24080.9 | 108,639 | 2/13/2024 | |
| 8.0.0 | 385,653,390 | 11/14/2023 | |
| 8.0.0-rc.2.23479.6 | 1,757,188 | 10/10/2023 | |
| 8.0.0-rc.1.23419.4 | 634,295 | 9/12/2023 | |
| 8.0.0-preview.7.23375.6 | 663,021 | 8/8/2023 | |
| 8.0.0-preview.6.23329.7 | 111,207 | 7/11/2023 | |
| 8.0.0-preview.5.23280.8 | 79,793 | 6/13/2023 | |
| 8.0.0-preview.4.23259.5 | 324,397 | 5/16/2023 | |
| 8.0.0-preview.3.23174.8 | 127,949 | 4/11/2023 | |
| 8.0.0-preview.2.23128.3 | 58,905 | 3/14/2023 | |
| 8.0.0-preview.1.23110.8 | 109,648 | 2/21/2023 | |
| 7.0.0 | 138,221,486 | 11/7/2022 | |
| 7.0.0-rc.2.22472.3 | 193,969 | 10/11/2022 | |
| 7.0.0-rc.1.22426.10 | 96,092 | 9/14/2022 | |
| 7.0.0-preview.7.22375.6 | 69,320 | 8/9/2022 | |
| 7.0.0-preview.6.22324.4 | 66,883 | 7/12/2022 | |
| 7.0.0-preview.5.22301.12 | 52,166 | 6/14/2022 | |
| 7.0.0-preview.4.22229.4 | 64,571 | 5/10/2022 | |
| 7.0.0-preview.3.22175.4 | 58,558 | 4/13/2022 | |
| 7.0.0-preview.2.22152.2 | 17,325 | 3/14/2022 | |
| 7.0.0-preview.1.22076.8 | 33,453 | 2/17/2022 | |
| 6.0.1 | 1,156,346 | 11/12/2024 | |
| 6.0.0 | 340,509,544 | 11/8/2021 | |
| 6.0.0-rc.2.21480.5 | 421,799 | 10/12/2021 | |
| 6.0.0-rc.1.21451.13 | 299,814 | 9/14/2021 | |
| 6.0.0-preview.7.21377.19 | 162,028 | 8/10/2021 | |
| 6.0.0-preview.6.21352.12 | 93,541 | 7/14/2021 | |
| 6.0.0-preview.5.21301.5 | 41,806 | 6/15/2021 | |
| 6.0.0-preview.4.21253.7 | 38,838 | 5/24/2021 | |
| 6.0.0-preview.3.21201.4 | 61,874 | 4/8/2021 | |
| 6.0.0-preview.2.21154.6 | 86,751 | 3/11/2021 | |
| 6.0.0-preview.1.21102.12 | 74,147 | 2/12/2021 | |
| 5.0.0 | 209,237,854 | 11/9/2020 | |
| 5.0.0-rc.2.20475.5 | 148,716 | 10/13/2020 | |
| 5.0.0-rc.1.20451.14 | 272,810 | 9/14/2020 | |
| 5.0.0-preview.8.20407.11 | 370,038 | 8/25/2020 | |
| 5.0.0-preview.7.20364.11 | 47,597 | 7/21/2020 | |
| 5.0.0-preview.6.20305.6 | 45,792 | 6/25/2020 | |
| 5.0.0-preview.5.20278.1 | 23,953 | 6/10/2020 | |
| 5.0.0-preview.4.20251.6 | 37,129 | 5/18/2020 | |
| 5.0.0-preview.3.20215.2 | 34,114 | 4/23/2020 | |
| 5.0.0-preview.2.20160.3 | 55,080 | 4/2/2020 | |
| 5.0.0-preview.1.20120.4 | 33,541 | 3/16/2020 | |
| 3.1.32 | 8,837,236 | 12/13/2022 | |
| 3.1.31 | 1,309,626 | 11/8/2022 | |
| 3.1.30 | 1,749,270 | 10/11/2022 | |
| 3.1.29 | 783,981 | 9/13/2022 | |
| 3.1.28 | 1,310,411 | 8/9/2022 | |
| 3.1.27 | 1,272,532 | 7/12/2022 | |
| 3.1.26 | 730,638 | 6/14/2022 | |
| 3.1.25 | 1,393,336 | 5/10/2022 | |
| 3.1.24 | 807,716 | 4/11/2022 | |
| 3.1.23 | 2,003,309 | 3/8/2022 | |
| 3.1.22 | 14,854,698 | 12/14/2021 | |
| 3.1.21 | 3,908,357 | 11/7/2021 | |
| 3.1.20 | 1,613,928 | 10/11/2021 | |
| 3.1.19 | 1,742,633 | 9/14/2021 | |
| 3.1.18 | 4,102,534 | 8/10/2021 | |
| 3.1.17 | 2,878,262 | 7/13/2021 | |
| 3.1.16 | 2,898,669 | 6/8/2021 | |
| 3.1.15 | 4,590,879 | 5/11/2021 | |
| 3.1.14 | 10,428,418 | 4/6/2021 | |
| 3.1.13 | 6,872,186 | 3/9/2021 | |
| 3.1.12 | 4,657,482 | 2/9/2021 | |
| 3.1.11 | 6,098,261 | 1/12/2021 | |
| 3.1.10 | 12,368,722 | 11/9/2020 | |
| 3.1.9 | 13,628,380 | 10/13/2020 | |
| 3.1.8 | 18,540,005 | 9/8/2020 | |
| 3.1.7 | 11,189,020 | 8/11/2020 | |
| 3.1.6 | 20,470,662 | 7/14/2020 | |
| 3.1.5 | 19,814,361 | 6/9/2020 | |
| 3.1.4 | 13,082,720 | 5/12/2020 | |
| 3.1.3 | 21,045,328 | 3/24/2020 | |
| 3.1.2 | 19,357,841 | 2/18/2020 | |
| 3.1.1 | 16,285,428 | 1/14/2020 | |
| 3.1.0 | 128,209,881 | 12/3/2019 | |
| 3.1.0-preview3.19553.2 | 59,489 | 11/13/2019 | |
| 3.1.0-preview2.19525.4 | 16,258 | 11/1/2019 | |
| 3.1.0-preview1.19506.1 | 19,878 | 10/15/2019 | |
| 3.0.3 | 719,419 | 2/18/2020 | |
| 3.0.2 | 850,294 | 1/14/2020 | |
| 3.0.1 | 2,388,461 | 11/18/2019 | |
| 3.0.0 | 37,140,544 | 9/23/2019 | |
| 3.0.0-rc1.19456.10 | 35,963 | 9/16/2019 | |
| 3.0.0-preview9.19423.4 | 140,196 | 9/4/2019 | |
| 3.0.0-preview8.19405.4 | 176,389 | 8/13/2019 | |
| 3.0.0-preview7.19362.4 | 81,824 | 7/23/2019 | |
| 3.0.0-preview6.19304.6 | 158,102 | 6/12/2019 | |
| 3.0.0-preview5.19227.9 | 170,560 | 5/6/2019 | |
| 3.0.0-preview4.19216.2 | 24,724 | 4/18/2019 | |
| 3.0.0-preview3.19153.1 | 164,280 | 3/6/2019 | |
| 3.0.0-preview.19074.2 | 99,339 | 1/29/2019 | |
| 3.0.0-preview.18572.1 | 11,434 | 12/4/2018 | |
| 2.2.0 | 98,645,994 | 12/3/2018 | |
| 2.2.0-preview3-35497 | 143,524 | 10/17/2018 | |
| 2.2.0-preview2-35157 | 66,325 | 9/12/2018 | |
| 2.2.0-preview1-35029 | 35,543 | 8/22/2018 | |
| 2.1.1 | 79,533,123 | 6/18/2018 | |
| 2.1.0 | 234,026,024 | 5/29/2018 | |
| 2.1.0-rc1-final | 79,631 | 5/6/2018 | |
| 2.1.0-preview2-final | 70,930 | 4/10/2018 | |
| 2.1.0-preview1-final | 163,912 | 2/26/2018 | |
| 2.0.2 | 6,547,613 | 5/7/2018 | |
| 2.0.1 | 10,805,518 | 3/13/2018 | |
| 2.0.0 | 392,719,508 | 8/11/2017 | |
| 2.0.0-preview2-final | 129,941 | 6/28/2017 | |
| 2.0.0-preview1-final | 40,952 | 5/10/2017 | |
| 1.1.2 | 9,077,169 | 5/9/2017 | |
| 1.1.1 | 2,953,336 | 3/6/2017 | |
| 1.1.0 | 2,586,801 | 11/16/2016 | |
| 1.1.0-preview1-final | 16,237 | 10/24/2016 | |
| 1.0.2 | 791,543 | 3/6/2017 | |
| 1.0.1 | 326,453 | 12/12/2016 | |
| 1.0.0 | 2,270,618 | 6/27/2016 | |
| 1.0.0-rc2-final | 24,780 | 5/16/2016 |