Microsoft.Extensions.Options.ConfigurationExtensions 9.0.0-preview.6.24327.7

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 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.

Showing the top 20 packages that depend on Microsoft.Extensions.Options.ConfigurationExtensions.

Packages Downloads
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 51
Microsoft.Extensions.Logging.Console
Console logger provider implementation for Microsoft.Extensions.Logging. When using NuGet 3.x this package requires at least version 3.4.
 50
R4Mvc.Tools
R4Mvc is a tool that generates strongly typed helpers for ASP.NET Core MVC.
 46
Microsoft.Extensions.Logging.Console
Console logger provider implementation for Microsoft.Extensions.Logging.
 45
Microsoft.Extensions.Logging.Console
Console logger provider implementation for Microsoft.Extensions.Logging. When using NuGet 3.x this package requires at least version 3.4.
 44
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 44
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 43
R4Mvc.Tools
R4Mvc is a tool that generates strongly typed helpers for ASP.NET Core MVC.
 42
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 42
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging. This package was built from the source code at https://github.com/aspnet/Extensions/tree/9bc79b2f25a3724376d7af19617c33749a30ea3a
 41
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 40
R4Mvc.Tools
R4Mvc is a tool that generates strongly typed helpers for ASP.NET Core MVC.
 39
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 39
Microsoft.Extensions.Logging.Console
Console logger provider implementation for Microsoft.Extensions.Logging. When using NuGet 3.x this package requires at least version 3.4.
 39
Microsoft.Extensions.Logging.Console
Console logger provider implementation for Microsoft.Extensions.Logging.
 39
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 38

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

.NET Framework 4.6.2

.NET 8.0

.NET 9.0

.NET Standard 2.0

