ConfigurationBuilders are a feature of the full .Net Framework that were introduced in .Net 4.7.1. You can read about the concept in this blog post. While the framework for executing configuration injection now exists in .Net as of 4.7.1 with that feature, the framework does not ship with any pre-made builders in box. The goal of this project is for Microsoft to provide a basic set of Configuration Builders that should make it easy for developers to leverage this feature in their apps. They are also intended to address some of the basic dynamic/non-local configuration needs of applications as they move into a container and cloud focused environment.
The set of builders produced here are styled as "Key/Value Config Builders." The architecture of ConfigurationBuilder
in the framework is actually quite flexible and can be leveraged to handle a great number of unique situations. To keep things as easy and as broadly applicable as possible though, this project focuses on simple key/value scenarios.
For more information about Configuration Builders and the features and builders in this project in particular, please refer to the docs linked here:
Expand
mode is gone. It has been replaced by Token
mode.Utils.MapPath
- This was somewhat broken in ASP.Net scenarios previously. It should now reliably go against Server.MapPath()
in ASP.Net scenarios. It has also been updated to fall back against the directory of the config file being processed when resolving the app root in the case of a Configuration
object being created by ConfigurationManager.OpenConfiguration*
API's rather than being part of a fully-initialized runtime configuration stack.System.Text.Json
instead of Newtonsoft.Json
.Azure.Identity
by default which allows for more methods of connecting to Azure, such as User-Assigned Managed Identity, or Client Certificate-based via environment variables. Also a pair of overloads (GetCredential
and GetSecretClientOptions/GetConfigurationClientOptions
) have been added for users who need something more than DefaultAzureCredential
with default client options can provide.ConfigurationBuilder
accessing values from a ConfigurationSection
other than the one which it is currently processing could result in stack overflow.optional
attribute is obsolete => enabled
attribute which provides more versatility. (The optional
attribute is still parsed and recognized in the absence of the newer enabled
attribute, but builders should migrate to use the new attribute name when possible. Installation scripts should try to handle this automatically.)charMap
attribute to allow this character mapping to work with all KeyValueConfigBuilders and to be handled in an easily configurable manner.ConnectionStringsSectionHandler2
- A new section handler for the <connectionStrings>
section has been included in the base package. This new handler will allow updating of both the 'connectionString' attribute as well as the 'providerName' attribute. It does require the builders and source of config data to be aware of this new ability though. The default section handler for the <connectionStrings>
section has not been updated and remains as it was in previous versions, so apps wishing to take advantage of the new handler will have to wire it up in their config. More details can be found in the SectionHandlers documentation.AzureAppConfiguration
nuget package version is revved to match the rest of this suite of builders, rather than being 1 major version behind. (ie, AzureAppConfiguration:3.0
now depends on Base:3.0
rather than AzureAppConfiguration:1.0
depending on Base:2.0
)appSettings
. Read more about it here.appSettings
, these key/value configuration builders now support a lazy initialization model. Things that must happen immediately can be left in the existing Initialize(name, config)
method, or builders can leverage the new LazyInitialize(name, config)
method for things that can happen just before retrieving values. All builders in this project have been updated to be lazy whenever possible.optional
tag that some of the builders in this project employed in V1 has been moved into the base class and is now available on all key/value config builders.Expand
Token
(as of V3) mode now using the new escapeExpandedValues attribute.appSettings
and connectionStrings
if desired. Read more about this feature in the Section Handlers segment below.Information on contributing to this repo is in the Contributing Guide.
Announcing .NET 4.7.1 Tools for the Cloud
.Net Framework 4.7.1 ASP.NET and Configuration features
Modern Configuration for ASP.NET 4.7.1 with ConfigurationBuilders
Service-to-service authentication to Azure Key Vault using .NET