Microsoft.Extensions.Options.DataAnnotations 9.0.18

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

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.

Showing the top 20 packages that depend on Microsoft.Extensions.Options.DataAnnotations.

Packages Downloads
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.
 123
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.
 125
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.
 126
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.
 133
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.
 137
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.
 142
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.
 145
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.
 150
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.
 153
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. This package was built from the source at: https://github.com/aspnet/Universe/tree/1016eae4004686f7fdad13f5c329f63bbae1f3a1
 144
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. This package was built from the source at: https://github.com/aspnet/Universe/tree/244e037a222a7cd0a17feafb7f3a625fde40de97
 129

https://go.microsoft.com/fwlink/?LinkID=799421

.NET Framework 4.6.2

.NET Standard 2.1

.NET Standard 2.0

.NET 9.0

.NET 8.0

Version Downloads Last updated
11.0.0-preview.6.26359.118 3 07/18/2026
11.0.0-preview.5.26302.115 13 06/10/2026
11.0.0-preview.4.26230.115 19 05/13/2026
11.0.0-preview.3.26207.106 28 04/14/2026
11.0.0-preview.2.26159.112 32 03/12/2026
11.0.0-preview.1.26104.118 37 02/11/2026
10.0.10 4 07/16/2026
10.0.9 19 06/10/2026
10.0.8 23 05/13/2026
10.0.7 30 04/21/2026
10.0.6 26 04/14/2026
10.0.5 28 03/16/2026
10.0.4 30 03/12/2026
10.0.3 33 02/11/2026
10.0.2 38 01/13/2026
10.0.1 60 12/10/2025
10.0.0 66 11/12/2025
10.0.0-rc.2.25502.107 87 10/15/2025
10.0.0-rc.1.25451.107 114 09/10/2025
10.0.0-preview.7.25380.108 100 08/14/2025
10.0.0-preview.6.25358.103 119 07/16/2025
10.0.0-preview.5.25277.114 101 06/10/2025
10.0.0-preview.4.25258.110 129 05/16/2025
10.0.0-preview.3.25171.5 121 04/11/2025
10.0.0-preview.2.25163.2 144 04/01/2025
10.0.0-preview.1.25080.5 123 03/30/2025
9.0.18 3 07/17/2026
9.0.17 14 06/10/2026
9.0.16 17 05/13/2026
9.0.15 27 04/14/2026
9.0.14 27 03/12/2026
9.0.13 40 02/11/2026
9.0.12 40 01/13/2026
9.0.11 75 11/12/2025
9.0.10 87 10/15/2025
9.0.9 80 09/10/2025
9.0.8 102 08/06/2025
9.0.7 102 07/09/2025
9.0.6 94 06/12/2025
9.0.5 131 05/18/2025
9.0.4 130 04/11/2025
9.0.3 117 03/30/2025
9.0.2 131 03/30/2025
9.0.1 124 03/30/2025
9.0.0 138 11/15/2024
9.0.0-rc.2.24473.5 135 10/19/2024
9.0.0-rc.1.24431.7 131 09/21/2024
9.0.0-preview.7.24405.7 117 08/30/2024
9.0.0-preview.6.24327.7 146 07/20/2024
9.0.0-preview.5.24306.7 155 07/20/2024
9.0.0-preview.4.24266.19 168 07/20/2024
9.0.0-preview.3.24172.9 143 07/20/2024
9.0.0-preview.2.24128.5 132 07/20/2024
9.0.0-preview.1.24080.9 140 07/20/2024
8.0.0 150 07/20/2024
8.0.0-rc.2.23479.6 132 07/20/2024
8.0.0-rc.1.23419.4 119 07/20/2024
8.0.0-preview.7.23375.6 124 07/20/2024
8.0.0-preview.6.23329.7 129 07/20/2024
8.0.0-preview.5.23280.8 122 07/20/2024
8.0.0-preview.4.23259.5 136 07/20/2024
8.0.0-preview.3.23174.8 129 07/20/2024
8.0.0-preview.2.23128.3 116 07/20/2024
8.0.0-preview.1.23110.8 135 07/20/2024
7.0.0 127 07/20/2024
7.0.0-rc.2.22472.3 154 07/20/2024
7.0.0-rc.1.22426.10 149 07/20/2024
7.0.0-preview.7.22375.6 125 07/20/2024
7.0.0-preview.6.22324.4 105 07/20/2024
7.0.0-preview.5.22301.12 125 07/20/2024
7.0.0-preview.4.22229.4 132 07/20/2024
7.0.0-preview.3.22175.4 121 07/20/2024
7.0.0-preview.2.22152.2 141 07/20/2024
7.0.0-preview.1.22076.8 142 07/20/2024
6.0.1 128 11/15/2024
6.0.0 112 07/20/2024
6.0.0-rc.2.21480.5 125 07/20/2024
6.0.0-rc.1.21451.13 124 07/20/2024
6.0.0-preview.7.21377.19 109 07/20/2024
6.0.0-preview.6.21352.12 136 07/20/2024
6.0.0-preview.5.21301.5 124 07/20/2024
6.0.0-preview.4.21253.7 125 07/20/2024
6.0.0-preview.3.21201.4 129 07/20/2024
6.0.0-preview.2.21154.6 121 07/20/2024
6.0.0-preview.1.21102.12 110 07/20/2024
5.0.0 124 07/20/2024
5.0.0-rc.2.20475.5 148 07/20/2024
5.0.0-rc.1.20451.14 103 07/20/2024
5.0.0-preview.8.20407.11 131 07/20/2024
5.0.0-preview.7.20364.11 115 07/20/2024
5.0.0-preview.6.20305.6 137 07/20/2024
5.0.0-preview.5.20278.1 119 07/20/2024
5.0.0-preview.4.20251.6 126 07/20/2024
5.0.0-preview.3.20215.2 133 07/20/2024
5.0.0-preview.2.20160.3 152 07/20/2024
5.0.0-preview.1.20120.4 142 07/20/2024
3.1.32 129 07/20/2024
3.1.31 125 07/20/2024
3.1.30 131 07/20/2024
3.1.29 118 07/20/2024
3.1.28 107 07/20/2024
3.1.27 127 07/20/2024
3.1.26 115 07/20/2024
3.1.25 130 07/20/2024
3.1.24 152 07/20/2024
3.1.23 147 07/20/2024
3.1.22 121 07/20/2024
3.1.21 140 07/20/2024
3.1.20 116 07/20/2024
3.1.19 114 07/20/2024
3.1.18 120 07/20/2024
3.1.17 135 07/20/2024
3.1.16 126 07/20/2024
3.1.15 141 07/20/2024
3.1.14 114 07/20/2024
3.1.13 114 07/20/2024
3.1.12 116 07/20/2024
3.1.11 137 07/20/2024
3.1.10 138 07/20/2024
3.1.9 147 07/20/2024
3.1.8 134 07/20/2024
3.1.7 112 07/20/2024
3.1.6 115 07/20/2024
3.1.5 108 07/20/2024
3.1.4 133 07/20/2024
3.1.3 122 07/20/2024
3.1.2 130 07/20/2024
3.1.1 118 07/20/2024
3.1.0 137 07/20/2024
3.1.0-preview3.19553.2 157 07/20/2024
3.1.0-preview2.19525.4 142 07/20/2024
3.1.0-preview1.19506.1 159 07/20/2024
3.0.3 130 07/20/2024
3.0.2 135 07/20/2024
3.0.1 113 07/20/2024
3.0.0 123 07/20/2024
3.0.0-rc1.19456.10 130 07/20/2024
3.0.0-preview9.19423.4 139 07/20/2024
3.0.0-preview8.19405.4 127 07/20/2024
3.0.0-preview7.19362.4 126 07/20/2024
3.0.0-preview6.19304.6 124 07/20/2024
3.0.0-preview5.19227.9 110 07/20/2024
3.0.0-preview4.19216.2 139 07/20/2024
3.0.0-preview3.19153.1 141 07/20/2024
3.0.0-preview.19074.2 154 07/20/2024
3.0.0-preview.18572.1 103 07/20/2024
2.2.0 127 07/20/2024
2.2.0-preview3-35497 136 07/20/2024
2.2.0-preview2-35157 132 07/20/2024