Microsoft.Extensions.Options 8.0.2

Prefix Reserved

.NET 6.0 .NET Standard 2.0 .NET Framework 4.6.2

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

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#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

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

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.

.NETFramework 4.6.2
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Primitives (>= 8.0.0)
- System.ValueTuple (>= 4.5.0)
.NETStandard 2.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Primitives (>= 8.0.0)
- System.ComponentModel.Annotations (>= 5.0.0)
.NETStandard 2.1
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Primitives (>= 8.0.0)
- System.ComponentModel.Annotations (>= 5.0.0)
net6.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Primitives (>= 8.0.0)
net7.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Primitives (>= 8.0.0)
net8.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Primitives (>= 8.0.0)

NuGet packages (5.5K)

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

Package	Downloads
Microsoft.Extensions.Logging Logging infrastructure default implementation for Microsoft.Extensions.Logging.	3.5B
Microsoft.Extensions.Caching.Memory In-memory cache implementation of Microsoft.Extensions.Caching.Memory.IMemoryCache.	1.7B
Microsoft.Extensions.Options.ConfigurationExtensions Provides additional configuration specific functionality related to Options.	1.6B
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	1.4B
Microsoft.Extensions.Logging.Configuration Configuration support for Microsoft.Extensions.Logging.	1.0B

GitHub repositories (389)

Showing the top 5 popular GitHub repositories that depend on Microsoft.Extensions.Options:

Repository	Stars
jellyfin/jellyfin The Free Software Media System	33.3K
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+.	13.3K
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. Provides the fundamental infrastructure, cross-cutting-concern implementations, startup templates, application modules, UI themes, tooling and documentation.	12.7K
dotnet/AspNetCore.Docs Documentation for ASP.NET Core	12.5K
aspnetboilerplate/aspnetboilerplate ASP.NET Boilerplate - Web Application Framework	11.8K

