Removing inherited ASP.NET Core appsettings

Question

I have the following setup in my Startup:

var builder = new ConfigurationBuilder()
    .AddJsonFile("appsettings.json", true, true);
    .AddJsonFile($"appsettings.{env.EnvironmentName}.json", true, true)

appsettings.json:

{
  "Logging": {
    "IncludeScopes": false,
    "LogLevel": {
      "Default": "Debug",
      "System": "Information",
      "Microsoft": "Information"
}

I know I can override the effective settings for a given environment by adding a matching JSON structure with different values and omitting those I want to inherit, e.g. appsettings.Development.json:

{
  "Logging": {
    "LogLevel": {
      "Default": "Warning"
}

But can I remove an entry or a section except by overriding each value property with an empty value?

-S

simone.tino · Accepted Answer · 2020-02-07 09:46:38Z

10

According to Configuration in ASP.NET Core documentation, settings are loaded from both files and if a setting is specified in both on them, than the one in the latter, i.e. appsettings.{env.EnvironmentName}.json in your setup, will override the first one.

So, if a setting is specified in the appsettings.json file and you want to remove it when running in the Development environment, you will need to explicitly set that accordingly ("", {}, etc. depending on the setting) in the appsettings.Development.json file.

However, such setup may suggest your setting should not lie in the generic appsettings.json file, but in the specific environments configuration settings file directly. This way, it might be easier to write your settings.

edited Feb 7, 2020 at 9:46

answered May 5, 2018 at 23:25

simone.tino

2,5314 gold badges34 silver badges46 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

David Gardiner Over a year ago

It's not legal to assign null (as per learn.microsoft.com/en-us/aspnet/core/fundamentals/…)

simone.tino Over a year ago

@DavidGardiner you are right. I just updated based on your feedback, thanks.

mnj Over a year ago

This answer does not really provide definitive solution. For example, if one of my config keys is a TimeSpan, and I configure some value for it in appsettings.json, how can I unset it in appsettings.Development.json? If I set it to "configKey": "", I will get an exception, because an empty string is not assignable to a TimeSpan.

Collectives™ on Stack Overflow

Removing inherited ASP.NET Core appsettings

1 Answer 1

3 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related