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.Logging.Configuration Configuration support for Microsoft.Extensions.Logging.	7,119
Serilog.Settings.Configuration Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.	1,677
Serilog.Settings.Configuration Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.	806
Minio.AspNetCore ASP.NET Core extensions for Minio client	364
Alipay.AopSdk.AspnetCore 支付宝（Alipay）服务端SDK AopSdk，ASP.NET Core 项目只用安装这一个组件。使用文档 https://github.com/dotnetcore/Alipay.AopSdk.Core	335
Microsoft.Extensions.Logging.Configuration Configuration support for Microsoft.Extensions.Logging.	299
Microsoft.Extensions.Logging.Configuration Configuration support for Microsoft.Extensions.Logging.	296
Alipay.AopSdk.AspnetCore 支付宝（Alipay）服务端SDK AopSdk，ASP.NET Core 项目只用安装这一个组件。使用文档 https://github.com/dotnetcore/Alipay.AopSdk.Core	64
Alipay.AopSdk.AspnetCore 支付宝（Alipay）服务端SDK AopSdk，ASP.NET Core 项目只用安装这一个组件。使用文档 https://github.com/dotnetcore/Alipay.AopSdk.Core	59
Alipay.AopSdk.AspnetCore 支付宝（Alipay）服务端SDK AopSdk，ASP.NET Core 项目只用安装这一个组件。使用文档 https://github.com/dotnetcore/Alipay.AopSdk.Core	58
Alipay.AopSdk.AspnetCore 支付宝（Alipay）服务端SDK AopSdk，ASP.NET Core 项目只用安装这一个组件。使用文档 https://github.com/dotnetcore/Alipay.AopSdk.Core	57
Alipay.AopSdk.AspnetCore 支付宝（Alipay）服务端SDK AopSdk，ASP.NET Core 项目只用安装这一个组件。使用文档 https://github.com/dotnetcore/Alipay.AopSdk.Core	51
Alipay.AopSdk.AspnetCore 支付宝（Alipay）服务端SDK AopSdk，ASP.NET Core 项目只用安装这一个组件。使用文档 https://github.com/dotnetcore/Alipay.AopSdk.Core	49
Alipay.AopSdk.AspnetCore 支付宝（Alipay）服务端SDK AopSdk，ASP.NET Core 项目只用安装这一个组件。使用文档 https://github.com/dotnetcore/Alipay.AopSdk.Core	48
Microsoft.Extensions.Logging.Console Console logger provider implementation for Microsoft.Extensions.Logging.	48
Microsoft.AspNetCore Microsoft.AspNetCore	44
Microsoft.AspNetCore Microsoft.AspNetCore	43
Alipay.AopSdk.AspnetCore 支付宝（Alipay）服务端SDK AopSdk，ASP.NET Core 项目只用安装这一个组件。使用文档 https://github.com/dotnetcore/Alipay.AopSdk.Core	43
Senparc.CO2NET Senparc.CO2NET 公共基础库 Senparc.Weixin SDK 开源项目： https://github.com/Senparc/Senparc.CO2NET	42

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

