Microsoft.Extensions.Options 8.0.2

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
There is a newer prerelease version of this package available.
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
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" Version="8.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Microsoft.Extensions.Options --version 8.0.2
#r "nuget: Microsoft.Extensions.Options, 8.0.2"
#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.
// 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, and IOptionsMonitor
  • IValidateOptions and ValidateOptions
  • OptionsBuilder, OptionsFactory, OptionsMonitor, and OptionsManager
  • OptionsServiceCollectionExtensions
  • OptionsValidatorAttribute

Additional Documentation

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 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (5.2K)

Showing the top 5 NuGet packages that depend on Microsoft.Extensions.Options:

Package Downloads
Microsoft.Extensions.Logging The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Logging infrastructure default implementation for Microsoft.Extensions.Logging.

Microsoft.Extensions.Caching.Memory The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

In-memory cache implementation of Microsoft.Extensions.Caching.Memory.IMemoryCache.

Microsoft.Extensions.Options.ConfigurationExtensions The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Provides additional configuration specific functionality related to Options.

Microsoft.AspNetCore.Http The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

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 The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Configuration support for Microsoft.Extensions.Logging.

GitHub repositories (371)

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+.
dotnet/AspNetCore.Docs
Documentation for ASP.NET Core
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 and the ASP.NET Core platforms. Provides the fundamental infrastructure, production-ready startup templates, application modules, UI themes, tooling, guides and documentation.
aspnetboilerplate/aspnetboilerplate
ASP.NET Boilerplate - Web Application Framework
Version Downloads Last updated
9.0.0-preview.3.24172.9 59,040 4/11/2024
9.0.0-preview.2.24128.5 63,342 3/12/2024
9.0.0-preview.1.24080.9 104,620 2/13/2024
8.0.2 12,355,174 2/13/2024
8.0.1 7,973,018 1/9/2024
8.0.0 54,885,364 11/14/2023
8.0.0-rc.2.23479.6 1,283,962 10/10/2023
8.0.0-rc.1.23419.4 881,078 9/12/2023
8.0.0-preview.7.23375.6 401,935 8/8/2023
8.0.0-preview.6.23329.7 320,437 7/11/2023
8.0.0-preview.5.23280.8 234,713 6/13/2023
8.0.0-preview.4.23259.5 369,688 5/16/2023
8.0.0-preview.3.23174.8 294,743 4/11/2023
8.0.0-preview.2.23128.3 287,257 3/14/2023
8.0.0-preview.1.23110.8 288,862 2/21/2023
7.0.1 83,415,616 2/14/2023
7.0.0 176,179,222 11/7/2022
7.0.0-rc.2.22472.3 602,319 10/11/2022
7.0.0-rc.1.22426.10 394,619 9/14/2022
7.0.0-preview.7.22375.6 382,407 8/9/2022
7.0.0-preview.6.22324.4 221,048 7/12/2022
7.0.0-preview.5.22301.12 179,543 6/14/2022
7.0.0-preview.4.22229.4 333,831 5/10/2022
7.0.0-preview.3.22175.4 168,591 4/13/2022
7.0.0-preview.2.22152.2 233,931 3/14/2022
7.0.0-preview.1.22076.8 146,865 2/17/2022
6.0.2-mauipre.1.22102.15 156,307 2/15/2022
6.0.2-mauipre.1.22054.8 293,177 1/19/2022
6.0.0 458,274,010 11/8/2021
6.0.0-rc.2.21480.5 1,678,843 10/12/2021
6.0.0-rc.1.21451.13 617,534 9/14/2021
6.0.0-preview.7.21377.19 720,560 8/10/2021
6.0.0-preview.6.21352.12 336,944 7/14/2021
6.0.0-preview.5.21301.5 321,426 6/15/2021
6.0.0-preview.4.21253.7 179,570 5/24/2021
6.0.0-preview.3.21201.4 591,089 4/8/2021
6.0.0-preview.2.21154.6 208,166 3/11/2021
6.0.0-preview.1.21102.12 543,630 2/12/2021
5.0.0 438,676,252 11/9/2020
5.0.0-rc.2.20475.5 964,484 10/13/2020
5.0.0-rc.1.20451.14 788,974 9/14/2020
5.0.0-preview.8.20407.11 523,625 8/25/2020
5.0.0-preview.7.20364.11 240,374 7/21/2020
5.0.0-preview.6.20305.6 163,418 6/25/2020
5.0.0-preview.5.20278.1 85,981 6/10/2020
5.0.0-preview.4.20251.6 318,064 5/18/2020
5.0.0-preview.3.20215.2 232,627 4/23/2020
5.0.0-preview.2.20160.3 341,631 4/2/2020
5.0.0-preview.1.20120.4 177,178 3/16/2020
3.1.32 12,722,228 12/13/2022
3.1.31 2,272,619 11/8/2022
3.1.30 1,982,993 10/11/2022
3.1.29 1,852,519 9/13/2022
3.1.28 5,289,554 8/9/2022
3.1.27 1,961,598 7/12/2022
3.1.26 1,716,594 6/14/2022
3.1.25 3,062,834 5/10/2022
3.1.24 3,413,624 4/11/2022
3.1.23 3,733,543 3/8/2022
3.1.22 15,585,425 12/14/2021
3.1.21 9,287,445 11/7/2021
3.1.20 4,472,060 10/11/2021
3.1.19 4,935,286 9/14/2021
3.1.18 54,018,361 8/10/2021
3.1.17 6,541,898 7/13/2021
3.1.16 11,607,364 6/8/2021
3.1.15 8,211,336 5/11/2021
3.1.14 17,568,106 4/6/2021
3.1.13 14,110,212 3/9/2021
3.1.12 10,868,197 2/9/2021
3.1.11 18,522,760 1/12/2021
3.1.10 26,981,173 11/9/2020
3.1.9 67,049,088 10/13/2020
3.1.8 68,695,725 9/8/2020
3.1.7 37,353,675 8/11/2020
3.1.6 42,654,255 7/14/2020
3.1.5 43,352,046 6/9/2020
3.1.4 54,466,697 5/12/2020
3.1.3 94,135,602 3/24/2020
3.1.2 73,679,246 2/18/2020
3.1.1 42,114,185 1/14/2020
3.1.0 152,599,205 12/3/2019
3.1.0-preview3.19553.2 1,617,094 11/13/2019
3.1.0-preview2.19525.4 219,663 11/1/2019
3.1.0-preview1.19506.1 1,201,124 10/15/2019
3.0.3 57,278,507 2/18/2020
3.0.2 1,137,442 1/14/2020
3.0.1 5,539,294 11/18/2019
3.0.0 164,407,301 9/23/2019
3.0.0-rc1.19456.10 166,995 9/16/2019
3.0.0-preview9.19423.4 1,629,295 9/4/2019
3.0.0-preview8.19405.4 571,475 8/13/2019
3.0.0-preview7.19362.4 188,495 7/23/2019
3.0.0-preview6.19304.6 416,673 6/12/2019
3.0.0-preview5.19227.9 786,552 5/6/2019
3.0.0-preview4.19216.2 54,039 4/18/2019
3.0.0-preview3.19153.1 330,261 3/6/2019
3.0.0-preview.19074.2 170,427 1/29/2019
3.0.0-preview.18572.1 157,435 12/4/2018
2.2.0 522,495,895 12/3/2018
2.2.0-preview3-35497 593,064 10/17/2018
2.2.0-preview2-35157 536,624 9/12/2018
2.2.0-preview1-35029 255,979 8/22/2018
2.1.1 351,447,185 6/18/2018
2.1.0 351,974,292 5/29/2018
2.1.0-rc1-final 645,160 5/6/2018
2.1.0-preview2-final 877,110 4/10/2018
2.1.0-preview1-final 808,811 2/26/2018
2.0.2 30,555,935 5/7/2018
2.0.1 51,555,704 3/13/2018
2.0.0 492,592,532 8/11/2017
2.0.0-preview2-final 403,048 6/28/2017
2.0.0-preview1-final 1,104,214 5/10/2017
1.1.2 23,345,960 5/9/2017
1.1.1 19,883,493 3/6/2017
1.1.0 14,690,336 11/16/2016
1.1.0-preview1-final 309,677 10/24/2016
1.0.2 114,613,278 3/6/2017
1.0.1 3,699,556 12/12/2016
1.0.0 226,988,573 6/27/2016
1.0.0-rc2-final 2,042,872 5/16/2016