Microsoft.Extensions.Options.ConfigurationExtensions 9.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 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.AmbientMetadata.Application
Runtime information provider for application-level ambient metadata.
 350
Microsoft.Extensions.AmbientMetadata.Application
Runtime information provider for application-level ambient metadata.
 513
Microsoft.Extensions.Diagnostics
This package includes the default implementation of IMeterFactory and additional extension methods to easily register it with the Dependency Injection framework.
 81
Microsoft.Extensions.Diagnostics
This package includes the default implementation of IMeterFactory and additional extension methods to easily register it with the Dependency Injection framework.
 511
Microsoft.Extensions.Diagnostics
This package includes the default implementation of IMeterFactory and additional extension methods to easily register it with the Dependency Injection framework.
 514
Microsoft.Extensions.Diagnostics
This package includes the default implementation of IMeterFactory and additional extension methods to easily register it with the Dependency Injection framework.
 1 027
Microsoft.Extensions.Http.Diagnostics
Telemetry support for HTTP Client.
 350
Microsoft.Extensions.Http.Diagnostics
Telemetry support for HTTP Client.
 513
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 57
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 87
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 762
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 879
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 951
Microsoft.Extensions.Resilience
Extensions to the Polly libraries to enrich telemetry with metadata and exception summaries.
 350
Microsoft.Extensions.Resilience
Extensions to the Polly libraries to enrich telemetry with metadata and exception summaries.
 512
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
 128
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
 131
Serilog.Sinks.MSSqlServer
A Serilog sink that writes events to Microsoft SQL Server and Azure SQL
 56
Serilog.Sinks.MSSqlServer
A Serilog sink that writes events to Microsoft SQL Server and Azure SQL
 101
