Retrieving Web App connection strings using ConfigurationBuilder

Question

We are storing some of our sensitive keys and connection strings in the Connection strings section under the Web App application settings:

We retrieve configuration settings using the ConfigurationBuilder:

Configuration = new ConfigurationBuilder()
    .SetBasePath(environment.ContentRootPath)
    .AddEnvironmentVariables()
    .Build();

I would have expected AddEnvironmentVariables() to pick up these connection strings, but it doesn't. Note that this does work if you set these values as "App settings" in the Web App.

Under closer inspection (using the Kudu console) I found that the environment variables being set for these connections strings have CUSTOMCONNSTR_ prefixed to the key name:

CUSTOMCONNSTR_MongoDb:ConnectionString=...
CUSTOMCONNSTR_Logging:ConnectionString=...
CUSTOMCONNSTR_ApplicationInsights:ChronosInstrumentationKey=...

How should I now read in these connection strings using the ConfigurationBuilder?

EDIT:

I found that a handy AddEnvironmentVariables overload exists with a prefix parameter, described as:

//   prefix:
//     The prefix that environment variable names must start with. The prefix will be
//     removed from the environment variable names.

But adding .AddEnvironmentVariables("CUSTOMCONNSTR_") to the configuration builder doesn't work either!

Amor · Accepted Answer · 2017-04-25 09:10:08Z

But adding .AddEnvironmentVariables("CUSTOMCONNSTR_") to the configuration builder doesn't work either!

AddEnvironmentVariables with prefix just add a limit for environment variables which must with the specified prefix. It will not change the environment variables.

To retrieve value from connection string configuration, you could use code as following.

Configuration.GetConnectionString("MongoDb:ConnectionString");

For hierarchical structure setting, please add it to app settings instead of connection strings on Azure portal.

How should I now read in these connection strings using the ConfigurationBuilder?

As a workaround, you could re-add EnvironmentVariable and rebuild the ConfigurationBuilder after you get the connection string. Code below is for your reference.

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();
    //Add EnvironmentVariable and rebuild ConfigurationBuilder
    Environment.SetEnvironmentVariable("MongoDb:ConnectionString", Configuration.GetConnectionString("MongoDb:ConnectionString"));
    builder.AddEnvironmentVariables();
    Configuration = builder.Build();
}

David Ebbo · Accepted Answer · 2017-04-24 16:58:50Z

2

It should just work, and it does for me in my sample app: https://github.com/davidebbo-test/AspNetCoreDemo. Specifically:

MyDatabase connection string is defined here.
It is used here.
If you define MyDatabase conn string in Azure Portal, you will see the new value at runtime (go to the About page).

So start by verifying that mine works, and try to see what you may be doing differently. You should never need to make any assumptions on the CUSTOMCONNSTR_ prefix!

answered Apr 24, 2017 at 16:58

David Ebbo

43.3k8 gold badges111 silver badges122 bronze badges

2 Comments

Dave New Over a year ago

I am not storing these in the JSON file - only in the Web App settings (thus needing to retrieve them from the environment variables). I've removed AddJsonFile() from the configuration above for clarity. Where is this About page? I can indeed see the connection string in the env vars, but only with the prefixed key.

David Ebbo Over a year ago

It works in my app even without setting it in the JSON (i.e. only the Azure Connection String). There is an About link at the top when you run it.

Collectives™ on Stack Overflow

Retrieving Web App connection strings using ConfigurationBuilder

2 Answers 2

Comments

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related