Version	Downloads	Last updated
9.0.0-preview.7.24405.7	58,230	8/13/2024
9.0.0-preview.6.24327.7	127,134	7/9/2024
9.0.0-preview.5.24306.7	110,973	6/11/2024
9.0.0-preview.4.24266.19	90,005	5/21/2024
9.0.0-preview.3.24172.9	222,251	4/11/2024
9.0.0-preview.2.24128.5	142,373	3/12/2024
9.0.0-preview.1.24080.9	146,615	2/13/2024
8.0.2	43,173,854	2/13/2024
8.0.1	13,398,943	1/9/2024
8.0.0	120,157,126	11/14/2023
8.0.0-rc.2.23479.6	1,780,403	10/10/2023
8.0.0-rc.1.23419.4	1,052,018	9/12/2023
8.0.0-preview.7.23375.6	517,053	8/8/2023
8.0.0-preview.6.23329.7	376,613	7/11/2023
8.0.0-preview.5.23280.8	262,570	6/13/2023
8.0.0-preview.4.23259.5	452,362	5/16/2023
8.0.0-preview.3.23174.8	359,948	4/11/2023
8.0.0-preview.2.23128.3	319,252	3/14/2023
8.0.0-preview.1.23110.8	315,030	2/21/2023
7.0.1	98,737,722	2/14/2023
7.0.0	210,600,309	11/7/2022
7.0.0-rc.2.22472.3	1,078,210	10/11/2022
7.0.0-rc.1.22426.10	416,445	9/14/2022
7.0.0-preview.7.22375.6	394,371	8/9/2022
7.0.0-preview.6.22324.4	243,554	7/12/2022
7.0.0-preview.5.22301.12	186,400	6/14/2022
7.0.0-preview.4.22229.4	368,189	5/10/2022
7.0.0-preview.3.22175.4	178,582	4/13/2022
7.0.0-preview.2.22152.2	245,989	3/14/2022
7.0.0-preview.1.22076.8	155,558	2/17/2022
6.0.0	533,637,546	11/8/2021
6.0.0-rc.2.21480.5	1,763,176	10/12/2021
6.0.0-rc.1.21451.13	655,360	9/14/2021
6.0.0-preview.7.21377.19	735,144	8/10/2021
6.0.0-preview.6.21352.12	348,438	7/14/2021
6.0.0-preview.5.21301.5	332,233	6/15/2021
6.0.0-preview.4.21253.7	184,916	5/24/2021
6.0.0-preview.3.21201.4	614,343	4/8/2021
6.0.0-preview.2.21154.6	215,580	3/11/2021
6.0.0-preview.1.21102.12	552,708	2/12/2021
5.0.0	474,280,360	11/9/2020
5.0.0-rc.2.20475.5	994,020	10/13/2020
5.0.0-rc.1.20451.14	798,574	9/14/2020
5.0.0-preview.8.20407.11	546,175	8/25/2020
5.0.0-preview.7.20364.11	243,250	7/21/2020
5.0.0-preview.6.20305.6	165,206	6/25/2020
5.0.0-preview.5.20278.1	90,895	6/10/2020
5.0.0-preview.4.20251.6	320,375	5/18/2020
5.0.0-preview.3.20215.2	236,165	4/23/2020
5.0.0-preview.2.20160.3	345,727	4/2/2020
5.0.0-preview.1.20120.4	179,380	3/16/2020
3.1.32	17,315,896	12/13/2022
3.1.31	2,605,881	11/8/2022
3.1.30	2,242,284	10/11/2022
3.1.29	2,112,652	9/13/2022
3.1.28	5,822,504	8/9/2022
3.1.27	2,174,737	7/12/2022
3.1.26	1,828,345	6/14/2022
3.1.25	3,247,592	5/10/2022
3.1.24	3,714,744	4/11/2022
3.1.23	3,999,609	3/8/2022
3.1.22	17,468,069	12/14/2021
3.1.21	10,159,222	11/7/2021
3.1.20	4,766,031	10/11/2021
3.1.19	5,206,766	9/14/2021
3.1.18	59,376,325	8/10/2021
3.1.17	6,866,269	7/13/2021
3.1.16	12,791,774	6/8/2021
3.1.15	8,524,448	5/11/2021
3.1.14	18,370,501	4/6/2021
3.1.13	14,638,503	3/9/2021
3.1.12	11,299,378	2/9/2021
3.1.11	19,399,526	1/12/2021
3.1.10	28,187,479	11/9/2020
3.1.9	71,191,624	10/13/2020
3.1.8	71,700,288	9/8/2020
3.1.7	39,045,426	8/11/2020
3.1.6	44,214,825	7/14/2020
3.1.5	44,657,538	6/9/2020
3.1.4	58,027,490	5/12/2020
3.1.3	106,422,950	3/24/2020
3.1.2	76,357,158	2/18/2020
3.1.1	43,602,707	1/14/2020
3.1.0	173,328,255	12/3/2019
3.1.0-preview3.19553.2	1,823,091	11/13/2019
3.1.0-preview2.19525.4	227,088	11/1/2019
3.1.0-preview1.19506.1	1,240,688	10/15/2019
3.0.3	65,022,303	2/18/2020
3.0.2	1,145,894	1/14/2020
3.0.1	5,659,752	11/18/2019
3.0.0	171,127,712	9/23/2019
3.0.0-rc1.19456.10	172,365	9/16/2019
3.0.0-preview9.19423.4	1,656,755	9/4/2019
3.0.0-preview8.19405.4	575,967	8/13/2019
3.0.0-preview7.19362.4	190,187	7/23/2019
3.0.0-preview6.19304.6	438,541	6/12/2019
3.0.0-preview5.19227.9	789,797	5/6/2019
3.0.0-preview4.19216.2	54,600	4/18/2019
3.0.0-preview3.19153.1	332,259	3/6/2019
3.0.0-preview.19074.2	171,937	1/29/2019
3.0.0-preview.18572.1	158,631	12/4/2018
2.2.0	572,328,149	12/3/2018
2.2.0-preview3-35497	599,136	10/17/2018
2.2.0-preview2-35157	544,776	9/12/2018
2.2.0-preview1-35029	257,746	8/22/2018
2.1.1	395,102,362	6/18/2018
2.1.0	383,229,890	5/29/2018
2.1.0-rc1-final	657,140	5/6/2018
2.1.0-preview2-final	890,470	4/10/2018
2.1.0-preview1-final	815,256	2/26/2018
2.0.2	32,471,489	5/7/2018
2.0.1	53,270,205	3/13/2018
2.0.0	522,840,498	8/11/2017
2.0.0-preview2-final	415,763	6/28/2017
2.0.0-preview1-final	1,118,361	5/10/2017
1.1.2	24,174,529	5/9/2017
1.1.1	20,760,234	3/6/2017
1.1.0	15,347,726	11/16/2016
1.1.0-preview1-final	310,117	10/24/2016
1.0.2	116,572,391	3/6/2017
1.0.1	3,707,816	12/12/2016
1.0.0	251,514,334	6/27/2016
1.0.0-rc2-final	2,048,245	5/16/2016

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

Total 5.2B

Current version 43.2M

Per day average 1.7M

Microsoft.Extensions.Options 8.0.2

About

Key Features

How to Use

Options validation example

Using IValidateOptions to validate options

Options Validation Source Generator Example

Main Types

Additional Documentation

Related Packages

Feedback & Contributing

.NETFramework 4.6.2

.NETStandard 2.0

.NETStandard 2.1

net6.0

net7.0

net8.0

NuGet packages (5.5K)

GitHub repositories (389)