Microsoft.Extensions.Options.ConfigurationExtensions 9.0.0-preview.3.24172.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
IdentityServer4
OpenID Connect and OAuth 2.0 Framework for ASP.NET Core
 39
Microsoft.AspNetCore.All
Microsoft.AspNetCore.All
 32
Microsoft.AspNetCore.All
Provides a default set of APIs for building an ASP.NET Core application, and also includes API for third-party integrations with ASP.NET Core. This package requires the ASP.NET Core runtime. This runtime is installed by the .NET Core SDK, or can be acquired separately using installers available at https://aka.ms/dotnet-download.
 33
Microsoft.AspNetCore.App
Provides a default set of APIs for building an ASP.NET Core application. This package requires the ASP.NET Core runtime. This runtime is installed by the .NET Core SDK, or can be acquired separately using installers available at https://aka.ms/dotnet-download.
 33
Microsoft.AspNetCore.App
Provides a default set of APIs for building an ASP.NET Core application. This package requires the ASP.NET Core runtime. This runtime is installed by the .NET Core SDK, or can be acquired separately using installers available at https://aka.ms/dotnet-download.
 34
Microsoft.AspNetCore.App
Provides a default set of APIs for building an ASP.NET Core application. This package requires the ASP.NET Core runtime. This runtime is installed by the .NET Core SDK, or can be acquired separately using installers available at https://aka.ms/dotnet-download.
 35
