Microsoft.Extensions.Options 9.0.0-preview.5.24306.7

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.Extensions.Caching.Memory
In-memory cache implementation of Microsoft.Extensions.Caching.Memory.IMemoryCache.
1,123
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging.
1,058
Microsoft.Extensions.Options.ConfigurationExtensions
Provides additional configuration specific functionality related to Options.
1,005
Microsoft.Extensions.Diagnostics.Abstractions
Diagnostic abstractions for Microsoft.Extensions.Diagnostics. Commonly Used Types: Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule Microsoft.Extensions.Diagnostics.Metrics.MeterScope Microsoft.Extensions.Diagnostics.Metrics.MetricsBuilderExtensions Microsoft.Extensions.Diagnostics.Metrics.MetricsOptions
897
Microsoft.Extensions.Hosting
Hosting and startup infrastructures for applications.
862
Microsoft.Extensions.Logging.Console
Console logger provider implementation for Microsoft.Extensions.Logging.
848
Microsoft.Extensions.Options.ConfigurationExtensions
Provides additional configuration specific functionality related to Options.
844
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging.
841
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
840
Microsoft.Extensions.Logging.EventSource
EventSource/EventListener logger provider implementation for Microsoft.Extensions.Logging.
840
Microsoft.Extensions.Logging.EventLog
Windows Event Log logger provider implementation for Microsoft.Extensions.Logging.
833
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
401
AspNetCoreRateLimit
ASP.NET Core rate limiting middleware
292
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
283
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging.
280
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/3f1acb59718cadf111a0a796681e3d3509bb3381
191
Microsoft.Extensions.Caching.Memory
In-memory cache implementation of Microsoft.Extensions.Caching.Memory.IMemoryCache.
181
Microsoft.Extensions.Logging.Console
Console logger provider implementation for Microsoft.Extensions.Logging.
178
Microsoft.Extensions.Logging.EventLog
Windows Event Log logger provider implementation for Microsoft.Extensions.Logging.
178
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging.
177

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