Version Downloads Last updated
9.0.0-rc.2.24473.5 3 10/19/2024
9.0.0-rc.1.24431.7 11 9/11/2024
9.0.0-preview.7.24405.7 12 8/14/2024
9.0.0-preview.6.24327.7 19 7/11/2024
9.0.0-preview.5.24306.7 11 6/13/2024
9.0.0-preview.4.24266.19 12 5/29/2024
9.0.0-preview.3.24172.9 17 4/13/2024
9.0.0-preview.2.24128.5 17 3/21/2024
9.0.0-preview.1.24080.9 18 2/29/2024
8.0.0 26 11/16/2023
8.0.0-rc.2.23479.6 24 10/14/2023
8.0.0-rc.1.23419.4 27 9/17/2023
8.0.0-preview.7.23375.6 26 8/23/2023
8.0.0-preview.6.23329.7 28 7/31/2023
8.0.0-preview.5.23280.8 22 7/31/2023
8.0.0-preview.4.23259.5 30 5/20/2023
8.0.0-preview.3.23174.8 23 5/12/2023
8.0.0-preview.2.23128.3 29 5/12/2023
8.0.0-preview.1.23110.8 27 2/23/2023
7.0.0 35 12/3/2022
7.0.0-rc.2.22472.3 27 12/3/2022
7.0.0-rc.1.22426.10 32 9/15/2022
7.0.0-preview.7.22375.6 33 9/15/2022
7.0.0-preview.6.22324.4 28 9/15/2022
7.0.0-preview.5.22301.12 29 6/26/2022
7.0.0-preview.4.22229.4 30 7/3/2022
7.0.0-preview.3.22175.4 29 7/3/2022
7.0.0-preview.2.22152.2 26 7/3/2022
7.0.0-preview.1.22076.8 29 7/3/2022
6.0.2-mauipre.1.22102.15 26 7/3/2022
6.0.2-mauipre.1.22054.8 29 7/3/2022
6.0.0 39 7/3/2022
6.0.0-rc.2.21480.5 31 7/3/2022
6.0.0-rc.1.21451.13 29 7/3/2022
6.0.0-preview.7.21377.19 31 7/3/2022
6.0.0-preview.6.21352.12 30 7/3/2022
6.0.0-preview.5.21301.5 34 7/3/2022
6.0.0-preview.4.21253.7 27 7/3/2022
6.0.0-preview.3.21201.4 32 7/3/2022
6.0.0-preview.2.21154.6 35 7/3/2022
6.0.0-preview.1.21102.12 31 7/3/2022
5.0.0 40 7/3/2022
5.0.0-rc.2.20475.5 28 7/3/2022
5.0.0-rc.1.20451.14 30 7/3/2022
5.0.0-preview.8.20407.11 30 7/3/2022
5.0.0-preview.7.20364.11 34 7/3/2022
5.0.0-preview.6.20305.6 36 7/3/2022
5.0.0-preview.5.20278.1 26 7/3/2022
5.0.0-preview.4.20251.6 40 7/3/2022
5.0.0-preview.3.20215.2 29 7/3/2022
5.0.0-preview.2.20160.3 31 7/3/2022
5.0.0-preview.1.20120.4 27 7/3/2022
3.1.32 42 2/21/2023
3.1.31 34 12/3/2022
3.1.30 32 12/3/2022
3.1.29 36 9/15/2022
3.1.28 34 9/3/2022
3.1.27 28 9/15/2022
3.1.26 39 7/3/2022
3.1.25 32 7/3/2022
3.1.24 35 7/3/2022
3.1.23 35 7/3/2022
3.1.22 36 7/3/2022
3.1.21 36 7/3/2022
3.1.20 33 7/3/2022
3.1.19 43 7/3/2022
3.1.18 33 7/3/2022
3.1.17 35 7/3/2022
3.1.16 45 7/3/2022
3.1.15 36 7/3/2022
3.1.14 34 7/3/2022
3.1.13 46 7/3/2022
3.1.12 33 7/3/2022
3.1.11 36 7/3/2022
3.1.10 35 7/3/2022
3.1.9 33 7/3/2022
3.1.8 39 7/3/2022
3.1.7 44 7/3/2022
3.1.6 34 7/3/2022
3.1.5 37 7/3/2022
3.1.4 35 7/3/2022
3.1.3 35 7/3/2022
3.1.2 42 7/3/2022
3.1.1 54 7/3/2022
3.1.0 37 7/3/2022
3.1.0-preview3.19553.2 33 7/3/2022
3.1.0-preview2.19525.4 30 7/3/2022
3.1.0-preview1.19506.1 38 7/3/2022
3.0.3 35 7/3/2022
3.0.2 34 7/3/2022
3.0.1 37 7/3/2022
3.0.0 46 6/13/2022
3.0.0-rc1.19456.10 35 7/3/2022
3.0.0-preview9.19423.4 23 7/3/2022
3.0.0-preview8.19405.4 29 7/3/2022
3.0.0-preview7.19362.4 32 7/3/2022
3.0.0-preview6.19304.6 27 7/3/2022
3.0.0-preview5.19227.9 35 7/3/2022
3.0.0-preview4.19216.2 32 7/3/2022
3.0.0-preview3.19153.1 32 7/3/2022
3.0.0-preview.19074.2 32 7/3/2022
3.0.0-preview.18572.1 33 7/3/2022
2.2.0 33 7/3/2022
2.2.0-preview3-35497 31 7/3/2022
2.2.0-preview2-35157 30 7/3/2022
2.2.0-preview1-35029 32 7/3/2022
2.1.1 42 7/3/2022
2.1.0 40 7/3/2022
2.1.0-rc1-final 40 7/3/2022
2.1.0-preview2-final 31 7/3/2022
2.1.0-preview1-final 33 7/3/2022
2.0.2 42 7/3/2022
2.0.1 36 7/3/2022
2.0.0 33 7/3/2022
2.0.0-preview2-final 36 7/3/2022
2.0.0-preview1-final 27 7/3/2022
1.1.2 35 7/3/2022
1.1.1 35 7/3/2022
1.1.0 42 7/3/2022
1.1.0-preview1-final 36 7/3/2022
1.0.2 33 7/3/2022
1.0.1 40 7/3/2022
1.0.0 35 7/3/2022
1.0.0-rc2-final 37 7/3/2022