Microsoft.Extensions.Configuration.Abstractions 11.0.0-preview.5.26302.115

About

Provides abstractions of key-value pair based configuration. Interfaces defined in this package are implemented by classes in Microsoft.Extensions.Configuration and other configuration packages.

Key Features

• Abstractions for string key-value pair configuration sources and sections
• Path conventions of keys establishing a heirachy of values
• Support for multiple configuration sources, aggregating and defining precdence for values
• Support for reload on change

How to Use

The example below shows a small code sample using this library and trying out the ConfigurationKeyName and ConfigurationIgnore attributes:

public class MyClass
{
    [ConfigurationKeyName("named_property")]
    public string NamedProperty { get; set; }

    [ConfigurationIgnore]
    public string IgnoredProperty { get; set; } = "default";
}

Given the simple class above, we can create a dictionary to hold the configuration data and use it as the memory source to build a configuration section:

var dic = new Dictionary<string, string>
{
    {"named_property", "value for named property"},
    {"ignored_property", "this value is ignored"},
};

var config = new ConfigurationBuilder()
    .AddInMemoryCollection(dic)
    .Build();

var options = config.Get<MyClass>();
Console.WriteLine(options.NamedProperty); // returns "value for named property"
Console.WriteLine(options.IgnoredProperty); // returns "default"

Main Types

The main types provided by this library are:

• Microsoft.Extensions.Configuration.IConfiguration
• Microsoft.Extensions.Configuration.IConfigurationBuilder
• Microsoft.Extensions.Configuration.IConfigurationProvider
• Microsoft.Extensions.Configuration.IConfigurationRoot
• Microsoft.Extensions.Configuration.IConfigurationSection

Additional Documentation

• Configuration in .NET
• API documentation

Related Packages

• Microsoft.Extensions.Configuration
• Microsoft.Extensions.Configuration.Binder
• Microsoft.Extensions.Configuration.CommandLine
• Microsoft.Extensions.Configuration.EnvironmentVariables
• Microsoft.Extensions.Configuration.FileExtensions
• Microsoft.Extensions.Configuration.Ini
• Microsoft.Extensions.Configuration.Json
• Microsoft.Extensions.Configuration.UserSecrets
• Microsoft.Extensions.Configuration.Xml

Feedback & Contributing

Microsoft.Extensions.Caching.Abstractions is released as open source under the MIT license. Bug reports and contributions are welcome at the GitHub repository.