Microsoft.AspNetCore.App
Provides a default set of APIs for building an ASP.NET Core application. This package requires the ASP.NET Core runtime. This runtime is installed by the .NET Core SDK, or can be acquired separately using installers available at https://aka.ms/dotnet-download.
 41
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 33
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 35
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 37
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
 42
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
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
 35
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
 36
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
 42
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
 43
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
 9,847
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
 13,604

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
9.0.0-preview.3.24172.9 1 04/17/2024
9.0.0-preview.2.24128.5 3 03/15/2024
9.0.0-preview.1.24080.9 3 02/24/2024
8.0.0 11 11/16/2023
8.0.0-rc.2.23479.6 9 10/10/2023
8.0.0-rc.1.23419.4 5 10/04/2023
8.0.0-preview.7.23375.6 11 08/15/2023
8.0.0-preview.6.23329.7 8 09/05/2023
8.0.0-preview.5.23280.8 8 06/18/2023
8.0.0-preview.4.23259.5 10 06/23/2023
8.0.0-preview.3.23174.8 10 06/23/2023
8.0.0-preview.2.23128.3 11 06/23/2023
8.0.0-preview.1.23110.8 10 06/23/2023
7.0.0 9 06/23/2023
7.0.0-rc.2.22472.3 28 02/16/2023
7.0.0-rc.1.22426.10 13 09/25/2022
7.0.0-preview.7.22375.6 43 09/21/2022
7.0.0-preview.6.22324.4 11 09/24/2022
7.0.0-preview.5.22301.12 16 09/26/2022
7.0.0-preview.4.22229.4 8 09/25/2022
7.0.0-preview.3.22175.4 11 09/22/2022
7.0.0-preview.2.22152.2 10 09/23/2022
7.0.0-preview.1.22076.8 15 09/26/2022
6.0.2-mauipre.1.22102.15 50 09/26/2022
6.0.2-mauipre.1.22054.8 9 12/17/2022
6.0.0 7 07/18/2022
6.0.0-rc.2.21480.5 11 09/23/2022
6.0.0-rc.1.21451.13 20 09/24/2022
6.0.0-preview.7.21377.19 15 09/26/2022
6.0.0-preview.6.21352.12 12 09/24/2022
6.0.0-preview.5.21301.5 17 01/07/2023
6.0.0-preview.4.21253.7 8 09/03/2023
6.0.0-preview.3.21201.4 10 09/23/2022
6.0.0-preview.2.21154.6 11 09/25/2022
6.0.0-preview.1.21102.12 12 09/24/2022
5.0.0 30 09/23/2022
5.0.0-rc.2.20475.5 50 09/22/2022
5.0.0-rc.1.20451.14 43 09/25/2022
5.0.0-preview.8.20407.11 11 09/26/2022
5.0.0-preview.7.20364.11 9 09/25/2022
5.0.0-preview.6.20305.6 13 09/24/2022
5.0.0-preview.5.20278.1 9 09/14/2023
5.0.0-preview.4.20251.6 21 03/12/2023
5.0.0-preview.3.20215.2 11 09/24/2022
5.0.0-preview.2.20160.3 16 09/25/2022
5.0.0-preview.1.20120.4 10 09/23/2022
3.1.32 10 06/23/2023
3.1.31 13 05/31/2023
3.1.30 31 10/27/2022
3.1.29 9 09/23/2022
3.1.28 28 09/26/2022
3.1.27 16 09/24/2022
3.1.26 34 09/21/2022
3.1.25 18 09/22/2022
3.1.24 9 03/30/2023
3.1.23 11 06/27/2022
3.1.22 11 09/21/2022
3.1.21 23 09/26/2022
3.1.20 9 09/23/2022
3.1.19 10 12/27/2022
3.1.18 12 09/22/2022
3.1.17 7 09/07/2023
3.1.16 10 09/24/2022
3.1.15 21 07/13/2022
3.1.14 11 09/09/2023
3.1.13 9 09/23/2022
3.1.12 8 09/22/2022
3.1.11 11 09/22/2022
3.1.10 7 03/25/2023
3.1.9 16 09/24/2022
3.1.8 20 04/18/2023
3.1.7 15 06/14/2023
3.1.6 9 09/14/2023
3.1.5 12 09/22/2022
3.1.4 22 09/26/2022
3.1.3 21 01/11/2023
3.1.2 12 09/21/2022
3.1.1 7 09/24/2022
3.1.0 12 09/26/2022
3.1.0-preview3.19553.2 24 09/22/2022
3.1.0-preview2.19525.4 20 09/23/2022
3.1.0-preview1.19506.1 13 09/04/2023
3.0.3 4 07/17/2022
3.0.2 10 09/22/2022
3.0.1 36 09/26/2022
3.0.0 7 09/23/2022
3.0.0-rc1.19456.10 46 12/16/2022
3.0.0-preview9.19423.4 7 09/22/2022
3.0.0-preview8.19405.4 8 09/26/2022
3.0.0-preview7.19362.4 18 09/25/2022
3.0.0-preview6.19304.6 6 09/25/2022
3.0.0-preview5.19227.9 15 09/22/2022
3.0.0-preview4.19216.2 25 09/22/2022
3.0.0-preview3.19153.1 9 09/25/2022
3.0.0-preview.19074.2 26 09/23/2022
3.0.0-preview.18572.1 12 09/27/2022
2.2.0 12 09/23/2022
2.2.0-preview3-35497 14 09/22/2022
2.2.0-preview2-35157 9 09/26/2022
2.2.0-preview1-35029 9 09/24/2022
2.1.1 8 05/31/2023
2.1.0 32 06/27/2022
2.1.0-rc1-final 37 09/26/2022
2.1.0-preview2-final 8 01/07/2023
2.1.0-preview1-final 14 09/22/2022
2.0.2 11 09/22/2022
2.0.1 10 09/21/2022
2.0.0 23,179 06/27/2022
2.0.0-preview2-final 18 09/25/2022
2.0.0-preview1-final 13 09/24/2022
1.1.2 9 09/25/2022
1.1.1 24 12/02/2022
1.1.0 11 09/22/2022
1.1.0-preview1-final 48 09/23/2022
1.0.2 34 09/24/2022
1.0.1 6 09/22/2022
1.0.0 11 02/16/2023
1.0.0-rc2-final 14 09/24/2022