Microsoft.Extensions.Options
8.0.2
Prefix Reserved
See the version list below for details.
dotnet add package Microsoft.Extensions.Options --version 8.0.2
NuGet\Install-Package Microsoft.Extensions.Options -Version 8.0.2
<PackageReference Include="Microsoft.Extensions.Options" Version="8.0.2" />
paket add Microsoft.Extensions.Options --version 8.0.2
#r "nuget: Microsoft.Extensions.Options, 8.0.2"
// Install Microsoft.Extensions.Options as a Cake Addin #addin nuget:?package=Microsoft.Extensions.Options&version=8.0.2 // Install Microsoft.Extensions.Options as a Cake Tool #tool nuget:?package=Microsoft.Extensions.Options&version=8.0.2
About
Microsoft.Extensions.Options
provides a strongly typed way of specifying and accessing settings using dependency injection and acts as a bridge between configuration, DI, and higher level libraries. This library is the glue for how an app developer uses DI to configure the behavior of a library like HttpClient Factory. This also enables user to get a strongly-typed view of their configuration.
Within this package, you'll find an options validation source generator that generates exceptionally efficient and optimized code for validating options.
Key Features
- Offer the IValidateOptions interface for the validation of options, along with several generic ValidateOptions classes that implement this interface.
- OptionsBuilder to configure options.
- Provide extension methods for service collections and options builder to register options and validate options.
- Supply a set of generic ConfigureNamedOptions classes that implement the IConfigureNamedOptions interface for configuring named options.
- Provide a source generator that generates validation code for options.
- Options caching, managing and monitoring.
How to Use
Options validation example
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Options;
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddControllersWithViews();
// Load the configuration and validate it
builder.Services.AddOptions<MyConfigOptions>()
.Bind(builder.Configuration.GetSection(MyConfigOptions.MyConfig))
.ValidateDataAnnotations();
var app = builder.Build();
// Declare the option class to validate
public class MyConfigOptions
{
public const string MyConfig = "MyConfig";
[RegularExpression(@"^[a-zA-Z''-'\s]{1,40}$")]
public string Key1 { get; set; }
[Range(0, 1000,
ErrorMessage = "Value for {0} must be between {1} and {2}.")]
public int Key2 { get; set; }
public int Key3 { get; set; }
}
Using IValidateOptions to validate options
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Options;
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddControllersWithViews();
// Configuration to validate
builder.Services.Configure<MyConfigOptions>(builder.Configuration.GetSection(
MyConfigOptions.MyConfig));
// OPtions validation through the DI container
builder.Services.AddSingleton<IValidateOptions
<MyConfigOptions>, MyConfigValidation>();
var app = builder.Build();
public class MyConfigValidation : IValidateOptions<MyConfigOptions>
{
public MyConfigOptions _config { get; private set; }
public MyConfigValidation(IConfiguration config)
{
_config = config.GetSection(MyConfigOptions.MyConfig)
.Get<MyConfigOptions>();
}
public ValidateOptionsResult Validate(string name, MyConfigOptions options)
{
string? vor = null;
var rx = new Regex(@"^[a-zA-Z''-'\s]{1,40}$");
var match = rx.Match(options.Key1!);
if (string.IsNullOrEmpty(match.Value))
{
vor = $"{options.Key1} doesn't match RegEx \n";
}
if ( options.Key2 < 0 || options.Key2 > 1000)
{
vor = $"{options.Key2} doesn't match Range 0 - 1000 \n";
}
if (_config.Key2 != default)
{
if(_config.Key3 <= _config.Key2)
{
vor += "Key3 must be > than Key2.";
}
}
if (vor != null)
{
return ValidateOptionsResult.Fail(vor);
}
return ValidateOptionsResult.Success;
}
}
Options Validation Source Generator Example
using System;
using System.ComponentModel.DataAnnotations;
using Microsoft.Extensions.Options;
public class MyConfigOptions
{
[RegularExpression(@"^[a-zA-Z''-'\s]{1,40}$")]
public string Key1 { get; set; }
[Range(0, 1000,
ErrorMessage = "Value for {0} must be between {1} and {2}.")]
public int Key2 { get; set; }
public int Key3 { get; set; }
}
[OptionsValidator]
public partial class MyConfigValidation : IValidateOptions<MyConfigOptions>
{
// Source generator will automatically provide the implementation of IValidateOptions
// Then you can add the validation to the DI Container using the following code:
//
// builder.Services.AddSingleton<IValidateOptions
// <MyConfigOptions>, MyConfigValidation>();
// builder.Services.AddOptions<MyConfigOptions>()
// .Bind(builder.Configuration.GetSection(MyConfigOptions.MyConfig))
// .ValidateDataAnnotations();
}
Main Types
The main types provided by this library are:
IOptions
,IOptionsFactory
, andIOptionsMonitor
IValidateOptions
andValidateOptions
OptionsBuilder
,OptionsFactory
,OptionsMonitor
, andOptionsManager
OptionsServiceCollectionExtensions
OptionsValidatorAttribute
Additional Documentation
Related Packages
Microsoft.Extensions.Logging Microsoft.Extensions.Configuration
Feedback & Contributing
Microsoft.Extensions.Options 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 is compatible. 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 is compatible. 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. |
.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 is compatible. |
.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.DependencyInjection.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Primitives (>= 8.0.0)
- System.ValueTuple (>= 4.5.0)
-
.NETStandard 2.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Primitives (>= 8.0.0)
- System.ComponentModel.Annotations (>= 5.0.0)
-
.NETStandard 2.1
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Primitives (>= 8.0.0)
- System.ComponentModel.Annotations (>= 5.0.0)
-
net6.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Primitives (>= 8.0.0)
-
net7.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Primitives (>= 8.0.0)
-
net8.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Primitives (>= 8.0.0)
NuGet packages (5.8K)
Showing the top 5 NuGet packages that depend on Microsoft.Extensions.Options:
Package | Downloads |
---|---|
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging. |
|
Microsoft.Extensions.Caching.Memory
In-memory cache implementation of Microsoft.Extensions.Caching.Memory.IMemoryCache. |
|
Microsoft.Extensions.Options.ConfigurationExtensions
Provides additional configuration specific functionality related to Options. |
|
Microsoft.AspNetCore.Http
ASP.NET Core default HTTP feature implementations. This package was built from the source code at https://github.com/aspnet/AspNetCore/tree/522705f9a27b99ca4ad261f2e89fe51a77b2338e |
|
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging. |
GitHub repositories (393)
Showing the top 5 popular GitHub repositories that depend on Microsoft.Extensions.Options:
Repository | Stars |
---|---|
jellyfin/jellyfin
The Free Software Media System
|
|
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
|
|
aspnetboilerplate/aspnetboilerplate
ASP.NET Boilerplate - Web Application Framework
|
Version | Downloads | Last updated | |
---|---|---|---|
9.0.0-rc.2.24473.5 | 135,738 | 10/8/2024 | |
9.0.0-rc.1.24431.7 | 193,551 | 9/10/2024 | |
9.0.0-preview.7.24405.7 | 120,333 | 8/13/2024 | |
9.0.0-preview.6.24327.7 | 190,316 | 7/9/2024 | |
9.0.0-preview.5.24306.7 | 155,007 | 6/11/2024 | |
9.0.0-preview.4.24266.19 | 112,255 | 5/21/2024 | |
9.0.0-preview.3.24172.9 | 266,659 | 4/11/2024 | |
9.0.0-preview.2.24128.5 | 164,778 | 3/12/2024 | |
9.0.0-preview.1.24080.9 | 165,852 | 2/13/2024 | |
8.0.2 | 68,140,885 | 2/13/2024 | |
8.0.1 | 18,131,742 | 1/9/2024 | |
8.0.0 | 164,070,733 | 11/14/2023 | |
8.0.0-rc.2.23479.6 | 2,032,056 | 10/10/2023 | |
8.0.0-rc.1.23419.4 | 1,149,282 | 9/12/2023 | |
8.0.0-preview.7.23375.6 | 598,957 | 8/8/2023 | |
8.0.0-preview.6.23329.7 | 404,918 | 7/11/2023 | |
8.0.0-preview.5.23280.8 | 275,041 | 6/13/2023 | |
8.0.0-preview.4.23259.5 | 495,173 | 5/16/2023 | |
8.0.0-preview.3.23174.8 | 398,868 | 4/11/2023 | |
8.0.0-preview.2.23128.3 | 328,026 | 3/14/2023 | |
8.0.0-preview.1.23110.8 | 330,973 | 2/21/2023 | |
7.0.1 | 106,569,069 | 2/14/2023 | |
7.0.0 | 228,981,880 | 11/7/2022 | |
7.0.0-rc.2.22472.3 | 1,413,171 | 10/11/2022 | |
7.0.0-rc.1.22426.10 | 426,792 | 9/14/2022 | |
7.0.0-preview.7.22375.6 | 402,933 | 8/9/2022 | |
7.0.0-preview.6.22324.4 | 251,788 | 7/12/2022 | |
7.0.0-preview.5.22301.12 | 189,287 | 6/14/2022 | |
7.0.0-preview.4.22229.4 | 381,911 | 5/10/2022 | |
7.0.0-preview.3.22175.4 | 183,152 | 4/13/2022 | |
7.0.0-preview.2.22152.2 | 251,093 | 3/14/2022 | |
7.0.0-preview.1.22076.8 | 161,059 | 2/17/2022 | |
6.0.0 | 577,621,214 | 11/8/2021 | |
6.0.0-rc.2.21480.5 | 1,813,610 | 10/12/2021 | |
6.0.0-rc.1.21451.13 | 673,286 | 9/14/2021 | |
6.0.0-preview.7.21377.19 | 750,712 | 8/10/2021 | |
6.0.0-preview.6.21352.12 | 354,865 | 7/14/2021 | |
6.0.0-preview.5.21301.5 | 338,051 | 6/15/2021 | |
6.0.0-preview.4.21253.7 | 188,147 | 5/24/2021 | |
6.0.0-preview.3.21201.4 | 625,731 | 4/8/2021 | |
6.0.0-preview.2.21154.6 | 217,388 | 3/11/2021 | |
6.0.0-preview.1.21102.12 | 556,883 | 2/12/2021 | |
5.0.0 | 495,269,588 | 11/9/2020 | |
5.0.0-rc.2.20475.5 | 1,009,532 | 10/13/2020 | |
5.0.0-rc.1.20451.14 | 805,439 | 9/14/2020 | |
5.0.0-preview.8.20407.11 | 559,131 | 8/25/2020 | |
5.0.0-preview.7.20364.11 | 245,451 | 7/21/2020 | |
5.0.0-preview.6.20305.6 | 166,111 | 6/25/2020 | |
5.0.0-preview.5.20278.1 | 92,501 | 6/10/2020 | |
5.0.0-preview.4.20251.6 | 321,864 | 5/18/2020 | |
5.0.0-preview.3.20215.2 | 237,736 | 4/23/2020 | |
5.0.0-preview.2.20160.3 | 348,624 | 4/2/2020 | |
5.0.0-preview.1.20120.4 | 180,257 | 3/16/2020 | |
3.1.32 | 20,058,544 | 12/13/2022 | |
3.1.31 | 2,796,420 | 11/8/2022 | |
3.1.30 | 2,415,778 | 10/11/2022 | |
3.1.29 | 2,237,609 | 9/13/2022 | |
3.1.28 | 6,078,488 | 8/9/2022 | |
3.1.27 | 2,263,556 | 7/12/2022 | |
3.1.26 | 1,887,840 | 6/14/2022 | |
3.1.25 | 3,342,092 | 5/10/2022 | |
3.1.24 | 3,874,792 | 4/11/2022 | |
3.1.23 | 4,118,679 | 3/8/2022 | |
3.1.22 | 18,498,013 | 12/14/2021 | |
3.1.21 | 10,595,719 | 11/7/2021 | |
3.1.20 | 4,926,435 | 10/11/2021 | |
3.1.19 | 5,318,785 | 9/14/2021 | |
3.1.18 | 62,011,973 | 8/10/2021 | |
3.1.17 | 7,031,119 | 7/13/2021 | |
3.1.16 | 13,340,442 | 6/8/2021 | |
3.1.15 | 8,681,518 | 5/11/2021 | |
3.1.14 | 18,787,326 | 4/6/2021 | |
3.1.13 | 14,945,655 | 3/9/2021 | |
3.1.12 | 11,573,379 | 2/9/2021 | |
3.1.11 | 19,874,947 | 1/12/2021 | |
3.1.10 | 28,877,913 | 11/9/2020 | |
3.1.9 | 73,444,481 | 10/13/2020 | |
3.1.8 | 73,640,023 | 9/8/2020 | |
3.1.7 | 39,911,632 | 8/11/2020 | |
3.1.6 | 45,307,003 | 7/14/2020 | |
3.1.5 | 45,582,648 | 6/9/2020 | |
3.1.4 | 59,877,347 | 5/12/2020 | |
3.1.3 | 113,323,557 | 3/24/2020 | |
3.1.2 | 77,830,938 | 2/18/2020 | |
3.1.1 | 44,439,188 | 1/14/2020 | |
3.1.0 | 184,527,461 | 12/3/2019 | |
3.1.0-preview3.19553.2 | 1,947,447 | 11/13/2019 | |
3.1.0-preview2.19525.4 | 231,359 | 11/1/2019 | |
3.1.0-preview1.19506.1 | 1,261,600 | 10/15/2019 | |
3.0.3 | 69,312,946 | 2/18/2020 | |
3.0.2 | 1,151,349 | 1/14/2020 | |
3.0.1 | 5,742,103 | 11/18/2019 | |
3.0.0 | 174,891,853 | 9/23/2019 | |
3.0.0-rc1.19456.10 | 174,760 | 9/16/2019 | |
3.0.0-preview9.19423.4 | 1,673,868 | 9/4/2019 | |
3.0.0-preview8.19405.4 | 593,753 | 8/13/2019 | |
3.0.0-preview7.19362.4 | 192,748 | 7/23/2019 | |
3.0.0-preview6.19304.6 | 454,622 | 6/12/2019 | |
3.0.0-preview5.19227.9 | 813,291 | 5/6/2019 | |
3.0.0-preview4.19216.2 | 55,048 | 4/18/2019 | |
3.0.0-preview3.19153.1 | 338,084 | 3/6/2019 | |
3.0.0-preview.19074.2 | 174,158 | 1/29/2019 | |
3.0.0-preview.18572.1 | 162,943 | 12/4/2018 | |
2.2.0 | 601,760,321 | 12/3/2018 | |
2.2.0-preview3-35497 | 604,912 | 10/17/2018 | |
2.2.0-preview2-35157 | 550,425 | 9/12/2018 | |
2.2.0-preview1-35029 | 259,922 | 8/22/2018 | |
2.1.1 | 420,118,271 | 6/18/2018 | |
2.1.0 | 400,904,313 | 5/29/2018 | |
2.1.0-rc1-final | 673,698 | 5/6/2018 | |
2.1.0-preview2-final | 913,516 | 4/10/2018 | |
2.1.0-preview1-final | 827,679 | 2/26/2018 | |
2.0.2 | 33,578,452 | 5/7/2018 | |
2.0.1 | 54,321,242 | 3/13/2018 | |
2.0.0 | 539,318,624 | 8/11/2017 | |
2.0.0-preview2-final | 424,942 | 6/28/2017 | |
2.0.0-preview1-final | 1,127,113 | 5/10/2017 | |
1.1.2 | 24,679,649 | 5/9/2017 | |
1.1.1 | 21,152,757 | 3/6/2017 | |
1.1.0 | 15,715,375 | 11/16/2016 | |
1.1.0-preview1-final | 311,737 | 10/24/2016 | |
1.0.2 | 117,654,933 | 3/6/2017 | |
1.0.1 | 3,715,511 | 12/12/2016 | |
1.0.0 | 265,505,561 | 6/27/2016 | |
1.0.0-rc2-final | 2,058,578 | 5/16/2016 |