Microsoft.Extensions.Options.ConfigurationExtensions 8.0.0

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Microsoft.Extensions.Options.ConfigurationExtensions --version 8.0.0
NuGet\Install-Package Microsoft.Extensions.Options.ConfigurationExtensions -Version 8.0.0
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.ConfigurationExtensions" Version="8.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Microsoft.Extensions.Options.ConfigurationExtensions --version 8.0.0
#r "nuget: Microsoft.Extensions.Options.ConfigurationExtensions, 8.0.0"
#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.ConfigurationExtensions as a Cake Addin
#addin nuget:?package=Microsoft.Extensions.Options.ConfigurationExtensions&version=8.0.0

// Install Microsoft.Extensions.Options.ConfigurationExtensions as a Cake Tool
#tool nuget:?package=Microsoft.Extensions.Options.ConfigurationExtensions&version=8.0.0

About

Microsoft.Extensions.Options.ConfigurationExtensions provides additional configuration-specific functionality related to Options.

Key Features

  • Extension methods for OptionsBuilder for configuration binding
  • Extension methods for IServiceCollection for Options configuration
  • ConfigurationChangeTokenSource<TOptions> for monitoring configuration changes

How to Use

Options Configuration binding
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Options;

class Program
{
    // appsettings.json contents:
    // {
    //   "MyOptions": {
    //     "Setting1": "Value1",
    //     "Setting2": "Value2"
    //   }
    // }

    static void Main(string[] args)
    {
        IConfiguration configuration = new ConfigurationBuilder()
            .SetBasePath(Environment.CurrentDirectory)
            .AddJsonFile("appsettings.json")
            .Build();

        IServiceCollection services = new ServiceCollection();

        // Bind the configuration to MyOptions
        services.Configure<MyOptions>(configuration.GetSection("MyOptions"));

        IServiceProvider serviceProvider = services.BuildServiceProvider();

        // Retrieve MyOptions using dependency injection
        var myOptions = serviceProvider.GetRequiredService<IOptions<MyOptions>>().Value;

        // Access the bound configuration values
        Console.WriteLine($"Setting1: {myOptions.Setting1}");
        Console.WriteLine($"Setting2: {myOptions.Setting2}");
    }
}

public class MyOptions
{
    public string Setting1 { get; set; }
    public string Setting2 { get; set; }
}

Monitoring options configuration changes
// Assume we have a class that represents some options
public class MyOptions
{
    public string Name { get; set; }
    public int Age { get; set; }
}

// appsettings.json contents:
// {
//   "MyOptions": {
//     "Name": "Alice",
//     "Age": 25
//   }
// }

// Assume we have a configuration object that contains some settings
var config = new ConfigurationBuilder()
    .AddJsonFile("appsettings.json")
    .Build();

// We can use the ConfigurationChangeTokenSource to create a change token source for the options
var changeTokenSource = new ConfigurationChangeTokenSource<MyOptions>(config.GetSection("MyOptions"));

// We can register the change token source with the options monitor
services.AddOptions<MyOptions>()
    .Configure(options =>
    {
        // Configure the options with the configuration values
        config.GetSection("MyOptions").Bind(options);
    })
    .AddChangeTokenSource(changeTokenSource);

// Now we can inject the options monitor into any class that needs them
public class MyClass
{
    private readonly IOptionsMonitor<MyOptions> _optionsMonitor;

    public MyClass(IOptionsMonitor<MyOptions> optionsMonitor)
    {
        _optionsMonitor = optionsMonitor;
    }

    public void DoSomething()
    {
        // Can access the current options value like this
        var options = _optionsMonitor.CurrentValue;
        var name = options.Name;
        var age = options.Age;
        // Do something with name and age

        // Can also register a callback to be notified when the options change
        _optionsMonitor.OnChange(newOptions =>
        {
            // Do something when the options change
        });
    }
}

Main Types

The main types provided by this library are:

  • ConfigurationChangeTokenSource
  • OptionsBuilderConfigurationExtensions
  • OptionsConfigurationServiceCollectionExtensions

Additional Documentation

Feedback & Contributing

