Microsoft.Extensions.Options.ConfigurationExtensions 9.0.0-preview.2.24128.5
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:
ConfigurationChangeTokenSourceOptionsBuilderConfigurationExtensionsOptionsConfigurationServiceCollectionExtensions
Additional Documentation
Related Packages
- Microsoft.Extensions.Options
- Microsoft.Extensions.Configuration
- Microsoft.Extensions.DependencyInjection
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.AspNetCore
Microsoft.AspNetCore
|
6 |
|
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.
|
6 |
|
Microsoft.Extensions.Diagnostics
This package includes the default implementation of IMeterFactory and additional extension methods to easily register it with the Dependency Injection framework.
|
6 |
|
Microsoft.Extensions.Diagnostics
This package includes the default implementation of IMeterFactory and additional extension methods to easily register it with the Dependency Injection framework.
|
9 |
|
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
|
6 |
|
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
|
7 |
|
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
|
8 |
|
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
|
10 |
|
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
|
17 |
|
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
When using NuGet 3.x this package requires at least version 3.4.
|
6 |
|
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
|
25 |
|
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.
|
8 |
|
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
|
8 |
|
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
|
28 |
https://go.microsoft.com/fwlink/?LinkID=799421
.NET Framework 4.6.2
- Microsoft.Extensions.Configuration.Abstractions (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.Primitives (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.Options (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.Configuration.Binder (>= 9.0.0-preview.2.24128.5)
.NET Standard 2.0
- Microsoft.Extensions.Primitives (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.Options (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.Configuration.Binder (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.Configuration.Abstractions (>= 9.0.0-preview.2.24128.5)
.NET 9.0
- Microsoft.Extensions.Primitives (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.Options (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.Configuration.Binder (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.Configuration.Abstractions (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 9.0.0-preview.2.24128.5)
.NET 8.0
- Microsoft.Extensions.Options (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.Configuration.Binder (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.Configuration.Abstractions (>= 9.0.0-preview.2.24128.5)
- Microsoft.Extensions.Primitives (>= 9.0.0-preview.2.24128.5)