DotNetCore.Configuration.Formatter
6.0.2
See the version list below for details.
Install-Package DotNetCore.Configuration.Formatter -Version 6.0.2
dotnet add package DotNetCore.Configuration.Formatter --version 6.0.2
<PackageReference Include="DotNetCore.Configuration.Formatter" Version="6.0.2" />
paket add DotNetCore.Configuration.Formatter --version 6.0.2
#r "nuget: DotNetCore.Configuration.Formatter, 6.0.2"
// Install DotNetCore.Configuration.Formatter as a Cake Addin
#addin nuget:?package=DotNetCore.Configuration.Formatter&version=6.0.2
// Install DotNetCore.Configuration.Formatter as a Cake Tool
#tool nuget:?package=DotNetCore.Configuration.Formatter&version=6.0.2
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.0.x
.Net Core App support
- Supports: net 6.0, net 5.0, netcoreapp 3.1
Version: 5.0.0
.Net Core App support
- Supports: net 5.0
Annotation format syntax
Annotation | Definition |
---|---|
{ Key } | If the Key reference will be resolved; it will be replaced with a value. If {Key} is not found, it will not be replaced and recursive references substitution will be cancelled,i.e JSON frendly. |
{Key??Default} | If the Key reference will not be resolved in it will be replaced with the Default. |
{{{Key3}Key2}Key1} | Supports recursive references substitution, it will be replaced with a final constructed reference value. |
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.
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}"
Product | Versions |
---|---|
.NET | net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows |
.NET Core | netcoreapp3.1 |
-
.NETCoreApp 3.1
- No dependencies.
-
net5.0
- No dependencies.
-
net6.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Supports netcoreapp3.1;net5.0;net6.0. JSON frendly.