Microsoft.Extensions.Options
9.0.0
Prefix Reserved
dotnet add package Microsoft.Extensions.Options --version 9.0.0
NuGet\Install-Package Microsoft.Extensions.Options -Version 9.0.0
<PackageReference Include="Microsoft.Extensions.Options" Version="9.0.0" />
paket add Microsoft.Extensions.Options --version 9.0.0
#r "nuget: Microsoft.Extensions.Options, 9.0.0"
// Install Microsoft.Extensions.Options as a Cake Addin #addin nuget:?package=Microsoft.Extensions.Options&version=9.0.0 // Install Microsoft.Extensions.Options as a Cake Tool #tool nuget:?package=Microsoft.Extensions.Options&version=9.0.0
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 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 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 (>= 9.0.0)
- Microsoft.Extensions.Primitives (>= 9.0.0)
- System.ValueTuple (>= 4.5.0)
-
.NETStandard 2.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 9.0.0)
- Microsoft.Extensions.Primitives (>= 9.0.0)
- System.ComponentModel.Annotations (>= 5.0.0)
-
.NETStandard 2.1
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 9.0.0)
- Microsoft.Extensions.Primitives (>= 9.0.0)
- System.ComponentModel.Annotations (>= 5.0.0)
-
net8.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 9.0.0)
- Microsoft.Extensions.Primitives (>= 9.0.0)
-
net9.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 9.0.0)
- Microsoft.Extensions.Primitives (>= 9.0.0)
NuGet packages (6.0K)
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 - Server Backend & API
|
|
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 | 7,698,174 | 11/12/2024 | |
9.0.0-rc.2.24473.5 | 466,068 | 10/8/2024 | |
9.0.0-rc.1.24431.7 | 312,886 | 9/10/2024 | |
9.0.0-preview.7.24405.7 | 194,599 | 8/13/2024 | |
9.0.0-preview.6.24327.7 | 237,221 | 7/9/2024 | |
9.0.0-preview.5.24306.7 | 183,246 | 6/11/2024 | |
9.0.0-preview.4.24266.19 | 132,219 | 5/21/2024 | |
9.0.0-preview.3.24172.9 | 295,808 | 4/11/2024 | |
9.0.0-preview.2.24128.5 | 182,299 | 3/12/2024 | |
9.0.0-preview.1.24080.9 | 187,318 | 2/13/2024 | |
8.0.2 | 101,304,888 | 2/13/2024 | |
8.0.1 | 22,707,834 | 1/9/2024 | |
8.0.0 | 208,585,832 | 11/14/2023 | |
8.0.0-rc.2.23479.6 | 2,260,765 | 10/10/2023 | |
8.0.0-rc.1.23419.4 | 1,243,830 | 9/12/2023 | |
8.0.0-preview.7.23375.6 | 674,387 | 8/8/2023 | |
8.0.0-preview.6.23329.7 | 432,402 | 7/11/2023 | |
8.0.0-preview.5.23280.8 | 288,438 | 6/13/2023 | |
8.0.0-preview.4.23259.5 | 535,431 | 5/16/2023 | |
8.0.0-preview.3.23174.8 | 425,859 | 4/11/2023 | |
8.0.0-preview.2.23128.3 | 334,759 | 3/14/2023 | |
8.0.0-preview.1.23110.8 | 343,334 | 2/21/2023 | |
7.0.1 | 112,997,055 | 2/14/2023 | |
7.0.0 | 244,408,540 | 11/7/2022 | |
7.0.0-rc.2.22472.3 | 1,689,329 | 10/11/2022 | |
7.0.0-rc.1.22426.10 | 434,022 | 9/14/2022 | |
7.0.0-preview.7.22375.6 | 408,984 | 8/9/2022 | |
7.0.0-preview.6.22324.4 | 258,242 | 7/12/2022 | |
7.0.0-preview.5.22301.12 | 191,754 | 6/14/2022 | |
7.0.0-preview.4.22229.4 | 393,957 | 5/10/2022 | |
7.0.0-preview.3.22175.4 | 187,382 | 4/13/2022 | |
7.0.0-preview.2.22152.2 | 255,755 | 3/14/2022 | |
7.0.0-preview.1.22076.8 | 165,790 | 2/17/2022 | |
6.0.1 | 516,787 | 11/12/2024 | |
6.0.0 | 619,803,272 | 11/8/2021 | |
6.0.0-rc.2.21480.5 | 1,852,560 | 10/12/2021 | |
6.0.0-rc.1.21451.13 | 687,800 | 9/14/2021 | |
6.0.0-preview.7.21377.19 | 757,928 | 8/10/2021 | |
6.0.0-preview.6.21352.12 | 358,549 | 7/14/2021 | |
6.0.0-preview.5.21301.5 | 343,552 | 6/15/2021 | |
6.0.0-preview.4.21253.7 | 190,703 | 5/24/2021 | |
6.0.0-preview.3.21201.4 | 635,427 | 4/8/2021 | |
6.0.0-preview.2.21154.6 | 218,119 | 3/11/2021 | |
6.0.0-preview.1.21102.12 | 560,700 | 2/12/2021 | |
5.0.0 | 513,230,658 | 11/9/2020 | |
5.0.0-rc.2.20475.5 | 1,023,445 | 10/13/2020 | |
5.0.0-rc.1.20451.14 | 810,736 | 9/14/2020 | |
5.0.0-preview.8.20407.11 | 569,216 | 8/25/2020 | |
5.0.0-preview.7.20364.11 | 247,147 | 7/21/2020 | |
5.0.0-preview.6.20305.6 | 167,058 | 6/25/2020 | |
5.0.0-preview.5.20278.1 | 94,075 | 6/10/2020 | |
5.0.0-preview.4.20251.6 | 322,928 | 5/18/2020 | |
5.0.0-preview.3.20215.2 | 238,698 | 4/23/2020 | |
5.0.0-preview.2.20160.3 | 350,428 | 4/2/2020 | |
5.0.0-preview.1.20120.4 | 181,151 | 3/16/2020 | |
3.1.32 | 22,796,424 | 12/13/2022 | |
3.1.31 | 2,988,845 | 11/8/2022 | |
3.1.30 | 2,565,490 | 10/11/2022 | |
3.1.29 | 2,372,358 | 9/13/2022 | |
3.1.28 | 6,290,261 | 8/9/2022 | |
3.1.27 | 2,332,286 | 7/12/2022 | |
3.1.26 | 1,937,247 | 6/14/2022 | |
3.1.25 | 3,413,987 | 5/10/2022 | |
3.1.24 | 4,033,945 | 4/11/2022 | |
3.1.23 | 4,224,208 | 3/8/2022 | |
3.1.22 | 19,497,610 | 12/14/2021 | |
3.1.21 | 11,005,202 | 11/7/2021 | |
3.1.20 | 5,083,677 | 10/11/2021 | |
3.1.19 | 5,424,971 | 9/14/2021 | |
3.1.18 | 64,326,531 | 8/10/2021 | |
3.1.17 | 7,170,743 | 7/13/2021 | |
3.1.16 | 13,805,174 | 6/8/2021 | |
3.1.15 | 8,833,359 | 5/11/2021 | |
3.1.14 | 19,177,183 | 4/6/2021 | |
3.1.13 | 15,205,635 | 3/9/2021 | |
3.1.12 | 11,766,317 | 2/9/2021 | |
3.1.11 | 20,296,691 | 1/12/2021 | |
3.1.10 | 29,473,443 | 11/9/2020 | |
3.1.9 | 75,564,611 | 10/13/2020 | |
3.1.8 | 75,098,304 | 9/8/2020 | |
3.1.7 | 40,708,416 | 8/11/2020 | |
3.1.6 | 46,035,016 | 7/14/2020 | |
3.1.5 | 46,184,100 | 6/9/2020 | |
3.1.4 | 61,554,394 | 5/12/2020 | |
3.1.3 | 120,091,878 | 3/24/2020 | |
3.1.2 | 79,053,901 | 2/18/2020 | |
3.1.1 | 45,140,497 | 1/14/2020 | |
3.1.0 | 195,502,960 | 12/3/2019 | |
3.1.0-preview3.19553.2 | 2,045,228 | 11/13/2019 | |
3.1.0-preview2.19525.4 | 235,975 | 11/1/2019 | |
3.1.0-preview1.19506.1 | 1,280,286 | 10/15/2019 | |
3.0.3 | 73,447,052 | 2/18/2020 | |
3.0.2 | 1,155,421 | 1/14/2020 | |
3.0.1 | 5,809,643 | 11/18/2019 | |
3.0.0 | 178,182,870 | 9/23/2019 | |
3.0.0-rc1.19456.10 | 177,580 | 9/16/2019 | |
3.0.0-preview9.19423.4 | 1,686,196 | 9/4/2019 | |
3.0.0-preview8.19405.4 | 596,676 | 8/13/2019 | |
3.0.0-preview7.19362.4 | 193,568 | 7/23/2019 | |
3.0.0-preview6.19304.6 | 464,733 | 6/12/2019 | |
3.0.0-preview5.19227.9 | 815,152 | 5/6/2019 | |
3.0.0-preview4.19216.2 | 55,216 | 4/18/2019 | |
3.0.0-preview3.19153.1 | 338,952 | 3/6/2019 | |
3.0.0-preview.19074.2 | 174,713 | 1/29/2019 | |
3.0.0-preview.18572.1 | 163,655 | 12/4/2018 | |
2.2.0 | 629,813,828 | 12/3/2018 | |
2.2.0-preview3-35497 | 608,294 | 10/17/2018 | |
2.2.0-preview2-35157 | 555,092 | 9/12/2018 | |
2.2.0-preview1-35029 | 260,986 | 8/22/2018 | |
2.1.1 | 445,038,410 | 6/18/2018 | |
2.1.0 | 418,466,311 | 5/29/2018 | |
2.1.0-rc1-final | 679,880 | 5/6/2018 | |
2.1.0-preview2-final | 919,810 | 4/10/2018 | |
2.1.0-preview1-final | 830,266 | 2/26/2018 | |
2.0.2 | 34,510,237 | 5/7/2018 | |
2.0.1 | 55,121,544 | 3/13/2018 | |
2.0.0 | 553,568,384 | 8/11/2017 | |
2.0.0-preview2-final | 433,441 | 6/28/2017 | |
2.0.0-preview1-final | 1,134,274 | 5/10/2017 | |
1.1.2 | 25,113,944 | 5/9/2017 | |
1.1.1 | 21,458,912 | 3/6/2017 | |
1.1.0 | 16,064,696 | 11/16/2016 | |
1.1.0-preview1-final | 311,952 | 10/24/2016 | |
1.0.2 | 118,594,199 | 3/6/2017 | |
1.0.1 | 3,721,596 | 12/12/2016 | |
1.0.0 | 278,962,148 | 6/27/2016 | |
1.0.0-rc2-final | 2,063,809 | 5/16/2016 |