Version	Downloads	Last updated
9.0.0	6	11/13/2024
9.0.0-rc.2.24473.5	10	10/12/2024
9.0.0-rc.1.24431.7	11	09/10/2024
9.0.0-preview.7.24405.7	16	08/14/2024
9.0.0-preview.6.24327.7	22	07/10/2024
9.0.0-preview.5.24306.7	24	06/11/2024
9.0.0-preview.4.24266.19	24	05/23/2024
9.0.0-preview.3.24172.9	20	04/13/2024
9.0.0-preview.2.24128.5	33	03/13/2024
9.0.0-preview.1.24080.9	28	02/22/2024
8.0.0	30	11/14/2023
8.0.0-rc.2.23479.6	33	10/31/2023
8.0.0-rc.1.23419.4	32	09/13/2023
8.0.0-preview.7.23375.6	40	08/09/2023
8.0.0-preview.6.23329.7	51	07/11/2023
8.0.0-preview.5.23280.8	64	06/16/2023
8.0.0-preview.4.23259.5	62	05/26/2023
8.0.0-preview.3.23174.8	61	06/06/2023
8.0.0-preview.2.23128.3	55	06/18/2023
8.0.0-preview.1.23110.8	59	06/16/2023
7.0.0	68	05/16/2023
7.0.0-rc.2.22472.3	63	06/09/2023
7.0.0-rc.1.22426.10	68	06/15/2023
7.0.0-preview.7.22375.6	58	06/06/2023
7.0.0-preview.6.22324.4	63	06/06/2023
7.0.0-preview.5.22301.12	65	06/09/2023
7.0.0-preview.4.22229.4	54	06/11/2023
7.0.0-preview.3.22175.4	75	06/13/2023
7.0.0-preview.2.22152.2	55	06/08/2023
7.0.0-preview.1.22076.8	47	06/05/2023
6.0.2-mauipre.1.22102.15	51	06/13/2023
6.0.2-mauipre.1.22054.8	59	06/15/2023
6.0.1	7	11/13/2024
6.0.0	402	11/12/2021
6.0.0-rc.2.21480.5	64	06/14/2023
6.0.0-rc.1.21451.13	71	06/04/2023
6.0.0-preview.7.21377.19	57	06/13/2023
6.0.0-preview.6.21352.12	71	06/07/2023
6.0.0-preview.5.21301.5	59	06/16/2023
6.0.0-preview.4.21253.7	64	06/10/2023
6.0.0-preview.3.21201.4	56	06/13/2023
6.0.0-preview.2.21154.6	67	06/11/2023
6.0.0-preview.1.21102.12	66	06/04/2023
5.0.0	64	09/18/2021
5.0.0-rc.2.20475.5	54	06/15/2023
5.0.0-rc.1.20451.14	52	06/07/2023
5.0.0-preview.8.20407.11	60	06/06/2023
5.0.0-preview.7.20364.11	52	06/13/2023
5.0.0-preview.6.20305.6	60	06/16/2023
5.0.0-preview.5.20278.1	46	06/16/2023
5.0.0-preview.4.20251.6	52	06/08/2023
5.0.0-preview.3.20215.2	58	06/04/2023
5.0.0-preview.2.20160.3	56	06/08/2023
5.0.0-preview.1.20120.4	58	06/13/2023
3.1.32	47	07/06/2023
3.1.31	53	07/07/2023
3.1.30	58	07/06/2023
3.1.29	53	07/06/2023
3.1.28	43	07/08/2023
3.1.27	37	06/08/2023
3.1.26	75	07/07/2023
3.1.25	46	07/10/2023
3.1.24	52	06/22/2023
3.1.23	53	06/21/2023
3.1.22	40	07/06/2023
3.1.21	43	07/23/2023
3.1.20	48	06/20/2023
3.1.19	70	06/15/2023
3.1.18	59	06/18/2023
3.1.17	53	07/09/2023
3.1.16	52	06/29/2023
3.1.15	45	06/29/2023
3.1.14	46	06/20/2023
3.1.13	69	06/15/2023
3.1.12	55	06/22/2023
3.1.11	54	06/29/2023
3.1.10	62	07/07/2023
3.1.9	65	06/16/2023
3.1.8	50	06/11/2023
3.1.7	53	06/15/2023
3.1.6	56	06/11/2023
3.1.5	52	06/12/2023
3.1.4	64	06/13/2023
3.1.3	7,125	12/16/2020
3.1.2	54	06/13/2023
3.1.1	61	06/13/2023
3.1.0	326	06/22/2022
3.1.0-preview3.19553.2	56	06/09/2023
3.1.0-preview2.19525.4	50	06/15/2023
3.1.0-preview1.19506.1	55	06/06/2023
3.0.3	50	06/14/2023
3.0.2	77	06/10/2023
3.0.1	57	06/13/2023
3.0.0	75	06/13/2023
3.0.0-rc1.19456.10	86	06/08/2023
3.0.0-preview9.19423.4	39	06/17/2023
3.0.0-preview8.19405.4	46	06/11/2023
3.0.0-preview7.19362.4	49	06/14/2023
3.0.0-preview6.19304.6	53	06/14/2023
3.0.0-preview5.19227.9	51	06/17/2023
3.0.0-preview4.19216.2	73	06/08/2023
3.0.0-preview3.19153.1	58	06/13/2023
3.0.0-preview.19074.2	67	06/09/2023
3.0.0-preview.18572.1	58	06/09/2023
2.2.0	64	06/15/2023
2.2.0-preview3-35497	59	06/09/2023
2.2.0-preview2-35157	64	06/14/2023
2.2.0-preview1-35029	58	06/06/2023
2.1.1	66	06/11/2023
2.1.0	82	06/16/2023
2.1.0-rc1-final	67	06/11/2023
2.1.0-preview2-final	65	06/09/2023
2.1.0-preview1-final	66	06/05/2023
2.0.2	59	06/12/2023
2.0.1	66	06/12/2023
2.0.0	2,773	01/18/2021
2.0.0-preview2-final	58	06/05/2023
2.0.0-preview1-final	61	06/10/2023
1.1.2	65	06/13/2023
1.1.1	65	06/12/2023
1.1.0	57	06/18/2023
1.1.0-preview1-final	54	06/09/2023
1.0.2	67	06/06/2023
1.0.1	54	06/12/2023
1.0.0	62	06/17/2023
1.0.0-rc2-final	65	06/11/2023

Microsoft.Extensions.Options.ConfigurationExtensions 9.0.0

Readme

About

Key Features

How to Use

Options Configuration binding

Monitoring options configuration changes

Main Types

Additional Documentation

Related Packages

Feedback & Contributing

Used By

Release Notes

Dependencies

.NET Framework 4.6.2

.NET Standard 2.0

.NET 9.0

.NET 8.0

Versions