Microsoft.Extensions.Options 9.0.0-preview.1.24080.9

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.

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

Packages Downloads
Microsoft.AspNetCore.Authentication.Abstractions
ASP.NET Core common types used by the various authentication components. This package was built from the source code at https://github.com/aspnet/HttpAbstractions/tree/91db78cf926939821bc96e8e60616cf5dde0b489
105
Microsoft.AspNetCore.Authentication.Abstractions
ASP.NET Core common types used by the various authentication components.
77
Microsoft.AspNetCore.Hosting
ASP.NET Core hosting infrastructure and startup logic for web applications. This package was built from the source code at https://github.com/aspnet/AspNetCore/tree/be0a4a7f4cf06cbd6ec714bd1d9afee6bdb040a8
75
Microsoft.AspNetCore.Authentication.Abstractions
ASP.NET Core common types used by the various authentication components.
69
Microsoft.AspNetCore.Authentication.Abstractions
ASP.NET Core common types used by the various authentication components. This package was built from the source at: https://github.com/aspnet/HttpAbstractions/tree/14076d94c38960787772ea7999c7aa159afbba2b
67
Microsoft.AspNetCore.Authentication.Abstractions
ASP.NET Core common types used by the various authentication components.
66
Microsoft.AspNetCore.Authentication.Abstractions
ASP.NET Core common types used by the various authentication components.
65
Microsoft.AspNetCore.Localization
ASP.NET Core middleware for automatically applying culture information to HTTP requests. Culture information can be specified in the HTTP header, query string, cookie, or custom source. This package was built from the source code at https://github.com/aspnet/Localization/tree/de1579bdda645ba8631403af8720929b76939853
65
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
65
Microsoft.AspNetCore.Http
ASP.NET Core default HTTP feature implementations.
65
Microsoft.AspNetCore.Cors
CORS middleware and policy for ASP.NET Core to enable cross-origin resource sharing. Commonly used types: Microsoft.AspNetCore.Cors.DisableCorsAttribute Microsoft.AspNetCore.Cors.EnableCorsAttribute This package was built from the source code at https://github.com/aspnet/CORS/tree/f05b0e792d2361be214947798857ef3eac77825d
64
Microsoft.AspNetCore.Authentication.Abstractions
ASP.NET Core common types used by the various authentication components.
64
Microsoft.AspNetCore.Authentication.Abstractions
ASP.NET Core common types used by the various authentication components. This package was built from the source at: https://github.com/aspnet/HttpAbstractions/tree/800c79c0e4d3ee7423e9a255ad398e429659912f
63
Microsoft.AspNetCore.Authentication.Abstractions
ASP.NET Core common types used by the various authentication components.
63
Microsoft.AspNetCore.DataProtection
ASP.NET Core logic to protect and unprotect data, similar to DPAPI. This package was built from the source code at https://github.com/dotnet/aspnetcore/tree/2670c128d522473e146ff9f8159bfffdfe694cd9
62
Microsoft.AspNetCore.Hosting
ASP.NET Core hosting infrastructure and startup logic for web applications.
62
Microsoft.AspNetCore.Routing
ASP.NET Core middleware for routing requests to application logic and for generating links. Commonly used types: Microsoft.AspNetCore.Routing.Route Microsoft.AspNetCore.Routing.RouteCollection
62
Microsoft.AspNetCore.Authentication.Abstractions
ASP.NET Core common types used by the various authentication components.
61
Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets
Managed socket transport for the ASP.NET Core Kestrel cross-platform web server.
60
Microsoft.AspNetCore.Http
ASP.NET Core default HTTP feature implementations.
60

.NET Framework 4.6.2

.NET 8.0

.NET 9.0

.NET Standard 2.0

.NET Standard 2.1