.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 1 10/10/2024
9.0.0-rc.1.24431.7 0 09/10/2024
9.0.0-preview.7.24405.7 5 08/17/2024
9.0.0-preview.6.24327.7 8 07/11/2024
9.0.0-preview.5.24306.7 10 06/29/2024
9.0.0-preview.4.24266.19 5 05/28/2024
9.0.0-preview.3.24172.9 9 04/29/2024
9.0.0-preview.2.24128.5 5 04/28/2024
9.0.0-preview.1.24080.9 8 03/26/2024
8.0.2 622 03/25/2024
8.0.1 103 04/29/2024
8.0.0 1,215 03/25/2024
8.0.0-rc.2.23479.6 9 03/30/2024
8.0.0-rc.1.23419.4 6 04/25/2024
8.0.0-preview.7.23375.6 6 04/27/2024
8.0.0-preview.6.23329.7 10 03/29/2024
8.0.0-preview.5.23280.8 6 04/28/2024
8.0.0-preview.4.23259.5 4 04/04/2024
8.0.0-preview.3.23174.8 6 04/28/2024
8.0.0-preview.2.23128.3 5 04/26/2024
8.0.0-preview.1.23110.8 7 04/26/2024
7.0.1 178 03/26/2024
7.0.0 180 03/26/2024
7.0.0-rc.2.22472.3 6 04/05/2024
7.0.0-rc.1.22426.10 8 04/25/2024
7.0.0-preview.7.22375.6 6 04/26/2024
7.0.0-preview.6.22324.4 5 04/26/2024
7.0.0-preview.5.22301.12 6 04/05/2024
7.0.0-preview.4.22229.4 8 04/26/2024
7.0.0-preview.3.22175.4 7 04/26/2024
7.0.0-preview.2.22152.2 7 04/26/2024
7.0.0-preview.1.22076.8 6 04/26/2024
6.0.2-mauipre.1.22102.15 7 04/28/2024
6.0.2-mauipre.1.22054.8 7 04/26/2024
6.0.0 846 03/25/2024
6.0.0-rc.2.21480.5 5 04/25/2024
6.0.0-rc.1.21451.13 7 04/25/2024
6.0.0-preview.7.21377.19 4 04/28/2024
6.0.0-preview.6.21352.12 4 04/28/2024
6.0.0-preview.5.21301.5 10 03/28/2024
6.0.0-preview.4.21253.7 5 04/26/2024
6.0.0-preview.3.21201.4 4 04/26/2024
6.0.0-preview.2.21154.6 6 04/26/2024
6.0.0-preview.1.21102.12 4 04/28/2024
5.0.0 10 04/01/2024
5.0.0-rc.2.20475.5 7 04/25/2024
5.0.0-rc.1.20451.14 6 04/25/2024
5.0.0-preview.8.20407.11 5 04/28/2024
5.0.0-preview.7.20364.11 7 04/28/2024
5.0.0-preview.6.20305.6 7 04/26/2024
5.0.0-preview.5.20278.1 7 04/01/2024
5.0.0-preview.4.20251.6 8 04/26/2024
5.0.0-preview.3.20215.2 5 04/26/2024
5.0.0-preview.2.20160.3 5 04/26/2024
5.0.0-preview.1.20120.4 6 04/26/2024
3.1.32 7 04/27/2024
3.1.31 5 04/07/2024
3.1.30 6 04/29/2024
3.1.29 7 04/29/2024
3.1.28 9 03/30/2024
3.1.27 6 04/29/2024
3.1.26 6 04/29/2024
3.1.25 8 04/16/2024
3.1.24 8 04/27/2024
3.1.23 8 03/31/2024
3.1.22 6 04/29/2024
3.1.21 6 04/29/2024
3.1.20 6 04/29/2024
3.1.19 8 04/29/2024
3.1.18 8 04/29/2024
3.1.17 5 04/29/2024
3.1.16 6 04/29/2024
3.1.15 8 04/27/2024
3.1.14 7 04/29/2024
3.1.13 6 04/29/2024
3.1.12 7 03/31/2024
3.1.11 6 04/29/2024
3.1.10 5 04/29/2024
3.1.9 10 04/29/2024
3.1.8 7 03/29/2024
3.1.7 6 04/29/2024
3.1.6 6 04/29/2024
3.1.5 7 04/05/2024
3.1.4 5 04/29/2024
3.1.3 282 03/26/2024
3.1.2 7 04/29/2024
3.1.1 7 04/19/2024
3.1.0 6 04/29/2024
3.1.0-preview3.19553.2 4 04/26/2024
3.1.0-preview2.19525.4 4 04/26/2024
3.1.0-preview1.19506.1 6 04/26/2024
3.0.3 7 04/29/2024
3.0.2 7 04/29/2024
3.0.1 6 04/29/2024
3.0.0 9 04/03/2024
3.0.0-rc1.19456.10 6 04/25/2024
3.0.0-preview9.19423.4 5 04/26/2024
3.0.0-preview8.19405.4 4 04/04/2024
3.0.0-preview7.19362.4 8 04/26/2024
3.0.0-preview6.19304.6 6 04/26/2024
3.0.0-preview5.19227.9 6 04/04/2024
3.0.0-preview4.19216.2 5 04/26/2024
3.0.0-preview3.19153.1 5 04/26/2024
3.0.0-preview.19074.2 5 03/31/2024
3.0.0-preview.18572.1 7 06/12/2024
2.2.0 9 04/29/2024
2.2.0-preview3-35497 4 04/26/2024
2.2.0-preview2-35157 4 04/26/2024
2.2.0-preview1-35029 6 03/31/2024
2.1.1 9 03/31/2024
2.1.0 8 04/01/2024
2.1.0-rc1-final 8 04/01/2024
2.1.0-preview2-final 6 04/14/2024
2.1.0-preview1-final 4 04/26/2024
2.0.2 6 04/29/2024
2.0.1 8 04/29/2024
2.0.0 6 04/06/2024
2.0.0-preview2-final 5 04/26/2024
2.0.0-preview1-final 5 04/26/2024
1.1.2 9 04/20/2024
1.1.1 7 04/29/2024
1.1.0 9 04/21/2024
1.1.0-preview1-final 6 04/10/2024
1.0.2 8 04/05/2024
1.0.1 8 04/29/2024
1.0.0 8 04/01/2024
1.0.0-rc2-final 8 05/27/2024