Microsoft.Extensions.Options.ConfigurationExtensions 10.0.9

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
R4Mvc.Tools
R4Mvc is a tool that generates strongly typed helpers for ASP.NET Core MVC.
160
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.
148
R4Mvc.Tools
R4Mvc is a tool that generates strongly typed helpers for ASP.NET Core MVC.
147
R4Mvc.Tools
R4Mvc is a tool that generates strongly typed helpers for ASP.NET Core MVC.
145
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
142
R4Mvc.Tools
R4Mvc is a tool that generates strongly typed helpers for ASP.NET Core MVC.
141
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.
141
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
137
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
135
Microsoft.Extensions.Logging.Console
Console logger provider implementation for Microsoft.Extensions.Logging.
133
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.
132
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
131
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
131
R4Mvc.Tools
R4Mvc is a tool that generates strongly typed helpers for ASP.NET Core MVC.
131
R4Mvc.Tools
R4Mvc is a tool that generates strongly typed helpers for ASP.NET Core MVC.
130
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
130
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
128

Version Downloads Last updated
11.0.0-preview.5.26302.115 5 6/10/2026
11.0.0-preview.4.26230.115 10 5/12/2026
11.0.0-preview.3.26207.106 14 5/4/2026
11.0.0-preview.2.26159.112 14 3/12/2026
11.0.0-preview.1.26104.118 19 2/14/2026
10.0.9 4 6/10/2026
10.0.8 10 5/12/2026
10.0.7 11 5/4/2026
10.0.6 11 5/4/2026
10.0.5 13 3/14/2026
10.0.4 14 3/12/2026
10.0.3 19 2/14/2026
10.0.2 23 1/13/2026
10.0.1 32 12/11/2025
10.0.0 48 11/11/2025
10.0.0-rc.2.25502.107 59 10/17/2025
10.0.0-rc.1.25451.107 75 9/10/2025
10.0.0-preview.7.25380.108 85 8/15/2025
10.0.0-preview.6.25358.103 74 7/15/2025
10.0.0-preview.5.25277.114 83 6/8/2025
10.0.0-preview.4.25258.110 94 5/16/2025
10.0.0-preview.3.25171.5 98 4/14/2025
10.0.0-preview.2.25163.2 86 3/27/2025
10.0.0-preview.1.25080.5 111 2/27/2025
9.0.17 4 6/10/2026
9.0.16 10 5/12/2026
9.0.15 13 5/4/2026
9.0.14 14 3/12/2026
9.0.13 21 2/14/2026
9.0.12 20 1/13/2026
9.0.11 50 11/11/2025
9.0.10 69 10/17/2025
9.0.9 70 9/10/2025
9.0.8 78 8/6/2025
9.0.7 70 7/8/2025
9.0.6 90 6/12/2025
9.0.5 78 5/17/2025
9.0.4 80 4/9/2025
9.0.3 91 3/11/2025
9.0.2 93 2/13/2025
9.0.1 103 1/18/2025
9.0.0 103 11/17/2024
9.0.0-rc.2.24473.5 98 10/19/2024
9.0.0-rc.1.24431.7 99 9/11/2024
9.0.0-preview.7.24405.7 94 8/14/2024
9.0.0-preview.6.24327.7 114 7/11/2024
9.0.0-preview.5.24306.7 120 6/13/2024
9.0.0-preview.4.24266.19 112 5/29/2024
9.0.0-preview.3.24172.9 111 4/13/2024
9.0.0-preview.2.24128.5 122 3/21/2024
9.0.0-preview.1.24080.9 123 2/29/2024
8.0.0 137 11/16/2023
8.0.0-rc.2.23479.6 146 10/14/2023
8.0.0-rc.1.23419.4 151 9/17/2023
8.0.0-preview.7.23375.6 139 8/23/2023
8.0.0-preview.6.23329.7 129 7/31/2023
8.0.0-preview.5.23280.8 131 7/31/2023
8.0.0-preview.4.23259.5 124 5/20/2023
8.0.0-preview.3.23174.8 110 5/12/2023
8.0.0-preview.2.23128.3 135 5/12/2023
8.0.0-preview.1.23110.8 122 2/23/2023
7.0.0 123 12/3/2022
7.0.0-rc.2.22472.3 124 12/3/2022
7.0.0-rc.1.22426.10 138 9/15/2022
7.0.0-preview.7.22375.6 122 9/15/2022
7.0.0-preview.6.22324.4 127 9/15/2022
7.0.0-preview.5.22301.12 115 6/26/2022
7.0.0-preview.4.22229.4 116 7/3/2022
7.0.0-preview.3.22175.4 127 7/3/2022
7.0.0-preview.2.22152.2 114 7/3/2022
7.0.0-preview.1.22076.8 128 7/3/2022
6.0.2-mauipre.1.22102.15 123 7/3/2022
6.0.2-mauipre.1.22054.8 141 7/3/2022
6.0.1 102 11/18/2024
6.0.0 141 7/3/2022
6.0.0-rc.2.21480.5 144 7/3/2022
6.0.0-rc.1.21451.13 140 7/3/2022
6.0.0-preview.7.21377.19 154 7/3/2022
6.0.0-preview.6.21352.12 143 7/3/2022
6.0.0-preview.5.21301.5 133 7/3/2022
6.0.0-preview.4.21253.7 122 7/3/2022
6.0.0-preview.3.21201.4 144 7/3/2022
6.0.0-preview.2.21154.6 134 7/3/2022
6.0.0-preview.1.21102.12 132 7/3/2022
5.0.0 126 7/3/2022
5.0.0-rc.2.20475.5 120 7/3/2022
5.0.0-rc.1.20451.14 126 7/3/2022
5.0.0-preview.8.20407.11 133 7/3/2022
5.0.0-preview.7.20364.11 138 7/3/2022
5.0.0-preview.6.20305.6 118 7/3/2022
5.0.0-preview.5.20278.1 119 7/3/2022
5.0.0-preview.4.20251.6 147 7/3/2022
5.0.0-preview.3.20215.2 132 7/3/2022
5.0.0-preview.2.20160.3 118 7/3/2022
5.0.0-preview.1.20120.4 130 7/3/2022
3.1.32 131 2/21/2023
3.1.31 134 12/3/2022
3.1.30 138 12/3/2022
3.1.29 129 9/15/2022
3.1.28 131 9/3/2022
3.1.27 118 9/15/2022
3.1.26 126 7/3/2022
3.1.25 124 7/3/2022
3.1.24 134 7/3/2022
3.1.23 137 7/3/2022
3.1.22 131 7/3/2022
3.1.21 134 7/3/2022
3.1.20 140 7/3/2022
3.1.19 147 7/3/2022
3.1.18 137 7/3/2022
3.1.17 124 7/3/2022
3.1.16 151 7/3/2022
3.1.15 127 7/3/2022
3.1.14 125 7/3/2022
3.1.13 158 7/3/2022
3.1.12 144 7/3/2022
3.1.11 122 7/3/2022
3.1.10 140 7/3/2022
3.1.9 124 7/3/2022
3.1.8 133 7/3/2022
3.1.7 140 7/3/2022
3.1.6 140 7/3/2022
3.1.5 119 7/3/2022
3.1.4 127 7/3/2022
3.1.3 129 7/3/2022
3.1.2 149 7/3/2022
3.1.1 135 7/3/2022
3.1.0 131 7/3/2022
3.1.0-preview3.19553.2 130 7/3/2022
3.1.0-preview2.19525.4 125 7/3/2022
3.1.0-preview1.19506.1 130 7/3/2022
3.0.3 141 7/3/2022
3.0.2 127 7/3/2022
3.0.1 131 7/3/2022
3.0.0 138 6/13/2022
3.0.0-rc1.19456.10 130 7/3/2022
3.0.0-preview9.19423.4 121 7/3/2022
3.0.0-preview8.19405.4 129 7/3/2022
3.0.0-preview7.19362.4 130 7/3/2022
3.0.0-preview6.19304.6 108 7/3/2022
3.0.0-preview5.19227.9 130 7/3/2022
3.0.0-preview4.19216.2 140 7/3/2022
3.0.0-preview3.19153.1 124 7/3/2022
3.0.0-preview.19074.2 133 7/3/2022
3.0.0-preview.18572.1 134 7/3/2022
2.2.0 115 7/3/2022
2.2.0-preview3-35497 110 7/3/2022
2.2.0-preview2-35157 115 7/3/2022
2.2.0-preview1-35029 131 7/3/2022
2.1.1 135 7/3/2022
2.1.0 138 7/3/2022
2.1.0-rc1-final 131 7/3/2022
2.1.0-preview2-final 129 7/3/2022
2.1.0-preview1-final 134 7/3/2022
2.0.2 149 7/3/2022
2.0.1 130 7/3/2022
2.0.0 121 7/3/2022
2.0.0-preview2-final 124 7/3/2022
2.0.0-preview1-final 129 7/3/2022
1.1.2 131 7/3/2022
1.1.1 126 7/3/2022
1.1.0 124 7/3/2022
1.1.0-preview1-final 123 7/3/2022
1.0.2 131 7/3/2022
1.0.1 141 7/3/2022
1.0.0 118 7/3/2022
1.0.0-rc2-final 146 7/3/2022