Microsoft.Extensions.Options.ConfigurationExtensions 9.0.11

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.
 5,623
Microsoft.Extensions.Diagnostics
This package includes the default implementation of IMeterFactory and additional extension methods to easily register it with the Dependency Injection framework.
 2,916
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 2,805
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 864
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 511
IdentityServer4
OpenID Connect and OAuth 2.0 Framework for ASP.NET Core
 81
Microsoft.ApplicationInsights.Kubernetes
Kubernetes support for .NET Core
 77
Microsoft.ApplicationInsights.Kubernetes
Kubernetes support for .NET Core
 76
Microsoft.ApplicationInsights.Kubernetes
Kubernetes support for .NET Core
 73
Microsoft.ApplicationInsights.Kubernetes
Kubernetes support for .NET Core
 72
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
 72
Microsoft.AspNetCore
Microsoft.AspNetCore
 71
Microsoft.Extensions.Diagnostics
This package includes the default implementation of IMeterFactory and additional extension methods to easily register it with the Dependency Injection framework.
 70
Microsoft.ApplicationInsights.Kubernetes
Kubernetes support for .NET Core
 69
Microsoft.AspNetCore
Microsoft.AspNetCore
 68
IdentityServer4
OpenID Connect and OAuth 2.0 Framework for ASP.NET Core
 68
Microsoft.ApplicationInsights.Kubernetes
Kubernetes support for .NET Core
 68

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

.NET Framework 4.6.2

.NET Standard 2.0

.NET 9.0

.NET 8.0

