Microsoft.Extensions.Options.ConfigurationExtensions
9.0.0-preview.2.24128.5
Prefix Reserved
See the version list below for details.
dotnet add package Microsoft.Extensions.Options.ConfigurationExtensions --version 9.0.0-preview.2.24128.5
NuGet\Install-Package Microsoft.Extensions.Options.ConfigurationExtensions -Version 9.0.0-preview.2.24128.5
<PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="9.0.0-preview.2.24128.5" />
paket add Microsoft.Extensions.Options.ConfigurationExtensions --version 9.0.0-preview.2.24128.5
#r "nuget: Microsoft.Extensions.Options.ConfigurationExtensions, 9.0.0-preview.2.24128.5"
// Install Microsoft.Extensions.Options.ConfigurationExtensions as a Cake Addin #addin nuget:?package=Microsoft.Extensions.Options.ConfigurationExtensions&version=9.0.0-preview.2.24128.5&prerelease // Install Microsoft.Extensions.Options.ConfigurationExtensions as a Cake Tool #tool nuget:?package=Microsoft.Extensions.Options.ConfigurationExtensions&version=9.0.0-preview.2.24128.5&prerelease
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:
ConfigurationChangeTokenSource
OptionsBuilderConfigurationExtensions
OptionsConfigurationServiceCollectionExtensions
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. |
.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. |
-
.NETFramework 4.6.2
- Microsoft.Extensions.Configuration.Abstractions (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.Configuration.Binder (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.Options (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.Primitives (>= 9.0.0-preview.2.24128.5)
-
.NETStandard 2.0
- Microsoft.Extensions.Configuration.Abstractions (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.Configuration.Binder (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.Options (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.Primitives (>= 9.0.0-preview.2.24128.5)
-
net8.0
- Microsoft.Extensions.Configuration.Abstractions (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.Configuration.Binder (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.Options (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.Primitives (>= 9.0.0-preview.2.24128.5)
-
net9.0
- Microsoft.Extensions.Configuration.Abstractions (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.Configuration.Binder (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.Options (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.Primitives (>= 9.0.0-preview.2.24128.5)
NuGet packages (3.6K)
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.AspNetCore.App
Provides a default set of APIs for building an ASP.NET Core application. 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. |
|
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. |
GitHub repositories (260)
Showing the top 5 popular GitHub repositories that depend on Microsoft.Extensions.Options.ConfigurationExtensions:
Repository | Stars |
---|---|
ardalis/CleanArchitecture
Clean Architecture Solution Template: A starting point for Clean Architecture with ASP.NET Core
|
|
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
|
Version | Downloads | Last updated | |
---|---|---|---|
9.0.0-rc.2.24473.5 | 64,333 | 10/8/2024 | |
9.0.0-rc.1.24431.7 | 117,607 | 9/10/2024 | |
9.0.0-preview.7.24405.7 | 47,253 | 8/13/2024 | |
9.0.0-preview.6.24327.7 | 78,311 | 7/9/2024 | |
9.0.0-preview.5.24306.7 | 76,899 | 6/11/2024 | |
9.0.0-preview.4.24266.19 | 51,599 | 5/21/2024 | |
9.0.0-preview.3.24172.9 | 135,052 | 4/11/2024 | |
9.0.0-preview.2.24128.5 | 66,909 | 3/12/2024 | |
9.0.0-preview.1.24080.9 | 69,669 | 2/13/2024 | |
8.0.0 | 121,432,460 | 11/14/2023 | |
8.0.0-rc.2.23479.6 | 991,082 | 10/10/2023 | |
8.0.0-rc.1.23419.4 | 347,553 | 9/12/2023 | |
8.0.0-preview.7.23375.6 | 329,892 | 8/8/2023 | |
8.0.0-preview.6.23329.7 | 93,051 | 7/11/2023 | |
8.0.0-preview.5.23280.8 | 66,353 | 6/13/2023 | |
8.0.0-preview.4.23259.5 | 221,069 | 5/16/2023 | |
8.0.0-preview.3.23174.8 | 105,461 | 4/11/2023 | |
8.0.0-preview.2.23128.3 | 51,620 | 3/14/2023 | |
8.0.0-preview.1.23110.8 | 100,915 | 2/21/2023 | |
7.0.0 | 106,179,437 | 11/7/2022 | |
7.0.0-rc.2.22472.3 | 172,575 | 10/11/2022 | |
7.0.0-rc.1.22426.10 | 81,793 | 9/14/2022 | |
7.0.0-preview.7.22375.6 | 63,721 | 8/9/2022 | |
7.0.0-preview.6.22324.4 | 60,387 | 7/12/2022 | |
7.0.0-preview.5.22301.12 | 48,344 | 6/14/2022 | |
7.0.0-preview.4.22229.4 | 57,085 | 5/10/2022 | |
7.0.0-preview.3.22175.4 | 52,356 | 4/13/2022 | |
7.0.0-preview.2.22152.2 | 15,888 | 3/14/2022 | |
7.0.0-preview.1.22076.8 | 31,144 | 2/17/2022 | |
6.0.0 | 265,592,180 | 11/8/2021 | |
6.0.0-rc.2.21480.5 | 401,132 | 10/12/2021 | |
6.0.0-rc.1.21451.13 | 282,721 | 9/14/2021 | |
6.0.0-preview.7.21377.19 | 150,400 | 8/10/2021 | |
6.0.0-preview.6.21352.12 | 88,351 | 7/14/2021 | |
6.0.0-preview.5.21301.5 | 40,042 | 6/15/2021 | |
6.0.0-preview.4.21253.7 | 32,712 | 5/24/2021 | |
6.0.0-preview.3.21201.4 | 56,661 | 4/8/2021 | |
6.0.0-preview.2.21154.6 | 83,408 | 3/11/2021 | |
6.0.0-preview.1.21102.12 | 67,899 | 2/12/2021 | |
5.0.0 | 167,001,779 | 11/9/2020 | |
5.0.0-rc.2.20475.5 | 128,009 | 10/13/2020 | |
5.0.0-rc.1.20451.14 | 268,292 | 9/14/2020 | |
5.0.0-preview.8.20407.11 | 312,622 | 8/25/2020 | |
5.0.0-preview.7.20364.11 | 44,157 | 7/21/2020 | |
5.0.0-preview.6.20305.6 | 43,201 | 6/25/2020 | |
5.0.0-preview.5.20278.1 | 22,007 | 6/10/2020 | |
5.0.0-preview.4.20251.6 | 35,248 | 5/18/2020 | |
5.0.0-preview.3.20215.2 | 31,215 | 4/23/2020 | |
5.0.0-preview.2.20160.3 | 54,462 | 4/2/2020 | |
5.0.0-preview.1.20120.4 | 31,941 | 3/16/2020 | |
3.1.32 | 4,581,512 | 12/13/2022 | |
3.1.31 | 1,026,483 | 11/8/2022 | |
3.1.30 | 1,359,056 | 10/11/2022 | |
3.1.29 | 591,428 | 9/13/2022 | |
3.1.28 | 1,034,018 | 8/9/2022 | |
3.1.27 | 1,078,996 | 7/12/2022 | |
3.1.26 | 591,488 | 6/14/2022 | |
3.1.25 | 1,183,585 | 5/10/2022 | |
3.1.24 | 678,790 | 4/11/2022 | |
3.1.23 | 1,681,911 | 3/8/2022 | |
3.1.22 | 10,247,493 | 12/14/2021 | |
3.1.21 | 3,402,682 | 11/7/2021 | |
3.1.20 | 1,395,541 | 10/11/2021 | |
3.1.19 | 1,546,306 | 9/14/2021 | |
3.1.18 | 3,356,377 | 8/10/2021 | |
3.1.17 | 2,570,909 | 7/13/2021 | |
3.1.16 | 2,624,929 | 6/8/2021 | |
3.1.15 | 4,074,878 | 5/11/2021 | |
3.1.14 | 9,440,422 | 4/6/2021 | |
3.1.13 | 6,361,812 | 3/9/2021 | |
3.1.12 | 4,313,850 | 2/9/2021 | |
3.1.11 | 5,262,883 | 1/12/2021 | |
3.1.10 | 11,064,436 | 11/9/2020 | |
3.1.9 | 12,489,083 | 10/13/2020 | |
3.1.8 | 17,349,282 | 9/8/2020 | |
3.1.7 | 10,230,619 | 8/11/2020 | |
3.1.6 | 18,611,967 | 7/14/2020 | |
3.1.5 | 18,196,147 | 6/9/2020 | |
3.1.4 | 11,955,486 | 5/12/2020 | |
3.1.3 | 19,056,092 | 3/24/2020 | |
3.1.2 | 17,790,418 | 2/18/2020 | |
3.1.1 | 14,623,871 | 1/14/2020 | |
3.1.0 | 99,478,680 | 12/3/2019 | |
3.1.0-preview3.19553.2 | 56,116 | 11/13/2019 | |
3.1.0-preview2.19525.4 | 15,765 | 11/1/2019 | |
3.1.0-preview1.19506.1 | 18,870 | 10/15/2019 | |
3.0.3 | 586,136 | 2/18/2020 | |
3.0.2 | 785,206 | 1/14/2020 | |
3.0.1 | 2,176,607 | 11/18/2019 | |
3.0.0 | 33,197,350 | 9/23/2019 | |
3.0.0-rc1.19456.10 | 35,128 | 9/16/2019 | |
3.0.0-preview9.19423.4 | 134,279 | 9/4/2019 | |
3.0.0-preview8.19405.4 | 149,470 | 8/13/2019 | |
3.0.0-preview7.19362.4 | 77,884 | 7/23/2019 | |
3.0.0-preview6.19304.6 | 143,496 | 6/12/2019 | |
3.0.0-preview5.19227.9 | 155,871 | 5/6/2019 | |
3.0.0-preview4.19216.2 | 23,581 | 4/18/2019 | |
3.0.0-preview3.19153.1 | 151,192 | 3/6/2019 | |
3.0.0-preview.19074.2 | 95,970 | 1/29/2019 | |
3.0.0-preview.18572.1 | 10,950 | 12/4/2018 | |
2.2.0 | 84,886,503 | 12/3/2018 | |
2.2.0-preview3-35497 | 140,166 | 10/17/2018 | |
2.2.0-preview2-35157 | 64,634 | 9/12/2018 | |
2.2.0-preview1-35029 | 34,402 | 8/22/2018 | |
2.1.1 | 63,609,415 | 6/18/2018 | |
2.1.0 | 179,454,568 | 5/29/2018 | |
2.1.0-rc1-final | 75,713 | 5/6/2018 | |
2.1.0-preview2-final | 67,097 | 4/10/2018 | |
2.1.0-preview1-final | 160,082 | 2/26/2018 | |
2.0.2 | 6,093,500 | 5/7/2018 | |
2.0.1 | 10,341,224 | 3/13/2018 | |
2.0.0 | 340,975,378 | 8/11/2017 | |
2.0.0-preview2-final | 123,822 | 6/28/2017 | |
2.0.0-preview1-final | 39,502 | 5/10/2017 | |
1.1.2 | 8,010,702 | 5/9/2017 | |
1.1.1 | 2,761,154 | 3/6/2017 | |
1.1.0 | 2,349,048 | 11/16/2016 | |
1.1.0-preview1-final | 15,631 | 10/24/2016 | |
1.0.2 | 707,834 | 3/6/2017 | |
1.0.1 | 252,437 | 12/12/2016 | |
1.0.0 | 2,059,623 | 6/27/2016 | |
1.0.0-rc2-final | 23,658 | 5/16/2016 |