DotNetCore.Configuration.Formatter 6.1.1

DotNetCore Configuration Templates

DotNetCore.Configuration.Formatter is a simple Configuration ASP.NET Core Templates for Microsoft.Extensions.Configuration. It is used Configuration Providers for generating configuration value text output by substituting Configuration Key with its Value.

Annotations '{...}' in the template refer to elements of the configuration data structure. It allows to application configuration values to be resloved and formatted with using key values of other configuration sections and providers.

Nuget.org

• Nuget package DotNetCore.Configuration.Formatter

Version: 6.1.x

.Net Core App support

• Supports: net 6.0, net 5.0, netcoreapp 3.1
• Azure Function Support
  • ResolveKeyValue
  • ResolveAllKeyValues
  • AllConfigurationKeys

Version: 5.0.0

.Net Core App support

• Supports: net 5.0

Annotation format syntax

Azure Key Vault Integration

Can be used in conjunction with DotNetCore Azure Configuration KeyVault Secrets. Can be used in conjunction with DotNetCore Azure Configuration KeyVault Certificates

How to use

For example you have the following:

Environment Variables set to :

DOTNET_RUNNING_IN_CONTAINER=true
...
host_environmet=datacenter

Secret KeyValaut Configuration Provider loads the following secrets:

DotNetCore.Azure.Configuration.KvSecrets

"secret:BusConnection":"... azure bus endpoint ... ... "
"secret:DbConnection":"... sql connection string ... ... "
"secret:CosmosDbConnection":"... mongo db connection string ... ... "

Web Service has the following appsettings.json:

{
  ApplicationConfiguration:{
     "IsDocker": "{DOTNET_RUNNING_IN_CONTAINER??false}",
     "RunLocation":"{host_environmet??local}"
     "BusConnection":"{secret:BusConnection}"
     "DbConnection":"{secret:DbConnection}",
     "CosmosDbConnection":"{secret:CosmosDbConnection}"
  }
}

Web Service has the ApplicationConfiguration.cs

public class ApplicationConfiguration 
{
     public bool IsDocker {get; set;}
     public string RunLocation {get; set;}
     public string BusConnection {get; set;}
     public string DbConnection {get; set;}
     public string CosmosDbConnection {get; set;}
}

Web Service has the Startup.cs

     var applicationConfig = Configuration.UseFormater()
     .GetSection(nameof(ApplicationConfiguration))
     .Get<ApplicationConfiguration>();

or with shorthand

     var applicationConfig = Configuration.GetTypeNameFormatted<ApplicationConfiguration>();

The Web Service will be provided with filly resolved configuration with Azure Key Vault secrets.

Azure Function Support

Some software used a dynamic IConfiguration in the code. In this case "DotNetCore Configuration Templates" doesn't work. For example it is Azure Functions. There added a special feature ResolveKeyValue.

    var configuration = ... // Get IConfiguration
    var keyToResolve = "MyConfigurationKey".
    var isUpdated = configuration.ResolveKeyValue(keyToResolve);

Resolve all keys in a configuration.

    var configuration = ... // Get IConfiguration
    var isUpdated = configuration.ResolveAllKeyValues();

Dot Net Core

Example for a string formatting:

 var keyValues = new Dictionary<string, string>()
 {
     ["Key-1"] = "Value-1",
     ["Key-Value-1"] = "Complex-Value-1"
 };
 var format = "Get the {Key-1} and complex: {Key-{Key-1}} and {none??Default} and {NotFound}";
 var formatted = format.FormatString(keyValues);

Formated string will be 
    "Get the Value-1 and complex: Complex-Value-1 and Default {NotFound}"