asp.net-core Configuration Getting Started
Example
In this example we will describe what happens when you scaffold a new project.
First thing, the following dependencies will be added to you project (currently project.json file) :
"Microsoft.Extensions.Configuration.EnvironmentVariables": "1.0.0",
"Microsoft.Extensions.Configuration.Json": "1.0.0",
It will also create a constructor in your Startup.cs file which will be in charge of building the configuration using ConfigurationBuilder fluent api:
- It first creates a new
ConfigurationBuilder. - It then sets a base path which will be used to compute absolute path of further files
- It adds an optional
appsettings.jsonto the configuration builder and monitor it's changes - It adds an optional environment related
appsettings.environementName.jsonconfiguration file - It then adds environement variables.
public Startup(IHostingEnvironment env)
{
var builder = new ConfigurationBuilder()
.SetBasePath(env.ContentRootPath)
.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
.AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true)
.AddEnvironmentVariables();
Configuration = builder.Build();
}
If a same setting is set in several sources, the latest source added will win and its value will be selected.
Configuration can then be consumed using the indexer property. The colon : character serve a path delimiter.
Configuration["AzureLogger:ConnectionString"]
This will look for a configuration value ConnectionString in an AzureLogger section.
