Microsoft.Extensions.Options.DataAnnotations
9.0.6
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.
There is a newer prerelease version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package Microsoft.Extensions.Options.DataAnnotations --version 9.0.6
NuGet\Install-Package Microsoft.Extensions.Options.DataAnnotations -Version 9.0.6
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.DataAnnotations" Version="9.0.6" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Microsoft.Extensions.Options.DataAnnotations" Version="9.0.6" />
<PackageReference Include="Microsoft.Extensions.Options.DataAnnotations" />
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.DataAnnotations --version 9.0.6
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Microsoft.Extensions.Options.DataAnnotations, 9.0.6"
#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.
#addin nuget:?package=Microsoft.Extensions.Options.DataAnnotations&version=9.0.6
#tool nuget:?package=Microsoft.Extensions.Options.DataAnnotations&version=9.0.6
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
About
Microsoft.Extensions.Options.DataAnnotations is a library that adds extra validation functionality to configuration options using data annotations.
It allows to apply validation rules to configuration classes to ensure they are correctly configured before the application starts running.
This way, misconfiguration issues are catched early during the application startup rather than facing them later in production.
Key Features
- Enables validation of configuration options using data annotations.
- Early detection of misconfiguration issues during application startup.
How to Use
While configuring services, chain the ValidateDataAnnotations() and ValidateOnStart() methods to the AddOptions method for your configuration class.
Here is a simple example demonstrating how to validate options on application startup:
services
.AddOptions<MyOptions>()
.ValidateDataAnnotations()
.ValidateOnStart();
In the configuration class, use data annotations to specify the validation rules.
For instance, in the following MyOptions class, the Name property is marked as required:
using System.ComponentModel.DataAnnotations;
public class MyOptions
{
[Required(AllowEmptyStrings = false)]
public string Name { get; set; }
}
With this setup, an error indicating that the Name field is required will be thrown upon startup if it hasn't been configured.
Main Types
The main types provided by this library are:
Microsoft.Extensions.Options.DataAnnotationsValidateOptions<TOptions>Microsoft.Extensions.DependencyInjection.OptionsBuilderDataAnnotationsExtensions
Additional Documentation
Related Packages
Core options: Microsoft.Extensions.Options
Feedback & Contributing
Microsoft.Extensions.Options.DataAnnotations 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 was computed. 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. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETFramework 4.6.2
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 9.0.6)
- Microsoft.Extensions.Options (>= 9.0.6)
-
.NETStandard 2.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 9.0.6)
- Microsoft.Extensions.Options (>= 9.0.6)
- System.ComponentModel.Annotations (>= 5.0.0)
-
.NETStandard 2.1
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 9.0.6)
- Microsoft.Extensions.Options (>= 9.0.6)
- System.ComponentModel.Annotations (>= 5.0.0)
-
net8.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 9.0.6)
- Microsoft.Extensions.Options (>= 9.0.6)
-
net9.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 9.0.6)
- Microsoft.Extensions.Options (>= 9.0.6)
NuGet packages (405)
Showing the top 5 NuGet packages that depend on Microsoft.Extensions.Options.DataAnnotations:
| Package | Downloads |
|---|---|
|
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. |
|
|
Umbraco.Cms.Core
Contains the core assembly needed to run Umbraco CMS. |
|
|
VirtoCommerce.Platform.Core
Virto Commerce is a flexible B2B ecommerce solution that offers powerful tools for enterprise business users. https://virtocommerce.com |
|
|
Stl
Stl ("ServiceTitan Library") is a collection of relatively small abstractions or methods we couldn't find in BCL. A part of Stl.Fusion. |
GitHub repositories (27)
Showing the top 20 popular GitHub repositories that depend on Microsoft.Extensions.Options.DataAnnotations:
| Repository | Stars |
|---|---|
|
microsoft/semantic-kernel
Integrate cutting-edge LLM technology quickly and easily into your apps
|
|
|
umbraco/Umbraco-CMS
Umbraco is a free and open source .NET content management system helping you deliver delightful digital experiences.
|
|
|
TelegramBots/Telegram.Bot
.NET Client for Telegram Bot API
|
|
|
servicetitan/Stl.Fusion
Build real-time apps (Blazor included) with less than 1% of extra code responsible for real-time updates. Host 10-1000x faster APIs relying on transparent and nearly 100% consistent caching. We call it DREAM, or Distributed REActive Memoization, and it's here to turn real-time on!
|
|
|
Finbuckle/Finbuckle.MultiTenant
Finbuckle.MultiTenant is an open-source multitenancy middleware library for .NET. It enables tenant resolution, per-tenant app behavior, and per-tenant data isolation.
|
|
|
VirtoCommerce/vc-platform
Virto Commerce B2B Innovation Platform
|
|
|
bitfoundation/bitplatform
Build all of your apps using what you already know and love ❤️
|
|
|
mehdihadeli/food-delivery-microservices
🍔 A practical and imaginary food delivery microservices, built with .Net 9, MassTransit, Domain-Driven Design, CQRS, Vertical Slice Architecture, Event-Driven Architecture, and the latest technologies.
|
|
|
notifo-io/notifo
Multi channel notification service for collaboration tools, e-commerce, news service and more.
|
|
|
bdovaz/UnityNuGet
Provides a service to install NuGet packages into a Unity project via the Unity Package Manager
|
|
|
fullstackhero/dotnet-microservices-boilerplate
The Ultimate Microservices Starter Kit for .NET Developers!
|
|
|
planetarium/libplanet
Blockchain in C#/.NET for on-chain, decentralized gaming
|
|
|
jeangatto/ASP.NET-Core-Clean-Architecture-CQRS-Event-Sourcing
ASP.NET Core, C#, CQRS Event Sourcing, REST API, DDD, SOLID Principles and Clean Architecture
|
|
|
Jcparkyn/nodexr
Graphical regular expression editor
|
|
|
AntonioFalcaoJr/EventualShop
A state-of-the-art distributed system using Reactive DDD as uncertainty modeling, Event Storming as subdomain decomposition, Event Sourcing as an eventual persistence mechanism, CQRS, Async Projections, Microservices for individual deployable units, Event-driven Architecture for efficient integration, and Clean Architecture as domain-centric design
|
|
|
mehdihadeli/food-delivery-modular-monolith
🌭 A practical and imaginary food and grocery delivery modular monolith, built with .Net 8, Domain-Driven Design, CQRS, Vertical Slice Architecture, Event-Driven Architecture, and the latest technologies.
|
|
|
dotnet/systemweb-adapters
|
|
|
Bryan-Cyf/SuperShortLink
这是一个基于.NET开源的短链生成及监控系统，包含了短URL的生成、短URL跳转长URL、短URL访问统计以及Web后台监控页面，可以帮助我们更容易地生成短链、监控短链！
|
|
|
NetCordDev/NetCord
A modern, lightweight, and customizable C# Discord library with Native AOT support, immutable caching, voice capabilities, and complete API coverage.
|
|
|
microsoft/durabletask-dotnet
Out-of-process .NET SDK for the Durable Task Framework
|
| Version | Downloads | Last updated | |
|---|---|---|---|
| 10.0.0-preview.5.25277.114 | 206 | 6/6/2025 | |
| 10.0.0-preview.4.25258.110 | 1,069 | 5/12/2025 | |
| 10.0.0-preview.3.25171.5 | 1,383 | 4/10/2025 | |
| 10.0.0-preview.2.25163.2 | 1,847 | 3/18/2025 | |
| 10.0.0-preview.1.25080.5 | 836 | 2/25/2025 | |
| 9.0.6 | 29,460 | 6/10/2025 | |
| 9.0.5 | 295,217 | 5/13/2025 | |
| 9.0.4 | 552,717 | 4/8/2025 | |
| 9.0.3 | 598,175 | 3/11/2025 | |
| 9.0.2 | 793,318 | 2/11/2025 | |
| 9.0.1 | 737,091 | 1/14/2025 | |
| 9.0.0 | 1,624,574 | 11/12/2024 | |
| 9.0.0-rc.2.24473.5 | 11,532 | 10/8/2024 | |
| 9.0.0-rc.1.24431.7 | 6,232 | 9/10/2024 | |
| 9.0.0-preview.7.24405.7 | 2,652 | 8/13/2024 | |
| 9.0.0-preview.6.24327.7 | 6,404 | 7/9/2024 | |
| 9.0.0-preview.5.24306.7 | 987 | 6/11/2024 | |
| 9.0.0-preview.4.24266.19 | 2,844 | 5/21/2024 | |
| 9.0.0-preview.3.24172.9 | 6,660 | 4/11/2024 | |
| 9.0.0-preview.2.24128.5 | 906 | 3/12/2024 | |
| 9.0.0-preview.1.24080.9 | 3,267 | 2/13/2024 | |
| 8.0.0 | 18,457,256 | 11/14/2023 | |
| 8.0.0-rc.2.23479.6 | 15,602 | 10/10/2023 | |
| 8.0.0-rc.1.23419.4 | 13,612 | 9/12/2023 | |
| 8.0.0-preview.7.23375.6 | 6,054 | 8/8/2023 | |
| 8.0.0-preview.6.23329.7 | 1,811 | 7/11/2023 | |
| 8.0.0-preview.5.23280.8 | 2,545 | 6/13/2023 | |
| 8.0.0-preview.4.23259.5 | 1,018 | 5/16/2023 | |
| 8.0.0-preview.3.23174.8 | 3,129 | 4/11/2023 | |
| 8.0.0-preview.2.23128.3 | 1,369 | 3/14/2023 | |
| 8.0.0-preview.1.23110.8 | 10,717 | 2/21/2023 | |
| 7.0.0 | 8,927,865 | 11/7/2022 | |
| 7.0.0-rc.2.22472.3 | 18,043 | 10/11/2022 | |
| 7.0.0-rc.1.22426.10 | 7,130 | 9/14/2022 | |
| 7.0.0-preview.7.22375.6 | 3,548 | 8/9/2022 | |
| 7.0.0-preview.6.22324.4 | 1,984 | 7/12/2022 | |
| 7.0.0-preview.5.22301.12 | 2,658 | 6/14/2022 | |
| 7.0.0-preview.4.22229.4 | 3,921 | 5/10/2022 | |
| 7.0.0-preview.3.22175.4 | 1,021 | 4/13/2022 | |
| 7.0.0-preview.2.22152.2 | 890 | 3/14/2022 | |
| 7.0.0-preview.1.22076.8 | 1,041 | 2/17/2022 | |
| 6.0.1 | 75,739 | 11/12/2024 | |
| 6.0.0 | 17,863,432 | 11/8/2021 | |
| 6.0.0-rc.2.21480.5 | 2,337 | 10/12/2021 | |
| 6.0.0-rc.1.21451.13 | 3,525 | 9/14/2021 | |
| 6.0.0-preview.7.21377.19 | 2,796 | 8/10/2021 | |
| 6.0.0-preview.6.21352.12 | 7,911 | 7/14/2021 | |
| 6.0.0-preview.5.21301.5 | 604 | 6/15/2021 | |
| 6.0.0-preview.4.21253.7 | 1,173 | 5/24/2021 | |
| 6.0.0-preview.3.21201.4 | 524 | 4/8/2021 | |
| 6.0.0-preview.2.21154.6 | 642 | 3/11/2021 | |
| 6.0.0-preview.1.21102.12 | 631 | 2/12/2021 | |
| 5.0.0 | 8,524,544 | 11/9/2020 | |
| 5.0.0-rc.2.20475.5 | 950 | 10/13/2020 | |
| 5.0.0-rc.1.20451.14 | 786 | 9/14/2020 | |
| 5.0.0-preview.8.20407.11 | 817 | 8/25/2020 | |
| 5.0.0-preview.7.20364.11 | 932 | 7/21/2020 | |
| 5.0.0-preview.6.20305.6 | 1,337 | 6/25/2020 | |
| 5.0.0-preview.5.20278.1 | 34,284 | 6/10/2020 | |
| 5.0.0-preview.4.20251.6 | 747 | 5/18/2020 | |
| 5.0.0-preview.3.20215.2 | 679 | 4/23/2020 | |
| 5.0.0-preview.2.20160.3 | 690 | 4/2/2020 | |
| 5.0.0-preview.1.20120.4 | 697 | 3/16/2020 | |
| 3.1.32 | 85,066 | 12/13/2022 | |
| 3.1.31 | 5,537 | 11/8/2022 | |
| 3.1.30 | 4,172 | 10/11/2022 | |
| 3.1.29 | 13,787 | 9/13/2022 | |
| 3.1.28 | 40,961 | 8/9/2022 | |
| 3.1.27 | 6,411 | 7/12/2022 | |
| 3.1.26 | 22,035 | 6/14/2022 | |
| 3.1.25 | 72,715 | 5/10/2022 | |
| 3.1.24 | 34,324 | 4/11/2022 | |
| 3.1.23 | 55,406 | 3/8/2022 | |
| 3.1.22 | 345,537 | 12/14/2021 | |
| 3.1.21 | 842,105 | 11/7/2021 | |
| 3.1.20 | 51,099 | 10/11/2021 | |
| 3.1.19 | 94,546 | 9/14/2021 | |
| 3.1.18 | 572,345 | 8/10/2021 | |
| 3.1.17 | 108,307 | 7/13/2021 | |
| 3.1.16 | 62,516 | 6/8/2021 | |
| 3.1.15 | 329,678 | 5/11/2021 | |
| 3.1.14 | 287,441 | 4/6/2021 | |
| 3.1.13 | 377,146 | 3/9/2021 | |
| 3.1.12 | 240,854 | 2/9/2021 | |
| 3.1.11 | 67,739 | 1/12/2021 | |
| 3.1.10 | 508,369 | 11/9/2020 | |
| 3.1.9 | 296,076 | 10/13/2020 | |
| 3.1.8 | 1,049,824 | 9/8/2020 | |
| 3.1.7 | 596,729 | 8/11/2020 | |
| 3.1.6 | 162,256 | 7/14/2020 | |
| 3.1.5 | 356,612 | 6/9/2020 | |
| 3.1.4 | 474,396 | 5/12/2020 | |
| 3.1.3 | 320,770 | 3/24/2020 | |
| 3.1.2 | 1,678,256 | 2/18/2020 | |
| 3.1.1 | 194,668 | 1/14/2020 | |
| 3.1.0 | 582,874 | 12/3/2019 | |
| 3.1.0-preview3.19553.2 | 845 | 11/13/2019 | |
| 3.1.0-preview2.19525.4 | 1,190 | 11/1/2019 | |
| 3.1.0-preview1.19506.1 | 1,781 | 10/15/2019 | |
| 3.0.3 | 6,227 | 2/18/2020 | |
| 3.0.2 | 3,963 | 1/14/2020 | |
| 3.0.1 | 9,602 | 11/18/2019 | |
| 3.0.0 | 237,552 | 9/23/2019 | |
| 3.0.0-rc1.19456.10 | 1,594 | 9/16/2019 | |
| 3.0.0-preview9.19423.4 | 1,757 | 9/4/2019 | |
| 3.0.0-preview8.19405.4 | 1,677 | 8/13/2019 | |
| 3.0.0-preview7.19362.4 | 1,229 | 7/23/2019 | |
| 3.0.0-preview6.19304.6 | 4,801 | 6/12/2019 | |
| 3.0.0-preview5.19227.9 | 1,437 | 5/6/2019 | |
| 3.0.0-preview4.19216.2 | 4,008 | 4/18/2019 | |
| 3.0.0-preview3.19153.1 | 774 | 3/6/2019 | |
| 3.0.0-preview.19074.2 | 779 | 1/29/2019 | |
| 3.0.0-preview.18572.1 | 807 | 12/4/2018 | |
| 2.2.0 | 14,524,182 | 12/3/2018 | |
| 2.2.0-preview3-35497 | 63,312 | 10/17/2018 | |
| 2.2.0-preview2-35157 | 5,088 | 9/12/2018 |