Microsoft.Extensions.Options.ConfigurationExtensions 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 was computed. 
.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)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (3.1K)

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

Package Downloads
Microsoft.Extensions.Logging.Configuration The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Configuration support for Microsoft.Extensions.Logging.

Microsoft.AspNetCore.App The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Provides a default set of APIs for building an ASP.NET Core application. This package requires the ASP.NET Core runtime. This runtime is installed by the .NET Core SDK, or can be acquired separately using installers available at https://aka.ms/dotnet-download.

Microsoft.AspNetCore.All The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Provides a default set of APIs for building an ASP.NET Core application, and also includes API for third-party integrations with ASP.NET Core. This package requires the ASP.NET Core runtime. This runtime is installed by the .NET Core SDK, or can be acquired separately using installers available at https://aka.ms/dotnet-download.

Volo.Abp.Core The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Package Description

App.Metrics.AspNetCore.Core

App Metrics ASP.NET Core core components.

GitHub repositories (235)

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

Repository Stars
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+.
dotnet/AspNetCore.Docs
Documentation for ASP.NET Core
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 and the ASP.NET Core platforms. Provides the fundamental infrastructure, production-ready startup templates, application modules, UI themes, tooling, guides and documentation.
dotnet/orleans
Cloud Native application framework for .NET
JeffreySu/WeiXinMPSDK
微信全平台 SDK Senparc.Weixin for C#,支持 .NET Framework 及 .NET Core、.NET 6.0、.NET 8.0。已支持微信公众号、小程序、小游戏、微信支付、企业微信/企业号、开放平台、JSSDK、微信周边等全平台。 WeChat SDK for C#.
Version Downloads Last updated
9.0.0-preview.1.24080.9 10,600 2/13/2024
8.0.0 12,907,708 11/14/2023
8.0.0-rc.2.23479.6 422,818 10/10/2023
8.0.0-rc.1.23419.4 216,586 9/12/2023
8.0.0-preview.7.23375.6 127,787 8/8/2023
8.0.0-preview.6.23329.7 72,018 7/11/2023
8.0.0-preview.5.23280.8 48,029 6/13/2023
8.0.0-preview.4.23259.5 113,484 5/16/2023
8.0.0-preview.3.23174.8 59,081 4/11/2023
8.0.0-preview.2.23128.3 41,373 3/14/2023
8.0.0-preview.1.23110.8 87,934 2/21/2023
7.0.0 74,414,034 11/7/2022
7.0.0-rc.2.22472.3 153,613 10/11/2022
7.0.0-rc.1.22426.10 70,083 9/14/2022
7.0.0-preview.7.22375.6 58,036 8/9/2022
7.0.0-preview.6.22324.4 49,550 7/12/2022
7.0.0-preview.5.22301.12 42,542 6/14/2022
7.0.0-preview.4.22229.4 47,918 5/10/2022
7.0.0-preview.3.22175.4 41,596 4/13/2022
7.0.0-preview.2.22152.2 14,995 3/14/2022
7.0.0-preview.1.22076.8 29,072 2/17/2022
6.0.2-mauipre.1.22102.15 37,458 2/15/2022
6.0.2-mauipre.1.22054.8 149,137 1/19/2022
6.0.0 200,304,876 11/8/2021
6.0.0-rc.2.21480.5 375,636 10/12/2021
6.0.0-rc.1.21451.13 267,885 9/14/2021
6.0.0-preview.7.21377.19 142,301 8/10/2021
6.0.0-preview.6.21352.12 81,372 7/14/2021
6.0.0-preview.5.21301.5 38,247 6/15/2021
6.0.0-preview.4.21253.7 30,917 5/24/2021
6.0.0-preview.3.21201.4 53,154 4/8/2021
6.0.0-preview.2.21154.6 80,616 3/11/2021
6.0.0-preview.1.21102.12 61,853 2/12/2021
5.0.0 140,343,574 11/9/2020
5.0.0-rc.2.20475.5 115,882 10/13/2020
5.0.0-rc.1.20451.14 264,866 9/14/2020
5.0.0-preview.8.20407.11 258,356 8/25/2020
5.0.0-preview.7.20364.11 43,223 7/21/2020
5.0.0-preview.6.20305.6 41,808 6/25/2020
5.0.0-preview.5.20278.1 20,441 6/10/2020
5.0.0-preview.4.20251.6 33,952 5/18/2020
5.0.0-preview.3.20215.2 28,242 4/23/2020
5.0.0-preview.2.20160.3 53,466 4/2/2020
5.0.0-preview.1.20120.4 30,674 3/16/2020
3.1.32 2,263,637 12/13/2022
3.1.31 806,518 11/8/2022
3.1.30 929,523 10/11/2022
3.1.29 457,293 9/13/2022
3.1.28 827,976 8/9/2022
3.1.27 853,824 7/12/2022
3.1.26 521,684 6/14/2022
3.1.25 1,032,616 5/10/2022
3.1.24 606,502 4/11/2022
3.1.23 1,386,462 3/8/2022
3.1.22 7,316,940 12/14/2021
3.1.21 2,938,150 11/7/2021
3.1.20 1,261,815 10/11/2021
3.1.19 1,400,871 9/14/2021
3.1.18 2,903,022 8/10/2021
3.1.17 2,329,313 7/13/2021
3.1.16 2,451,292 6/8/2021
3.1.15 3,709,440 5/11/2021
3.1.14 8,641,122 4/6/2021
3.1.13 5,941,831 3/9/2021
3.1.12 4,016,147 2/9/2021
3.1.11 4,671,053 1/12/2021
3.1.10 10,189,682 11/9/2020
3.1.9 11,542,819 10/13/2020
3.1.8 16,268,831 9/8/2020
3.1.7 9,528,895 8/11/2020
3.1.6 17,199,464 7/14/2020
3.1.5 16,906,784 6/9/2020
3.1.4 11,042,367 5/12/2020
3.1.3 17,779,647 3/24/2020
3.1.2 16,624,806 2/18/2020
3.1.1 13,470,104 1/14/2020
3.1.0 75,527,026 12/3/2019
3.1.0-preview3.19553.2 53,065 11/13/2019
3.1.0-preview2.19525.4 15,463 11/1/2019
3.1.0-preview1.19506.1 18,210 10/15/2019
3.0.3 539,483 2/18/2020
3.0.2 777,172 1/14/2020
3.0.1 2,034,817 11/18/2019
3.0.0 30,131,256 9/23/2019
3.0.0-rc1.19456.10 34,708 9/16/2019
3.0.0-preview9.19423.4 124,985 9/4/2019
3.0.0-preview8.19405.4 136,364 8/13/2019
3.0.0-preview7.19362.4 74,747 7/23/2019
3.0.0-preview6.19304.6 134,910 6/12/2019
3.0.0-preview5.19227.9 146,482 5/6/2019
3.0.0-preview4.19216.2 22,707 4/18/2019
3.0.0-preview3.19153.1 139,368 3/6/2019
3.0.0-preview.19074.2 92,407 1/29/2019
3.0.0-preview.18572.1 10,600 12/4/2018
2.2.0 74,561,899 12/3/2018
2.2.0-preview3-35497 136,672 10/17/2018
2.2.0-preview2-35157 61,380 9/12/2018
2.2.0-preview1-35029 31,410 8/22/2018
2.1.1 54,170,305 6/18/2018
2.1.0 145,165,170 5/29/2018
2.1.0-rc1-final 71,189 5/6/2018
2.1.0-preview2-final 60,988 4/10/2018
2.1.0-preview1-final 151,009 2/26/2018
2.0.2 5,777,396 5/7/2018
2.0.1 9,999,038 3/13/2018
2.0.0 297,978,849 8/11/2017
2.0.0-preview2-final 113,288 6/28/2017
2.0.0-preview1-final 38,165 5/10/2017
1.1.2 7,461,229 5/9/2017
1.1.1 2,641,161 3/6/2017
1.1.0 2,207,345 11/16/2016
1.1.0-preview1-final 15,395 10/24/2016
1.0.2 687,055 3/6/2017
1.0.1 243,211 12/12/2016
1.0.0 1,949,014 6/27/2016
1.0.0-rc2-final 22,608 5/16/2016