Microsoft.Extensions.Options.ConfigurationExtensions 8.0.0

Prefix Reserved
.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. .NET Framework 4.6.2 This package targets .NET Framework 4.6.2. The package is compatible with this framework or higher.
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)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (3.5K)

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

Package Downloads
Microsoft.Extensions.Logging.Configuration

Configuration support for Microsoft.Extensions.Logging.
Microsoft.Extensions.Diagnostics

This package includes the default implementation of IMeterFactory and additional extension methods to easily register it with the Dependency Injection framework.
Microsoft.AspNetCore.App

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.Identity.Web.TokenAcquisition

Implementation for higher level API for confidential client applications (ASP.NET Core and SDK/.NET).
Microsoft.AspNetCore.All

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.

GitHub repositories (258)

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

Repository Stars
ardalis/CleanArchitecture
Clean Architecture Solution Template: A starting point for Clean Architecture with ASP.NET Core
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+.
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.
dotnet/AspNetCore.Docs
Documentation for ASP.NET Core
chocolatey/choco
Chocolatey - the package manager for Windows
Version Downloads Last updated
9.0.0-rc.1.24431.7 11,992 9/10/2024
9.0.0-preview.7.24405.7 32,609 8/13/2024
9.0.0-preview.6.24327.7 66,468 7/9/2024
9.0.0-preview.5.24306.7 59,561 6/11/2024
9.0.0-preview.4.24266.19 44,613 5/21/2024
9.0.0-preview.3.24172.9 116,167 4/11/2024
9.0.0-preview.2.24128.5 61,373 3/12/2024
9.0.0-preview.1.24080.9 65,421 2/13/2024
8.0.0 94,639,111 11/14/2023
8.0.0-rc.2.23479.6 893,790 10/10/2023
8.0.0-rc.1.23419.4 321,767 9/12/2023
8.0.0-preview.7.23375.6 284,683 8/8/2023
8.0.0-preview.6.23329.7 90,100 7/11/2023
8.0.0-preview.5.23280.8 63,791 6/13/2023
8.0.0-preview.4.23259.5 201,912 5/16/2023
8.0.0-preview.3.23174.8 94,980 4/11/2023
8.0.0-preview.2.23128.3 50,364 3/14/2023
8.0.0-preview.1.23110.8 98,536 2/21/2023
7.0.0 100,780,286 11/7/2022
7.0.0-rc.2.22472.3 169,420 10/11/2022
7.0.0-rc.1.22426.10 79,264 9/14/2022
7.0.0-preview.7.22375.6 62,856 8/9/2022
7.0.0-preview.6.22324.4 59,020 7/12/2022
7.0.0-preview.5.22301.12 47,716 6/14/2022
7.0.0-preview.4.22229.4 55,774 5/10/2022
7.0.0-preview.3.22175.4 50,753 4/13/2022
7.0.0-preview.2.22152.2 15,745 3/14/2022
7.0.0-preview.1.22076.8 30,821 2/17/2022
6.0.0 254,254,349 11/8/2021
6.0.0-rc.2.21480.5 395,882 10/12/2021
6.0.0-rc.1.21451.13 280,499 9/14/2021
6.0.0-preview.7.21377.19 146,841 8/10/2021
6.0.0-preview.6.21352.12 87,408 7/14/2021
6.0.0-preview.5.21301.5 39,816 6/15/2021
6.0.0-preview.4.21253.7 32,452 5/24/2021
6.0.0-preview.3.21201.4 56,359 4/8/2021
6.0.0-preview.2.21154.6 82,942 3/11/2021 6.0.0-preview.2.21154.6 is deprecated because it is no longer maintained.
6.0.0-preview.1.21102.12 66,810 2/12/2021 6.0.0-preview.1.21102.12 is deprecated because it is no longer maintained.
5.0.0 160,944,401 11/9/2020 5.0.0 is deprecated because it is no longer maintained.
5.0.0-rc.2.20475.5 125,794 10/13/2020 5.0.0-rc.2.20475.5 is deprecated because it is no longer maintained.
5.0.0-rc.1.20451.14 267,640 9/14/2020 5.0.0-rc.1.20451.14 is deprecated because it is no longer maintained.
5.0.0-preview.8.20407.11 303,883 8/25/2020 5.0.0-preview.8.20407.11 is deprecated because it is no longer maintained.
5.0.0-preview.7.20364.11 43,836 7/21/2020 5.0.0-preview.7.20364.11 is deprecated because it is no longer maintained.
5.0.0-preview.6.20305.6 42,868 6/25/2020 5.0.0-preview.6.20305.6 is deprecated because it is no longer maintained.
5.0.0-preview.5.20278.1 21,810 6/10/2020 5.0.0-preview.5.20278.1 is deprecated because it is no longer maintained.
5.0.0-preview.4.20251.6 35,115 5/18/2020 5.0.0-preview.4.20251.6 is deprecated because it is no longer maintained.
5.0.0-preview.3.20215.2 30,857 4/23/2020 5.0.0-preview.3.20215.2 is deprecated because it is no longer maintained.
5.0.0-preview.2.20160.3 54,388 4/2/2020 5.0.0-preview.2.20160.3 is deprecated because it is no longer maintained.
5.0.0-preview.1.20120.4 31,786 3/16/2020 5.0.0-preview.1.20120.4 is deprecated because it is no longer maintained.
3.1.32 4,109,919 12/13/2022
3.1.31 992,858 11/8/2022
3.1.30 1,267,314 10/11/2022
3.1.29 567,516 9/13/2022
3.1.28 1,003,331 8/9/2022
3.1.27 1,050,388 7/12/2022
3.1.26 579,820 6/14/2022
3.1.25 1,161,101 5/10/2022
3.1.24 667,726 4/11/2022
3.1.23 1,641,594 3/8/2022
3.1.22 9,708,688 12/14/2021
3.1.21 3,342,672 11/7/2021
3.1.20 1,373,861 10/11/2021
3.1.19 1,525,594 9/14/2021
3.1.18 3,280,420 8/10/2021
3.1.17 2,533,020 7/13/2021
3.1.16 2,598,800 6/8/2021
3.1.15 4,018,668 5/11/2021
3.1.14 9,310,525 4/6/2021
3.1.13 6,279,257 3/9/2021
3.1.12 4,269,270 2/9/2021
3.1.11 5,151,498 1/12/2021
3.1.10 10,910,341 11/9/2020
3.1.9 12,311,721 10/13/2020
3.1.8 17,110,406 9/8/2020
3.1.7 10,101,238 8/11/2020
3.1.6 18,175,503 7/14/2020
3.1.5 17,839,122 6/9/2020
3.1.4 11,767,178 5/12/2020
3.1.3 18,789,916 3/24/2020
3.1.2 17,541,211 2/18/2020
3.1.1 14,404,322 1/14/2020
3.1.0 95,530,013 12/3/2019
3.1.0-preview3.19553.2 54,841 11/13/2019 3.1.0-preview3.19553.2 is deprecated because it is no longer maintained.
3.1.0-preview2.19525.4 15,699 11/1/2019 3.1.0-preview2.19525.4 is deprecated because it is no longer maintained.
3.1.0-preview1.19506.1 18,778 10/15/2019 3.1.0-preview1.19506.1 is deprecated because it is no longer maintained.
3.0.3 578,348 2/18/2020 3.0.3 is deprecated because it is no longer maintained.
3.0.2 783,522 1/14/2020 3.0.2 is deprecated because it is no longer maintained.
3.0.1 2,150,110 11/18/2019 3.0.1 is deprecated because it is no longer maintained.
3.0.0 32,583,814 9/23/2019 3.0.0 is deprecated because it is no longer maintained.
3.0.0-rc1.19456.10 34,961 9/16/2019 3.0.0-rc1.19456.10 is deprecated because it is no longer maintained.
3.0.0-preview9.19423.4 131,521 9/4/2019 3.0.0-preview9.19423.4 is deprecated because it is no longer maintained.
3.0.0-preview8.19405.4 145,237 8/13/2019 3.0.0-preview8.19405.4 is deprecated because it is no longer maintained.
3.0.0-preview7.19362.4 76,318 7/23/2019 3.0.0-preview7.19362.4 is deprecated because it is no longer maintained.
3.0.0-preview6.19304.6 138,077 6/12/2019 3.0.0-preview6.19304.6 is deprecated because it is no longer maintained.
3.0.0-preview5.19227.9 152,748 5/6/2019 3.0.0-preview5.19227.9 is deprecated because it is no longer maintained.
3.0.0-preview4.19216.2 23,305 4/18/2019 3.0.0-preview4.19216.2 is deprecated because it is no longer maintained.
3.0.0-preview3.19153.1 146,416 3/6/2019 3.0.0-preview3.19153.1 is deprecated because it is no longer maintained.
3.0.0-preview.19074.2 94,416 1/29/2019 3.0.0-preview.19074.2 is deprecated because it is no longer maintained.
3.0.0-preview.18572.1 10,890 12/4/2018 3.0.0-preview.18572.1 is deprecated because it is no longer maintained.
2.2.0 82,941,292 12/3/2018 2.2.0 is deprecated because it is no longer maintained.
2.2.0-preview3-35497 139,470 10/17/2018 2.2.0-preview3-35497 is deprecated because it is no longer maintained.
2.2.0-preview2-35157 64,310 9/12/2018 2.2.0-preview2-35157 is deprecated because it is no longer maintained.
2.2.0-preview1-35029 34,073 8/22/2018 2.2.0-preview1-35029 is deprecated because it is no longer maintained.
2.1.1 61,869,667 6/18/2018
2.1.0 173,137,342 5/29/2018
2.1.0-rc1-final 75,122 5/6/2018 2.1.0-rc1-final is deprecated because it is no longer maintained.
2.1.0-preview2-final 66,395 4/10/2018 2.1.0-preview2-final is deprecated because it is no longer maintained.
2.1.0-preview1-final 159,005 2/26/2018 2.1.0-preview1-final is deprecated because it is no longer maintained.
2.0.2 6,042,167 5/7/2018 2.0.2 is deprecated because it is no longer maintained.
2.0.1 10,262,710 3/13/2018 2.0.1 is deprecated because it is no longer maintained.
2.0.0 333,775,225 8/11/2017 2.0.0 is deprecated because it is no longer maintained.
2.0.0-preview2-final 122,077 6/28/2017 2.0.0-preview2-final is deprecated because it is no longer maintained.
2.0.0-preview1-final 38,973 5/10/2017 2.0.0-preview1-final is deprecated because it is no longer maintained.
1.1.2 7,902,942 5/9/2017 1.1.2 is deprecated because it is no longer maintained.
1.1.1 2,741,055 3/6/2017 1.1.1 is deprecated because it is no longer maintained.
1.1.0 2,329,734 11/16/2016 1.1.0 is deprecated because it is no longer maintained.
1.1.0-preview1-final 15,577 10/24/2016 1.1.0-preview1-final is deprecated because it is no longer maintained.
1.0.2 704,475 3/6/2017 1.0.2 is deprecated because it is no longer maintained.
1.0.1 250,533 12/12/2016 1.0.1 is deprecated because it is no longer maintained.
1.0.0 2,038,588 6/27/2016 1.0.0 is deprecated because it is no longer maintained.
1.0.0-rc2-final 23,425 5/16/2016 1.0.0-rc2-final is deprecated because it is no longer maintained.

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