Version Downloads Last updated
9.0.0-rc.2.24473.5 5 10/16/2024
9.0.0-rc.1.24431.7 10 9/13/2024
9.0.0-preview.7.24405.7 10 8/13/2024
9.0.0-preview.6.24327.7 18 7/10/2024
9.0.0-preview.5.24306.7 9 6/15/2024
9.0.0-preview.4.24266.19 10 5/24/2024
9.0.0-preview.3.24172.9 14 4/13/2024
9.0.0-preview.2.24128.5 15 3/21/2024
9.0.0-preview.1.24080.9 17 2/26/2024
8.0.2 19 2/26/2024
8.0.1 22 1/11/2024
8.0.0 21 11/16/2023
8.0.0-rc.2.23479.6 22 10/13/2023
8.0.0-rc.1.23419.4 25 9/15/2023
8.0.0-preview.7.23375.6 28 8/20/2023
8.0.0-preview.6.23329.7 23 7/31/2023
8.0.0-preview.5.23280.8 26 7/31/2023
8.0.0-preview.4.23259.5 24 5/20/2023
8.0.0-preview.3.23174.8 34 5/12/2023
8.0.0-preview.2.23128.3 27 4/7/2023
8.0.0-preview.1.23110.8 30 2/23/2023
7.0.1 31 2/21/2023
7.0.0 39 12/3/2022
7.0.0-rc.2.22472.3 28 11/12/2022
7.0.0-rc.1.22426.10 30 9/15/2022
7.0.0-preview.7.22375.6 36 9/15/2022
7.0.0-preview.6.22324.4 33 9/15/2022
7.0.0-preview.5.22301.12 33 6/26/2022
7.0.0-preview.4.22229.4 28 7/2/2022
7.0.0-preview.3.22175.4 30 7/2/2022
7.0.0-preview.2.22152.2 31 7/2/2022
7.0.0-preview.1.22076.8 37 7/2/2022
6.0.2-mauipre.1.22102.15 37 7/2/2022
6.0.2-mauipre.1.22054.8 34 7/2/2022
6.0.0 37 7/2/2022
6.0.0-rc.2.21480.5 36 7/2/2022
6.0.0-rc.1.21451.13 32 7/2/2022
6.0.0-preview.7.21377.19 25 7/2/2022
6.0.0-preview.6.21352.12 33 7/2/2022
6.0.0-preview.5.21301.5 21 7/2/2022
6.0.0-preview.4.21253.7 41 7/2/2022
6.0.0-preview.3.21201.4 42 7/2/2022
6.0.0-preview.2.21154.6 31 7/2/2022
6.0.0-preview.1.21102.12 39 7/2/2022
5.0.0 39 7/2/2022
5.0.0-rc.2.20475.5 38 7/2/2022
5.0.0-rc.1.20451.14 28 7/2/2022
5.0.0-preview.8.20407.11 32 7/2/2022
5.0.0-preview.7.20364.11 30 7/2/2022
5.0.0-preview.6.20305.6 35 7/2/2022
5.0.0-preview.5.20278.1 27 7/2/2022
5.0.0-preview.4.20251.6 29 7/2/2022
5.0.0-preview.3.20215.2 44 7/2/2022
5.0.0-preview.2.20160.3 29 7/2/2022
5.0.0-preview.1.20120.4 39 7/2/2022
3.1.32 35 2/21/2023
3.1.31 35 12/3/2022
3.1.30 33 12/3/2022
3.1.29 37 9/15/2022
3.1.28 41 9/15/2022
3.1.27 39 9/15/2022
3.1.26 37 7/2/2022
3.1.25 39 7/2/2022
3.1.24 37 7/2/2022
3.1.23 35 7/2/2022
3.1.22 37 7/2/2022
3.1.21 36 7/2/2022
3.1.20 43 7/1/2022
3.1.19 30 7/1/2022
3.1.18 40 7/1/2022
3.1.17 42 7/1/2022
3.1.16 33 7/1/2022
3.1.15 35 7/1/2022
3.1.14 41 7/1/2022
3.1.13 40 7/1/2022
3.1.12 40 7/1/2022
3.1.11 34 7/1/2022
3.1.10 37 7/1/2022
3.1.9 38 7/2/2022
3.1.8 37 7/2/2022
3.1.7 30 7/2/2022
3.1.6 32 7/2/2022
3.1.5 35 7/2/2022
3.1.4 36 7/2/2022
3.1.3 30 7/2/2022
3.1.2 30 7/1/2022
3.1.1 38 7/1/2022
3.1.0 30 7/1/2022
3.1.0-preview3.19553.2 29 7/1/2022
3.1.0-preview2.19525.4 27 7/1/2022
3.1.0-preview1.19506.1 28 7/1/2022
3.0.3 36 7/1/2022
3.0.2 29 7/1/2022
3.0.1 41 7/1/2022
3.0.0 35 7/1/2022
3.0.0-rc1.19456.10 32 7/1/2022
3.0.0-preview9.19423.4 26 7/1/2022
3.0.0-preview8.19405.4 35 7/1/2022
3.0.0-preview7.19362.4 30 7/1/2022
3.0.0-preview6.19304.6 39 7/1/2022
3.0.0-preview5.19227.9 41 7/1/2022
3.0.0-preview4.19216.2 39 7/1/2022
3.0.0-preview3.19153.1 30 7/1/2022
3.0.0-preview.19074.2 32 7/1/2022
3.0.0-preview.18572.1 32 7/1/2022
2.2.0 28 7/1/2022
2.2.0-preview3-35497 28 7/1/2022
2.2.0-preview2-35157 33 7/1/2022
2.2.0-preview1-35029 29 7/1/2022
2.1.1 33 7/3/2022
2.1.0 39 7/3/2022
2.1.0-rc1-final 36 7/3/2022
2.1.0-preview2-final 48 7/3/2022
2.1.0-preview1-final 51 7/3/2022
2.0.2 36 7/3/2022
2.0.1 32 7/3/2022
2.0.0 31 7/3/2022
2.0.0-preview2-final 39 7/3/2022
2.0.0-preview1-final 35 7/3/2022
1.1.2 36 7/3/2022
1.1.1 37 7/3/2022
1.1.0 35 7/3/2022
1.1.0-preview1-final 28 7/3/2022
1.0.2 41 7/3/2022
1.0.1 31 7/3/2022
1.0.0 37 7/3/2022
1.0.0-rc2-final 44 7/3/2022