SixLabors.ImageSharp.Web
ImageSharp Middleware for serving images via a url based API.
 1 114

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
10.0.1 0 2025-12-09
10.0.0 0 2025-11-11
10.0.0-rc.2.25502.107 0 2025-10-14
10.0.0-rc.1.25451.107 0 2025-09-09
10.0.0-preview.7.25380.108 0 2025-08-12
10.0.0-preview.6.25358.103 0 2025-07-15
10.0.0-preview.5.25277.114 0 2025-06-06
10.0.0-preview.4.25258.110 0 2025-05-12
10.0.0-preview.3.25171.5 0 2025-04-10
10.0.0-preview.2.25163.2 0 2025-03-18
10.0.0-preview.1.25080.5 0 2025-02-25
9.0.11 0 2025-11-11
9.0.10 0 2025-10-14
9.0.9 513 2025-09-15
9.0.8 0 2025-08-04
9.0.7 0 2025-07-08
9.0.6 0 2025-06-10
9.0.5 0 2025-05-13
9.0.4 61 2025-05-21
9.0.3 21 2025-08-14
9.0.2 0 2025-02-11
9.0.1 0 2025-01-14
9.0.0 868 2025-03-04
9.0.0-rc.2.24473.5 0 2024-10-08
9.0.0-rc.1.24431.7 0 2024-09-10
9.0.0-preview.7.24405.7 0 2024-08-13
9.0.0-preview.6.24327.7 0 2024-07-09
9.0.0-preview.5.24306.7 0 2024-06-11
9.0.0-preview.4.24266.19 0 2024-05-21
9.0.0-preview.3.24172.9 0 2024-04-11
9.0.0-preview.2.24128.5 0 2024-03-12
9.0.0-preview.1.24080.9 0 2024-02-13
8.0.0 1 299 2025-03-19
8.0.0-rc.2.23479.6 0 2023-10-10
8.0.0-rc.1.23419.4 0 2023-09-12
8.0.0-preview.7.23375.6 0 2023-08-08
8.0.0-preview.6.23329.7 0 2023-07-11
8.0.0-preview.5.23280.8 0 2023-06-13
8.0.0-preview.4.23259.5 0 2023-05-16
8.0.0-preview.3.23174.8 0 2023-04-11
8.0.0-preview.2.23128.3 0 2023-03-14
8.0.0-preview.1.23110.8 0 2023-02-21
7.0.0 6 2025-03-25
7.0.0-rc.2.22472.3 0 2022-10-11
7.0.0-rc.1.22426.10 0 2022-09-14
7.0.0-preview.7.22375.6 0 2022-08-09
7.0.0-preview.6.22324.4 0 2022-07-12
7.0.0-preview.5.22301.12 0 2022-06-14
7.0.0-preview.4.22229.4 0 2022-05-10
7.0.0-preview.3.22175.4 0 2022-04-13
7.0.0-preview.2.22152.2 0 2022-03-14
7.0.0-preview.1.22076.8 0 2022-02-17
6.0.1 0 2024-11-12
6.0.0 3 391 2025-01-15
6.0.0-rc.2.21480.5 0 2021-10-12
6.0.0-rc.1.21451.13 0 2021-09-14
6.0.0-preview.7.21377.19 0 2021-08-10
6.0.0-preview.6.21352.12 0 2021-07-14
6.0.0-preview.5.21301.5 0 2021-06-15
6.0.0-preview.4.21253.7 0 2021-05-24
6.0.0-preview.3.21201.4 0 2021-04-08
6.0.0-preview.2.21154.6 0 2021-03-11
6.0.0-preview.1.21102.12 0 2021-02-12
5.0.0 1 2025-05-21
5.0.0-rc.2.20475.5 0 2020-10-13
5.0.0-rc.1.20451.14 0 2020-09-14
5.0.0-preview.8.20407.11 0 2020-08-25
5.0.0-preview.7.20364.11 0 2020-07-21
5.0.0-preview.6.20305.6 0 2020-06-25
5.0.0-preview.5.20278.1 0 2020-06-10
5.0.0-preview.4.20251.6 0 2020-05-18
5.0.0-preview.3.20215.2 0 2020-04-23
5.0.0-preview.2.20160.3 0 2020-04-02
5.0.0-preview.1.20120.4 0 2020-03-16
3.1.32 0 2022-12-13
3.1.31 0 2022-11-08
3.1.30 0 2022-10-11
3.1.29 0 2022-09-13
3.1.28 0 2022-08-09
3.1.27 0 2022-07-12
3.1.26 0 2022-06-14
3.1.25 0 2022-05-10
3.1.24 0 2022-04-11
3.1.23 0 2022-03-08
3.1.22 0 2021-12-14
3.1.21 0 2021-11-07
3.1.20 0 2021-10-11
3.1.19 0 2021-09-14
3.1.18 0 2021-08-10
3.1.17 0 2021-07-13
3.1.16 0 2021-06-08
3.1.15 0 2021-05-11
3.1.14 0 2021-04-06
3.1.13 0 2021-03-09
3.1.12 0 2021-02-09
3.1.11 0 2021-01-12
3.1.10 0 2020-11-09
3.1.9 0 2020-10-13
3.1.8 0 2020-09-08
3.1.7 0 2020-08-11
3.1.6 0 2020-07-14
3.1.5 0 2020-06-09
3.1.4 0 2020-05-12
3.1.3 0 2020-03-24
3.1.2 0 2020-02-18
3.1.1 0 2020-01-14
3.1.0 0 2019-12-03
3.1.0-preview3.19553.2 0 2019-11-13
3.1.0-preview2.19525.4 0 2019-11-01
3.1.0-preview1.19506.1 0 2019-10-15
3.0.3 0 2020-02-18
3.0.2 0 2020-01-14
3.0.1 0 2019-11-18
3.0.0 0 2019-09-23
3.0.0-rc1.19456.10 0 2019-09-16
3.0.0-preview9.19423.4 0 2019-09-04
3.0.0-preview8.19405.4 0 2019-08-13
3.0.0-preview7.19362.4 0 2019-07-23
3.0.0-preview6.19304.6 0 2019-06-12
3.0.0-preview5.19227.9 0 2019-05-06
3.0.0-preview4.19216.2 0 2019-04-18
3.0.0-preview3.19153.1 0 2019-03-06
3.0.0-preview.19074.2 0 2019-01-29
3.0.0-preview.18572.1 0 2018-12-04
2.2.0 0 2018-12-03
2.2.0-preview3-35497 0 2018-10-17
2.2.0-preview2-35157 0 2018-09-12
2.2.0-preview1-35029 0 2018-08-22
2.1.1 0 2018-06-18
2.1.0 0 2018-05-29
2.1.0-rc1-final 0 2018-05-06
2.1.0-preview2-final 0 2018-04-10
2.1.0-preview1-final 0 2018-02-26
2.0.2 0 2018-05-07
2.0.1 0 2018-03-13
2.0.0 144 2025-02-27
2.0.0-preview2-final 0 2017-06-28
2.0.0-preview1-final 0 2017-05-10
1.1.2 0 2017-05-09
1.1.1 0 2017-03-06
1.1.0 0 2016-11-16
1.1.0-preview1-final 0 2016-10-24
1.0.2 0 2017-03-06
1.0.1 0 2016-12-12
1.0.0 0 2016-06-27
1.0.0-rc2-final 0 2016-05-16