Microsoft.Extensions.Options 10.0.0-preview.3.25171.5

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
MaxMind.GeoIP2
MaxMind GeoIP2 Database Reader and Web Service Client
2
Microsoft.AspNetCore.Authentication.Cookies
ASP.NET Core middleware that enables an application to use cookie based authentication.
2
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.
2
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
3
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
2
Microsoft.Extensions.Options.ValidateOnStart
Support for extended option validation.
2
Microsoft.Extensions.Telemetry
Provides canonical implementations of telemetry abstractions
2
Microsoft.Extensions.Telemetry.Abstractions
Common abstractions for high-level telemetry primitives.
2
Polly.Extensions
Package Description
2
Quartz.Extensions.DependencyInjection
Quartz.NET Microsoft.Extensions.DependencyInjection integration; Quartz Scheduling Framework for .NET
2

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

.NET Framework 4.6.2

.NET 8.0

.NET 9.0

.NET 10.0

.NET Standard 2.0

.NET Standard 2.1

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