Version Downloads Last updated
10.0.0 4 11/13/2025
10.0.0-rc.2.25502.107 5 10/16/2025
10.0.0-rc.1.25451.107 7 09/11/2025
10.0.0-preview.7.25380.108 14 08/14/2025
10.0.0-preview.6.25358.103 13 07/17/2025
10.0.0-preview.5.25277.114 19 06/14/2025
10.0.0-preview.4.25258.110 18 05/15/2025
10.0.0-preview.3.25171.5 24 04/11/2025
10.0.0-preview.2.25163.2 26 03/23/2025
10.0.0-preview.1.25080.5 23 02/26/2025
9.0.11 3 11/13/2025
9.0.10 6 10/16/2025
9.0.9 6 09/11/2025
9.0.8 14 08/07/2025
9.0.7 14 07/10/2025
9.0.6 17 06/13/2025
9.0.5 25 05/16/2025
9.0.4 28 04/11/2025
9.0.3 27 03/12/2025
9.0.2 26 02/19/2025
9.0.1 24 01/17/2025
9.0.0 859 11/13/2024
9.0.0-rc.2.24473.5 52 10/08/2024
9.0.0-rc.1.24431.7 40 09/11/2024
9.0.0-preview.7.24405.7 43 08/13/2024
9.0.0-preview.6.24327.7 54 07/19/2024
9.0.0-preview.5.24306.7 42 06/14/2024
9.0.0-preview.4.24266.19 49 05/25/2024
9.0.0-preview.3.24172.9 45 04/11/2024
9.0.0-preview.2.24128.5 44 03/14/2024
9.0.0-preview.1.24080.9 53 03/10/2024
8.0.0 5,615 11/15/2023
8.0.0-rc.2.23479.6 47 10/17/2023
8.0.0-rc.1.23419.4 46 09/14/2023
8.0.0-preview.7.23375.6 51 08/27/2023
8.0.0-preview.6.23329.7 55 07/21/2023
8.0.0-preview.5.23280.8 50 08/22/2023
8.0.0-preview.4.23259.5 47 06/17/2023
8.0.0-preview.3.23174.8 47 06/28/2023
8.0.0-preview.2.23128.3 42 06/27/2023
8.0.0-preview.1.23110.8 51 04/08/2023
7.0.0 60 04/13/2023
7.0.0-rc.2.22472.3 62 11/25/2022
7.0.0-rc.1.22426.10 52 06/27/2023
7.0.0-preview.7.22375.6 56 10/17/2022
7.0.0-preview.6.22324.4 51 07/01/2023
7.0.0-preview.5.22301.12 47 07/06/2023
7.0.0-preview.4.22229.4 51 12/17/2022
7.0.0-preview.3.22175.4 45 06/30/2023
7.0.0-preview.2.22152.2 53 06/30/2023
7.0.0-preview.1.22076.8 48 05/08/2023
6.0.2-mauipre.1.22102.15 48 06/30/2023
6.0.2-mauipre.1.22054.8 50 06/29/2023
6.0.1 38 11/13/2024
6.0.0 2,799 12/07/2021
6.0.0-rc.2.21480.5 57 06/08/2023
6.0.0-rc.1.21451.13 49 07/01/2023
6.0.0-preview.7.21377.19 57 12/20/2021
6.0.0-preview.6.21352.12 52 12/20/2021
6.0.0-preview.5.21301.5 46 07/01/2023
6.0.0-preview.4.21253.7 46 07/02/2023
6.0.0-preview.3.21201.4 46 06/21/2023
6.0.0-preview.2.21154.6 56 10/13/2022
6.0.0-preview.1.21102.12 49 11/17/2022
5.0.0 61 06/29/2022
5.0.0-rc.2.20475.5 63 06/04/2023
5.0.0-rc.1.20451.14 63 06/30/2023
5.0.0-preview.8.20407.11 53 12/10/2022
5.0.0-preview.7.20364.11 51 06/24/2023
5.0.0-preview.6.20305.6 54 07/02/2023
5.0.0-preview.5.20278.1 51 06/29/2023
5.0.0-preview.4.20251.6 47 06/29/2023
5.0.0-preview.3.20215.2 51 06/05/2023
5.0.0-preview.2.20160.3 51 06/29/2023
5.0.0-preview.1.20120.4 46 10/12/2022
3.1.32 49 06/04/2023
3.1.31 51 06/19/2023
3.1.30 58 05/18/2023
3.1.29 51 06/07/2023
3.1.28 56 04/06/2023
3.1.27 48 06/05/2023
3.1.26 52 06/30/2023
3.1.25 40 06/30/2023
3.1.24 50 06/27/2023
3.1.23 53 05/16/2023
3.1.22 58 04/26/2023
3.1.21 57 05/20/2023
3.1.20 53 01/01/2023
3.1.19 43 06/28/2023
3.1.18 50 06/08/2023
3.1.17 52 06/26/2023
3.1.16 58 12/10/2022
3.1.15 53 05/11/2023
3.1.14 52 06/04/2023
3.1.13 54 04/09/2023
3.1.12 56 09/19/2022
3.1.11 52 06/11/2022
3.1.10 58 12/18/2022
3.1.9 53 05/21/2023
3.1.8 44 07/04/2023
3.1.7 53 11/09/2020
3.1.6 54 10/18/2022
3.1.5 46 06/29/2023
3.1.4 52 06/30/2023
3.1.3 52 03/13/2023
3.1.2 56 09/16/2022
3.1.1 54 05/22/2023
3.1.0 513 07/11/2022
3.1.0-preview3.19553.2 48 06/07/2022
3.1.0-preview2.19525.4 98 06/29/2023
3.1.0-preview1.19506.1 48 06/30/2023
3.0.3 53 05/15/2023
3.0.2 50 01/08/2023
3.0.1 53 12/21/2022
3.0.0 53 09/27/2022
3.0.0-rc1.19456.10 46 07/02/2023
3.0.0-preview9.19423.4 44 06/30/2023
3.0.0-preview8.19405.4 49 06/27/2023
3.0.0-preview7.19362.4 56 06/29/2023
3.0.0-preview6.19304.6 52 07/01/2023
3.0.0-preview5.19227.9 45 06/30/2023
3.0.0-preview4.19216.2 48 06/27/2023
3.0.0-preview3.19153.1 47 06/30/2023
3.0.0-preview.19074.2 39 06/30/2023
3.0.0-preview.18572.1 41 06/30/2023
2.2.0 53 07/14/2022
2.2.0-preview3-35497 45 06/30/2023
2.2.0-preview2-35157 46 07/01/2023
2.2.0-preview1-35029 38 06/29/2023
2.1.1 56 06/07/2022
2.1.0 52 06/29/2023
2.1.0-rc1-final 45 06/30/2023
2.1.0-preview2-final 50 06/27/2023
2.1.0-preview1-final 52 06/30/2023
2.0.2 50 06/26/2023
2.0.1 52 05/04/2023
2.0.0 56 06/07/2022
2.0.0-preview2-final 43 05/10/2023
2.0.0-preview1-final 54 03/17/2023
1.1.2 45 06/19/2023
1.1.1 51 12/31/2022
1.1.0 48 01/04/2023
1.1.0-preview1-final 44 05/08/2023
1.0.2 50 05/04/2023
1.0.1 51 12/20/2021
1.0.0 50 06/30/2023
1.0.0-rc2-final 50 05/14/2023