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
Dis.Common.Authorization
Package Description
19,257
Microsoft.AspNetCore.Authentication
ASP.NET Core common types used by the various authentication middleware components. This package was built from the source code at https://github.com/aspnet/Security/tree/93926543f8469614c2feb23de8a8c0561b8b2463
21,406
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
31,287
Microsoft.AspNetCore.Authorization
ASP.NET Core authorization classes. Commonly used types: Microsoft.AspNetCore.Authorization.AllowAnonymousAttribute Microsoft.AspNetCore.Authorization.AuthorizeAttribute This package was built from the source code at https://github.com/aspnet/Security/tree/93926543f8469614c2feb23de8a8c0561b8b2463
9,932
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/aspnet/AspNetCore/tree/ce8cf65589734f82b0536c543aba5bd60d0a5a98
21,322
Microsoft.AspNetCore.Http
ASP.NET Core default HTTP feature implementations. This package was built from the source code at https://github.com/aspnet/HttpAbstractions/tree/91db78cf926939821bc96e8e60616cf5dde0b489
22,374
Microsoft.Extensions.Caching.Memory
In-memory cache implementation of Microsoft.Extensions.Caching.Memory.IMemoryCache.
8,941
Microsoft.Extensions.Caching.Memory
In-memory cache implementation of Microsoft.Extensions.Caching.Memory.IMemoryCache.
14,649
Microsoft.Extensions.Caching.Memory
In-memory cache implementation of Microsoft.Extensions.Caching.Memory.IMemoryCache. When using NuGet 3.x this package requires at least version 3.4.
10,679
Microsoft.Extensions.Diagnostics.HealthChecks
Components for performing health checks in .NET applications Commonly Used Types: Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckService Microsoft.Extensions.Diagnostics.HealthChecks.IHealthChecksBuilder This package was built from the source code at https://github.com/aspnet/Diagnostics/tree/c802d5ef5fba1ba8dfbcb8c3741af2ba15e9d1aa
20,708
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
8,945
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
22,878
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging.
8,939
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging.
8,947
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging.
24,627
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging. When using NuGet 3.x this package requires at least version 3.4.
22,944
Microsoft.Extensions.Options.ConfigurationExtensions
Provides additional configuration specific functionality related to Options.
22,872
Microsoft.Extensions.WebEncoders
Contains registration and configuration APIs to add the core framework encoders to a dependency injection container. This package was built from the source code at https://github.com/aspnet/HtmlAbstractions/tree/6c5ca90d81f9013a8652da4c1752bd0b4d18e908
21,301
Quartz.Extensions.DependencyInjection
Quartz.NET Microsoft.Extensions.DependencyInjection integration; Quartz Scheduling Framework for .NET
10,100
Quartz.Extensions.DependencyInjection
Quartz.NET Microsoft.Extensions.DependencyInjection integration; Quartz Scheduling Framework for .NET
10,671

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
9.0.0-preview.1.24080.9 1 02/20/2024
8.0.2 1 02/18/2024
8.0.1 1 01/29/2024
8.0.0 5 11/20/2023
8.0.0-rc.2.23479.6 7 10/10/2023
8.0.0-rc.1.23419.4 10 09/14/2023
8.0.0-preview.7.23375.6 13 08/17/2023
8.0.0-preview.6.23329.7 3 07/15/2023
8.0.0-preview.5.23280.8 8 06/14/2023
8.0.0-preview.4.23259.5 6 05/17/2023
8.0.0-preview.3.23174.8 5 06/22/2023
8.0.0-preview.2.23128.3 7 04/04/2023
8.0.0-preview.1.23110.8 5 04/04/2023
7.0.1 9 04/04/2023
7.0.0 3,697 11/15/2022
7.0.0-rc.2.22472.3 13 10/12/2022
7.0.0-rc.1.22426.10 8 09/25/2022
7.0.0-preview.7.22375.6 6 09/21/2022
7.0.0-preview.6.22324.4 40 09/23/2022
7.0.0-preview.5.22301.12 8 09/26/2022
7.0.0-preview.4.22229.4 7 09/23/2022
7.0.0-preview.3.22175.4 16 07/01/2022
7.0.0-preview.2.22152.2 5 09/25/2022
7.0.0-preview.1.22076.8 18 06/29/2022
6.0.2-mauipre.1.22102.15 5 09/24/2022
6.0.2-mauipre.1.22054.8 5 09/24/2022
6.0.0 24,651 06/27/2022
6.0.0-rc.2.21480.5 5 10/24/2023
6.0.0-rc.1.21451.13 25 10/20/2022
6.0.0-preview.7.21377.19 13 09/22/2022
6.0.0-preview.6.21352.12 12 09/22/2022
6.0.0-preview.5.21301.5 9 09/21/2022
6.0.0-preview.4.21253.7 16 09/26/2022
6.0.0-preview.3.21201.4 7 09/23/2022
6.0.0-preview.2.21154.6 20 09/25/2022
6.0.0-preview.1.21102.12 7 09/21/2022
5.0.0 23,244 06/27/2022
5.0.0-rc.2.20475.5 7 01/07/2023
5.0.0-rc.1.20451.14 26 09/22/2022
5.0.0-preview.8.20407.11 27 09/21/2022
5.0.0-preview.7.20364.11 17 09/24/2022
5.0.0-preview.6.20305.6 10 09/21/2022
5.0.0-preview.5.20278.1 6 09/26/2022
5.0.0-preview.4.20251.6 18 09/22/2022
5.0.0-preview.3.20215.2 4 09/05/2023
5.0.0-preview.2.20160.3 28 12/03/2022
5.0.0-preview.1.20120.4 9 09/22/2022
3.1.32 10 01/14/2023
3.1.31 28 12/02/2022
3.1.30 17 12/10/2022
3.1.29 16 09/22/2022
3.1.28 46 09/23/2022
3.1.27 6 09/21/2022
3.1.26 29 09/23/2022
3.1.25 8 12/27/2022
3.1.24 10 09/22/2022
3.1.23 5 06/27/2022
3.1.22 9 09/24/2022
3.1.21 4 12/20/2022
3.1.20 30 01/10/2023
3.1.19 32 07/19/2022
3.1.18 7 09/23/2022
3.1.17 13 09/26/2022
3.1.16 34 09/21/2022
3.1.15 10 09/26/2022
3.1.14 19 09/21/2022
3.1.13 20 08/11/2022
3.1.12 5 09/25/2022
3.1.11 17 06/27/2022
3.1.10 7 09/22/2022
3.1.9 29 09/24/2022
3.1.8 34 09/23/2022
3.1.7 20 09/26/2022
3.1.6 48 06/29/2022
3.1.5 8,942 06/27/2022
3.1.4 8,381 09/22/2022
3.1.3 8,947 06/27/2022
3.1.2 18 07/01/2022
3.1.1 8 09/24/2022
3.1.0 255 09/23/2022
3.1.0-preview3.19553.2 8 09/23/2022
3.1.0-preview2.19525.4 22 09/22/2022
3.1.0-preview1.19506.1 44 09/22/2022
3.0.3 20 09/27/2022
3.0.2 7 09/23/2022
3.0.1 5 09/23/2022
3.0.0 8,859 06/27/2022
3.0.0-rc1.19456.10 27 09/27/2022
3.0.0-preview9.19423.4 8 09/23/2022
3.0.0-preview8.19405.4 21 09/21/2022
3.0.0-preview7.19362.4 46 09/24/2022
3.0.0-preview6.19304.6 42 09/21/2022
3.0.0-preview5.19227.9 7 09/05/2023
3.0.0-preview4.19216.2 6 12/11/2022
3.0.0-preview3.19153.1 31 09/22/2022
3.0.0-preview.19074.2 14 07/15/2022
3.0.0-preview.18572.1 5 08/11/2022
2.2.0 24,067 06/27/2022
2.2.0-preview3-35497 4 08/11/2022
2.2.0-preview2-35157 7 09/21/2022
2.2.0-preview1-35029 10 09/24/2022
2.1.1 20,761 06/27/2022
2.1.0 31 06/27/2022
2.1.0-rc1-final 23 08/11/2022
2.1.0-preview2-final 10 12/22/2022
2.1.0-preview1-final 11 09/23/2022
2.0.2 13 06/30/2022
2.0.1 7 12/22/2022
2.0.0 23,256 06/27/2022
2.0.0-preview2-final 9 09/22/2022
2.0.0-preview1-final 12 09/24/2022
1.1.2 15 09/22/2022
1.1.1 5 09/21/2022
1.1.0 3,381 06/27/2022
1.1.0-preview1-final 7 08/11/2022
1.0.2 7 09/22/2022
1.0.1 6 09/23/2022
1.0.0 41 06/27/2022
1.0.0-rc2-final 7 09/21/2022