ConfigurationSubstitutor 1.0.0

Allows to substitute variables from configuration, this way hostnames, or passwords can be separated and automatically substituted if another configuration entry references them.
Scenarios could be that you have the password from an Azure KeyVault and the connection string defined in appsettings. The connection string can reference the password.
Another scenario is that you have multiple configuration entries for the same domain, don't duplicate that information anymore, reference it.

There is a newer version of this package available.
See the version list below for details.
Install-Package ConfigurationSubstitutor -Version 1.0.0
dotnet add package ConfigurationSubstitutor --version 1.0.0
<PackageReference Include="ConfigurationSubstitutor" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ConfigurationSubstitutor --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: ConfigurationSubstitutor, 1.0.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install ConfigurationSubstitutor as a Cake Addin
#addin nuget:?package=ConfigurationSubstitutor&version=1.0.0

// Install ConfigurationSubstitutor as a Cake Tool
#tool nuget:?package=ConfigurationSubstitutor&version=1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

ConfigurationSubstitutor

Allows to substitute variables from configuration, this way hostnames, or passwords can be separated and automatically substituted if another configuration entry references them.
Scenarios could be that you have the password from an Azure KeyVault and the connection string defined in appsettings. The connection string can reference the password.
Another scenario is that you have multiple configuration entries for the same domain, don't duplicate that information anymore, reference it.

Usage

ASP.NET Core

To add it to ASP.NET Core configuration simply place .EnableSubstitutions() last.
Make sure .EnableSubstitutions() is always called after all other configurations are added, else it won't behave properly!

public static IHostBuilder CreateHostBuilder(string[] args) =>
	Host.CreateDefaultBuilder(args)
		.ConfigureAppConfiguration((ctx, builder) =>
		{
			// if you have any additional configuration place it before
			builder.EnableSubstitutions();
		});

Another example where the configuration builder is created:

var configuration = new ConfigurationBuilder()
	.AddUserSecrets(typeof(GameRepositoryTests).Assembly)
	.AddJsonFile("appsettings.json")
	.EnableSubstitutions()
	.Build();

Remark: you can also specify the start/end strings that define a substitutable value.
Here we define that values are enclosed within $(), that's what is used by Azure DevOps for substitutions.

public static IHostBuilder CreateHostBuilder(string[] args) =>
	Host.CreateDefaultBuilder(args)
		.ConfigureAppConfiguration((ctx, builder) =>
		{
			// if you have any additional configuration place it before
			builder.EnableSubstitutions("$(", ")");
		});

Examples

Connection string and password

Example where the entry ConnectionString references the DatabasePassword.
The configuration contains these two entries:

  • ConnectionString = blablabla&password={DatabasePassword}&server=localhost
  • DatabasePassword = ComplicatedPassword
var substituted = configuration["ConnectionString"];

Easy-peasy substituted contains blablabla&password=ComplicatedPassword&server=localhost

More substitutions

It supports any number of substitutions, for example if the configuration contains these three entries:

  • Foo = {Bar1}{Bar2}{Bar1}
  • Bar1 = Barista
  • Bar2 = -Jean-
var substituted = configuration["Foo"];

Now substituted contains Barista-Jean-Barista

ConfigurationSubstitutor

Allows to substitute variables from configuration, this way hostnames, or passwords can be separated and automatically substituted if another configuration entry references them.
Scenarios could be that you have the password from an Azure KeyVault and the connection string defined in appsettings. The connection string can reference the password.
Another scenario is that you have multiple configuration entries for the same domain, don't duplicate that information anymore, reference it.

Usage

ASP.NET Core

To add it to ASP.NET Core configuration simply place .EnableSubstitutions() last.
Make sure .EnableSubstitutions() is always called after all other configurations are added, else it won't behave properly!

public static IHostBuilder CreateHostBuilder(string[] args) =>
	Host.CreateDefaultBuilder(args)
		.ConfigureAppConfiguration((ctx, builder) =>
		{
			// if you have any additional configuration place it before
			builder.EnableSubstitutions();
		});

Another example where the configuration builder is created:

var configuration = new ConfigurationBuilder()
	.AddUserSecrets(typeof(GameRepositoryTests).Assembly)
	.AddJsonFile("appsettings.json")
	.EnableSubstitutions()
	.Build();

Remark: you can also specify the start/end strings that define a substitutable value.
Here we define that values are enclosed within $(), that's what is used by Azure DevOps for substitutions.

public static IHostBuilder CreateHostBuilder(string[] args) =>
	Host.CreateDefaultBuilder(args)
		.ConfigureAppConfiguration((ctx, builder) =>
		{
			// if you have any additional configuration place it before
			builder.EnableSubstitutions("$(", ")");
		});

Examples

Connection string and password

Example where the entry ConnectionString references the DatabasePassword.
The configuration contains these two entries:

  • ConnectionString = blablabla&password={DatabasePassword}&server=localhost
  • DatabasePassword = ComplicatedPassword
var substituted = configuration["ConnectionString"];

Easy-peasy substituted contains blablabla&password=ComplicatedPassword&server=localhost

More substitutions

It supports any number of substitutions, for example if the configuration contains these three entries:

  • Foo = {Bar1}{Bar2}{Bar1}
  • Bar1 = Barista
  • Bar2 = -Jean-
var substituted = configuration["Foo"];

Now substituted contains Barista-Jean-Barista

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
1.1.1 11,095 1/11/2021
1.1.0 750 12/18/2020
1.0.2 11,525 8/3/2020
1.0.1 156 8/3/2020
1.0.0 294 7/23/2020