EF Core 2.0 connection string in Azure Functions .NET Core

Question

I'm using EF core 2.0 in Azure Functions using .net core. I'm trying to read db ConnectionString from local.settings.json, which is defined:

{
  "IsEncrypted": false,
  "Values": {
    "AzureWebJobsStorage": "UseDevelopmentStorage=true",
    "AzureWebJobsDashboard": "UseDevelopmentStorage=true"
  },
  "ConnectionStrings": {
    "MyDbConnStr": "Data Source=.;Initial Catalog=xxxxxxx"
  }
}

Environment.GetEnvironmentVariable() doesn't return any connection string info neither I can use ConfigurationManager.ConnectionStrings with .net core. How do I access the connection string from the code?

How are you able to load EFCore 2.X with azure functions locally? I tried and it can't load EFCore. Are you using visual studio? — DOMZE
– DOMZE, Commented Dec 18, 2017 at 20:50
@DOMZE yep, using VS 2017, version 15.5.2 with .net core 2 Functions template <PropertyGroup> <TargetFramework>netstandard2.0</TargetFramework> <AzureFunctionsVersion>v2</AzureFunctionsVersion> </PropertyGroup> <ItemGroup> <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="2.0.0" /> <PackageReference Include="Microsoft.EntityFrameworkCore.Tools" Version="2.0.0" /> <PackageReference Include="Microsoft.NET.Sdk.Functions" Version="1.0.6" /> </ItemGroup> — Boris Lipschitz
– Boris Lipschitz, Commented Dec 18, 2017 at 23:13
@DOMZE make sure you reference Sdk.Functions 1.0.6 and 2.0.0 EF. There is currently Azure Functions .NET Core bug — Boris Lipschitz
– Boris Lipschitz, Commented Dec 18, 2017 at 23:15

Mikhail Shilkov · Accepted Answer · 2017-12-14 08:40:51Z

13

You could use one of the helper classes in Microsoft.Azure.WebJobs.Host:

AmbientConnectionStringProvider.Instance.GetConnectionString("MyDbConnStr")

This class is delegating the work to internal class called ConfigurationUtility, which does something in line with

var configuration = new ConfigurationBuilder()
    .AddEnvironmentVariables()
    .AddJsonFile("appsettings.json", true)
    .Build();
var conn = configuration.GetConnectionString("MyDbConnStr");

answered Dec 14, 2017 at 8:40

Mikhail Shilkov

35.3k4 gold badges78 silver badges110 bronze badges

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

3 Comments

Boris Lipschitz Over a year ago

Wow! It works! Thanks! It's not documented anywhere. I would never have guessed it...

Smit Over a year ago

It is documented here learn.microsoft.com/en-us/aspnet/core/fundamentals/… Configuration has simple enough mechanism to load config from env/json/ini.

Jonathan Over a year ago

How do I use any other configuration variable, not a connection string. It's not working with custom parameters

Elan Hasson · Accepted Answer · 2018-02-02 04:21:55Z

9

You can use Environment.GetEnvironmentVariable. The keys are "ConnectionStrings:YourKey"

Assuming your local.settings.json looks like the following:

{
  "IsEncrypted": false,
  "Values": {
    "AzureWebJobsStorage": "UseDevelopmentStorage=true",
    "AzureWebJobsDashboard": "UseDevelopmentStorage=true"
  },
  "ConnectionStrings": {
    "sqldb_connection": "connection_string_here"
  }
}

Use Environment.GetEnvironmentVariable("ConnectionStrings:sqldb_connection", EnvironmentVariableTarget.Process); to get the value

edited Feb 2, 2018 at 4:21

Elan Hasson

1,2701 gold badge19 silver badges29 bronze badges

answered Dec 19, 2017 at 0:23

DOMZE

1,36913 silver badges27 bronze badges

1 Comment

Métoule Over a year ago

That works during local dev, but how do you set this value in the Azure portal?

Collectives™ on Stack Overflow

EF Core 2.0 connection string in Azure Functions .NET Core

2 Answers 2

3 Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related