Microsoft.Extensions.Options
10.0.2
Prefix Reserved
dotnet add package Microsoft.Extensions.Options --version 10.0.2
NuGet\Install-Package Microsoft.Extensions.Options -Version 10.0.2
<PackageReference Include="Microsoft.Extensions.Options" Version="10.0.2" />
<PackageVersion Include="Microsoft.Extensions.Options" Version="10.0.2" />
<PackageReference Include="Microsoft.Extensions.Options" />
paket add Microsoft.Extensions.Options --version 10.0.2
#r "nuget: Microsoft.Extensions.Options, 10.0.2"
#:package Microsoft.Extensions.Options@10.0.2
#addin nuget:?package=Microsoft.Extensions.Options&version=10.0.2
#tool nuget:?package=Microsoft.Extensions.Options&version=10.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, andIOptionsMonitorIValidateOptionsandValidateOptionsOptionsBuilder,OptionsFactory,OptionsMonitor, andOptionsManagerOptionsServiceCollectionExtensionsOptionsValidatorAttribute
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. 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 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 (>= 10.0.2)
- Microsoft.Extensions.Primitives (>= 10.0.2)
- System.ValueTuple (>= 4.6.1)
-
.NETStandard 2.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.2)
- Microsoft.Extensions.Primitives (>= 10.0.2)
- System.ComponentModel.Annotations (>= 5.0.0)
-
.NETStandard 2.1
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.2)
- Microsoft.Extensions.Primitives (>= 10.0.2)
- System.ComponentModel.Annotations (>= 5.0.0)
-
net10.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.2)
- Microsoft.Extensions.Primitives (>= 10.0.2)
-
net8.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.2)
- Microsoft.Extensions.Primitives (>= 10.0.2)
-
net9.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.2)
- Microsoft.Extensions.Primitives (>= 10.0.2)
NuGet packages (8.3K)
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. |
|
|
Microsoft.Extensions.Http
The HttpClient factory is a pattern for configuring and retrieving named HttpClients in a composable way. The HttpClient factory provides extensibility to plug in DelegatingHandlers that address cross-cutting concerns such as service location, load balancing, and reliability. The default HttpClient factory provides built-in diagnostics and logging and manages the lifetimes of connections in a performant way. Commonly Used Types: System.Net.Http.IHttpClientFactory |
GitHub repositories (441)
Showing the top 20 popular GitHub repositories that depend on Microsoft.Extensions.Options:
| Repository | Stars |
|---|---|
|
jellyfin/jellyfin
The Free Software Media System - Server Backend & API
|
|
|
dotnet/roslyn
The Roslyn .NET compiler provides C# and Visual Basic languages with rich code analysis APIs.
|
|
|
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.
|
|
|
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+.
|
|
|
dotnet/AspNetCore.Docs
Documentation for ASP.NET Core
|
|
|
aspnetboilerplate/aspnetboilerplate
ASP.NET Boilerplate - Web Application Framework
|
|
|
chocolatey/choco
Chocolatey - the package manager for Windows
|
|
|
dotnet/orleans
Cloud Native application framework for .NET
|
|
|
LuckyPennySoftware/AutoMapper
A convention-based object-object mapper in .NET.
|
|
|
dotnet/eShop
A reference .NET application implementing an eCommerce site
|
|
|
JeffreySu/WeiXinMPSDK
微信全平台 .NET SDK, Senparc.Weixin for C#,支持 .NET Framework 及 .NET Core、.NET 10.0。已支持微信公众号、小程序、小游戏、微信支付、企业微信/企业号、开放平台、JSSDK、微信周边等全平台。 WeChat SDK for C#.
|
|
|
RayWangQvQ/BiliBiliToolPro
B 站(bilibili)自动任务工具,支持docker、青龙、k8s等多种部署方式。敏感肌也能用。
|
|
|
microsoft/ailab
Experience, Learn and Code the latest breakthrough innovations with Microsoft AI
|
|
|
MassTransit/MassTransit
Distributed Application Framework for .NET
|
|
|
elsa-workflows/elsa-core
A .NET workflows library
|
|
|
dotnetcore/CAP
Distributed transaction solution in micro-service base on eventually consistency, also an eventbus with Outbox pattern
|
|
|
quartznet/quartznet
Quartz Enterprise Scheduler .NET
|
|
|
ant-design-blazor/ant-design-blazor
🌈A rich set of enterprise-class UI components based on Ant Design and Blazor.
|
|
|
graphql-dotnet/graphql-dotnet
GraphQL for .NET
|
|
|
Azure/azure-sdk-for-net
This repository is for active development of the Azure SDK for .NET. For consumers of the SDK we recommend visiting our public developer docs at https://learn.microsoft.com/dotnet/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-net.
|
| Version | Downloads | Last Updated | |
|---|---|---|---|
| 10.0.2 | 1,600,281 | 1/13/2026 | |
| 10.0.1 | 6,400,957 | 12/9/2025 | |
| 10.0.0 | 14,359,675 | 11/11/2025 | |
| 10.0.0-rc.2.25502.107 | 576,293 | 10/14/2025 | |
| 10.0.0-rc.1.25451.107 | 467,639 | 9/9/2025 | |
| 10.0.0-preview.7.25380.108 | 164,999 | 8/12/2025 | |
| 10.0.0-preview.6.25358.103 | 144,503 | 7/15/2025 | |
| 10.0.0-preview.5.25277.114 | 259,443 | 6/6/2025 | |
| 10.0.0-preview.4.25258.110 | 161,606 | 5/12/2025 | |
| 10.0.0-preview.3.25171.5 | 185,645 | 4/10/2025 | |
| 10.0.0-preview.2.25163.2 | 121,236 | 3/18/2025 | |
| 10.0.0-preview.1.25080.5 | 248,104 | 2/25/2025 | |
| 9.0.12 | 405,306 | 1/13/2026 | |
| 9.0.11 | 6,082,852 | 11/11/2025 | |
| 9.0.10 | 16,242,192 | 10/14/2025 | |
| 9.0.9 | 21,449,229 | 9/9/2025 | |
| 9.0.8 | 22,045,008 | 8/4/2025 | |
| 9.0.7 | 18,080,436 | 7/8/2025 | |
| 9.0.6 | 20,626,542 | 6/10/2025 | |
| 9.0.5 | 26,462,367 | 5/13/2025 | |
| 9.0.4 | 40,408,050 | 4/8/2025 | |
| 9.0.3 | 25,683,067 | 3/11/2025 | |
| 9.0.2 | 34,597,941 | 2/11/2025 | |
| 9.0.1 | 43,295,857 | 1/14/2025 | |
| 9.0.0 | 160,479,532 | 11/12/2024 | |
| 9.0.0-rc.2.24473.5 | 1,403,976 | 10/8/2024 | |
| 9.0.0-rc.1.24431.7 | 754,293 | 9/10/2024 | |
| 9.0.0-preview.7.24405.7 | 1,346,844 | 8/13/2024 | |
| 9.0.0-preview.6.24327.7 | 559,877 | 7/9/2024 | |
| 9.0.0-preview.5.24306.7 | 318,152 | 6/11/2024 | |
| 9.0.0-preview.4.24266.19 | 324,874 | 5/21/2024 | |
| 9.0.0-preview.3.24172.9 | 451,764 | 4/11/2024 | |
| 9.0.0-preview.2.24128.5 | 263,036 | 3/12/2024 | |
| 9.0.0-preview.1.24080.9 | 303,661 | 2/13/2024 | |
| 8.0.2 | 415,296,240 | 2/13/2024 | |
| 8.0.1 | 55,918,275 | 1/9/2024 | |
| 8.0.0 | 551,997,396 | 11/14/2023 | |
| 8.0.0-rc.2.23479.6 | 3,504,966 | 10/10/2023 | |
| 8.0.0-rc.1.23419.4 | 1,871,844 | 9/12/2023 | |
| 8.0.0-preview.7.23375.6 | 1,044,257 | 8/8/2023 | |
| 8.0.0-preview.6.23329.7 | 558,909 | 7/11/2023 | |
| 8.0.0-preview.5.23280.8 | 414,260 | 6/13/2023 | |
| 8.0.0-preview.4.23259.5 | 672,503 | 5/16/2023 | |
| 8.0.0-preview.3.23174.8 | 630,495 | 4/11/2023 | |
| 8.0.0-preview.2.23128.3 | 373,268 | 3/14/2023 | |
| 8.0.0-preview.1.23110.8 | 373,044 | 2/21/2023 | |
| 7.0.1 | 150,230,301 | 2/14/2023 | |
| 7.0.0 | 339,725,482 | 11/7/2022 | |
| 7.0.0-rc.2.22472.3 | 5,322,662 | 10/11/2022 | |
| 7.0.0-rc.1.22426.10 | 493,259 | 9/14/2022 | |
| 7.0.0-preview.7.22375.6 | 452,990 | 8/9/2022 | |
| 7.0.0-preview.6.22324.4 | 289,098 | 7/12/2022 | |
| 7.0.0-preview.5.22301.12 | 204,038 | 6/14/2022 | |
| 7.0.0-preview.4.22229.4 | 453,963 | 5/10/2022 | |
| 7.0.0-preview.3.22175.4 | 202,760 | 4/13/2022 | |
| 7.0.0-preview.2.22152.2 | 273,672 | 3/14/2022 | |
| 7.0.0-preview.1.22076.8 | 183,977 | 2/17/2022 | |
| 6.0.1 | 12,485,021 | 11/12/2024 | |
| 6.0.0 | 904,423,912 | 11/8/2021 | |
| 6.0.0-rc.2.21480.5 | 2,008,605 | 10/12/2021 | |
| 6.0.0-rc.1.21451.13 | 752,958 | 9/14/2021 | |
| 6.0.0-preview.7.21377.19 | 809,901 | 8/10/2021 | |
| 6.0.0-preview.6.21352.12 | 378,577 | 7/14/2021 | |
| 6.0.0-preview.5.21301.5 | 376,946 | 6/15/2021 | |
| 6.0.0-preview.4.21253.7 | 210,140 | 5/24/2021 | |
| 6.0.0-preview.3.21201.4 | 682,467 | 4/8/2021 | |
| 6.0.0-preview.2.21154.6 | 224,097 | 3/11/2021 | |
| 6.0.0-preview.1.21102.12 | 577,616 | 2/12/2021 | |
| 5.0.0 | 631,560,101 | 11/9/2020 | |
| 5.0.0-rc.2.20475.5 | 1,103,352 | 10/13/2020 | |
| 5.0.0-rc.1.20451.14 | 848,926 | 9/14/2020 | |
| 5.0.0-preview.8.20407.11 | 631,312 | 8/25/2020 | |
| 5.0.0-preview.7.20364.11 | 260,471 | 7/21/2020 | |
| 5.0.0-preview.6.20305.6 | 175,105 | 6/25/2020 | |
| 5.0.0-preview.5.20278.1 | 103,060 | 6/10/2020 | |
| 5.0.0-preview.4.20251.6 | 327,501 | 5/18/2020 | |
| 5.0.0-preview.3.20215.2 | 247,507 | 4/23/2020 | |
| 5.0.0-preview.2.20160.3 | 363,711 | 4/2/2020 | |
| 5.0.0-preview.1.20120.4 | 185,187 | 3/16/2020 | |
| 3.1.32 | 40,782,824 | 12/13/2022 | |
| 3.1.31 | 4,877,378 | 11/8/2022 | |
| 3.1.30 | 3,373,001 | 10/11/2022 | |
| 3.1.29 | 3,290,413 | 9/13/2022 | |
| 3.1.28 | 7,924,945 | 8/9/2022 | |
| 3.1.27 | 3,045,974 | 7/12/2022 | |
| 3.1.26 | 2,468,356 | 6/14/2022 | |
| 3.1.25 | 4,123,573 | 5/10/2022 | |
| 3.1.24 | 5,228,713 | 4/11/2022 | |
| 3.1.23 | 5,053,446 | 3/8/2022 | |
| 3.1.22 | 26,286,368 | 12/14/2021 | |
| 3.1.21 | 13,565,417 | 11/7/2021 | |
| 3.1.20 | 6,466,396 | 10/11/2021 | |
| 3.1.19 | 6,274,629 | 9/14/2021 | |
| 3.1.18 | 77,467,743 | 8/10/2021 | |
| 3.1.17 | 8,199,469 | 7/13/2021 | |
| 3.1.16 | 18,660,102 | 6/8/2021 | |
| 3.1.15 | 9,917,511 | 5/11/2021 | |
| 3.1.14 | 21,690,742 | 4/6/2021 | |
| 3.1.13 | 17,004,307 | 3/9/2021 | |
| 3.1.12 | 13,227,587 | 2/9/2021 | |
| 3.1.11 | 22,891,388 | 1/12/2021 | |
| 3.1.10 | 32,724,239 | 11/9/2020 | |
| 3.1.9 | 88,708,957 | 10/13/2020 | |
| 3.1.8 | 84,303,052 | 9/8/2020 | |
| 3.1.7 | 47,682,872 | 8/11/2020 | |
| 3.1.6 | 51,421,200 | 7/14/2020 | |
| 3.1.5 | 50,635,993 | 6/9/2020 | |
| 3.1.4 | 75,410,441 | 5/12/2020 | |
| 3.1.3 | 155,686,445 | 3/24/2020 | |
| 3.1.2 | 87,733,358 | 2/18/2020 | |
| 3.1.1 | 49,711,647 | 1/14/2020 | |
| 3.1.0 | 272,725,819 | 12/3/2019 | |
| 3.1.0-preview3.19553.2 | 2,482,694 | 11/13/2019 | |
| 3.1.0-preview2.19525.4 | 259,863 | 11/1/2019 | |
| 3.1.0-preview1.19506.1 | 1,393,764 | 10/15/2019 | |
| 3.0.3 | 101,158,397 | 2/18/2020 | |
| 3.0.2 | 1,326,716 | 1/14/2020 | |
| 3.0.1 | 6,410,126 | 11/18/2019 | |
| 3.0.0 | 199,080,601 | 9/23/2019 | |
| 3.0.0-rc1.19456.10 | 190,007 | 9/16/2019 | |
| 3.0.0-preview9.19423.4 | 1,740,193 | 9/4/2019 | |
| 3.0.0-preview8.19405.4 | 655,429 | 8/13/2019 | |
| 3.0.0-preview7.19362.4 | 209,188 | 7/23/2019 | |
| 3.0.0-preview6.19304.6 | 528,343 | 6/12/2019 | |
| 3.0.0-preview5.19227.9 | 872,659 | 5/6/2019 | |
| 3.0.0-preview4.19216.2 | 56,967 | 4/18/2019 | |
| 3.0.0-preview3.19153.1 | 354,787 | 3/6/2019 | |
| 3.0.0-preview.19074.2 | 182,966 | 1/29/2019 | |
| 3.0.0-preview.18572.1 | 173,353 | 12/4/2018 | |
| 2.2.0 | 816,893,281 | 12/3/2018 | |
| 2.2.0-preview3-35497 | 635,424 | 10/17/2018 | |
| 2.2.0-preview2-35157 | 581,847 | 9/12/2018 | |
| 2.2.0-preview1-35029 | 271,519 | 8/22/2018 | |
| 2.1.1 | 628,243,022 | 6/18/2018 | |
| 2.1.0 | 544,624,113 | 5/29/2018 | |
| 2.1.0-rc1-final | 762,416 | 5/6/2018 | |
| 2.1.0-preview2-final | 1,001,030 | 4/10/2018 | |
| 2.1.0-preview1-final | 867,886 | 2/26/2018 | |
| 2.0.2 | 40,369,906 | 5/7/2018 | |
| 2.0.1 | 60,516,631 | 3/13/2018 | |
| 2.0.0 | 645,461,458 | 8/11/2017 | |
| 2.0.0-preview2-final | 501,601 | 6/28/2017 | |
| 2.0.0-preview1-final | 1,178,402 | 5/10/2017 | |
| 1.1.2 | 28,570,244 | 5/9/2017 | |
| 1.1.1 | 23,779,585 | 3/6/2017 | |
| 1.1.0 | 18,569,202 | 11/16/2016 | |
| 1.1.0-preview1-final | 317,143 | 10/24/2016 | |
| 1.0.2 | 124,703,574 | 3/6/2017 | |
| 1.0.1 | 3,975,505 | 12/12/2016 | |
| 1.0.0 | 370,534,578 | 6/27/2016 | |
| 1.0.0-rc2-final | 2,116,043 | 5/16/2016 |