Azure App Service に配置した ASP.NET Core アプリで、App Service 上に設定した接続文字列を GetConnectionString で取得できない?

今まで GetConnectionString メソッドで App Service に設定した接続文字列を取得できなかったことなんて無かったんですが...

先日、Qiita 上の下記投稿が目に留まった。

上記投稿内容によると、Azure App Service 上に配置した ASP.NET Core アプリ (Blazor Server) で、App Service 上で設定した接続文字列を GetConnectionString メソッドで取得できないというのだ。

自分はこれを読んで、えぇ、そんなことあるのだろうか? と非常に疑問を抱いた。というのも、自分は普段から Azure App Service 上に Blazor Server を含む各種 ASP.NET Core アプリを配置しており、App Service 上で設定した接続文字列も普通に GetConnectionString メソッドで取得できていたからだ。

ただし、確かに下記記事にあるとおり、Azure App Service 上で設定した接続文字列は環境変数として登録され、その環境変数を通して GetConnectionString メソッドで取得できるのだが、その環境変数名には、App Service 上での接続文字列設定時に選択した「種類 (Type)」に応じた "プレフィクス" が付く、という話はあるにはある。

そのように App Service 上で設定したデータベース接続文字列を含む環境変数名には上記プレフィクスが付くのに、なぜ GetConnectionString ではそのプレフィクスを気にせずに接続文字列を取得できていたのか、そういえばよく考えたこともなかった。

Azure ポータル画面から App Sevice に設定する接続文字列で、選べる「種類 (Type)」は以下の 5 つ。

- MySQL

- SQLServer

- SQLAzure

- PostgreSQL

- Custom

そこで、上記 5 種の接続文字列設定が、ちゃんと ASP.NET Core アプリから取得できるか試してみることにした。

Blazor Server アプリを書いて試してみた

動作確認用に、接続文字列と環境変数とを一覧表示する Blazor Server アプリを書いて Azure App Service 上に配置する。

@using System.Collections;

@inject IConfiguration config;

<h3>Connection Strings</h3>

<table>

    <tr><td>MySQL</td><td>@connStrM</td></tr>

    <tr><td>SQServer</td><td>@connStrS</td></tr>

    <tr><td>SQLAzure</td><td>@connStrA</td></tr>

    <tr><td>PostgreSQL</td><td>@connStrP</td></tr>

    <tr><td>Custom</td><td>@connStrC</td></tr>

</table>

<h3>Environment Variables</h3>

<table>

    @foreach (var env in envVals)

    {

        <tr><td>@env.Key</td><td>@env.Value</td></tr>

    }

</table>

@code {

    private string? connStrM;

    private string? connStrS;

    private string? connStrA;

    private string? connStrP;

    private string? connStrC;

    private DictionaryEntry[] envVals = Array.Empty<DictionaryEntry>();

    protected override void OnInitialized()

    {

        connStrM = config.GetConnectionString("connStrM");

        connStrS = config.GetConnectionString("connStrS");

        connStrA = config.GetConnectionString("connStrA");

        connStrP = config.GetConnectionString("connStrP");

        connStrC = config.GetConnectionString("connStrC");

        envVals = Environment.GetEnvironmentVariables()

            .Cast<DictionaryEntry>()

            .Where(env => env.Key?.ToString()?.Contains("connStr") == true)

            .ToArray();

    }

}

そして appSettings.json と App Service 上との双方に上記 5 種の接続文字列を設定しておく。

{

  "ConnectionStrings": {

    "connStrM": "from appSettings.json (MySQL)",

    "connStrS": "from appSettings.json (SQLServer)",

    "connStrA": "from appSettings.json (SQLAzure)",

    "connStrP": "from appSettings.json (PostgreSQL)",

    "connStrC": "from appSettings.json (Custom)"

  },

  ...

GetConnectionString で取得される接続文字列が、

• appSettings.json から読み取られたものであれば
  "from appSettings.json..." と表示され、
  　
• App Service 上の設定 (すなわち環境変数) から読み取られたものであれば
  "from App Service..." と表示される

仕掛けだ。

App Service 上で設定した接続文字列のほうが優先度が高いため、App Service 上での設定が正しく機能していれば、この Blazor Server アプリのページ表示には、App Service で設定した接続文字列がずらっと並んで表示されるはずだ。

で、実際に実行してみたところ...

なんと、App Service 上に設定した接続文字列のうち、種類 = PostgreSQL で設定したものだけが取得できていないのだ。

これで冒頭で紹介の Qiita 投稿記事にて「Azure App Service に配置した ASP.NET Core アプリで、App Service 上に設定した接続文字列を GetConnectionString で取得できない」と書かれていた点にも合点がいく。同記事では接続文字列の種類を PostgreSQL に指定していたのだ。自分は「種類 (Type)」には「SQLAzure」しか設定したことがなく、それでこれまで、GetConnectionString メソッドで接続文字列が取得できない、といった現象に悩まされずに済んできたようであった。

理由を探る

しかし一体全体どうして 種類 = PostgreSQL のときだけ接続文字列が取得できないのだろうか??

先に書いたとおりこれまで自分は頓着していなかったものの、そもそも、どうして "MYSQLCONNSTR_～" みたいなプレフィクスが環境変数名に付いているにもかかわらず、そんなことを気にせずに GetConnectionString で接続文字列が取得できていたのだろうか?

ということで、.NET における構成プロバイダーのうち、環境変数由来の構成情報を提供するプロバイダーのソースコードを確認してみた (下記リンク先)。

そうしたところ、なんと、それら App Service 上の接続文字列設定に関するプレフィクスがソースコード上にハードコードされて、これらプレフィクスが付いた環境変数を特別に処理していたのだ。これが、App Service 上での接続文字列設定が環境変数上はその「種類 (Type)」に応じたプレフィクスが付くにも関わらず、GetConnectionString メソッドでいずれのプレフィクスが付いていても接続文字列を取得できる仕掛けだった。

そして加えて、このハードコードされたプレフィクスの中に、どういうわけか、PostgreSQL 用のプレフィクスだけが入っていないのである (下記はその抜粋)。

public class EnvironmentVariablesConfigurationProvider : ConfigurationProvider

{

    private const string MySqlServerPrefix = "MYSQLCONNSTR_";

    private const string SqlAzureServerPrefix = "SQLAZURECONNSTR_";

    private const string SqlServerPrefix = "SQLCONNSTR_";

    private const string CustomConnectionStringPrefix = "CUSTOMCONNSTR_";

   

    // ⚠️ "POSTGRESQLCONNSTR_" についての項目だけ、存在しない!!

    ...

これが、「種類 (Type)」に PostgreSQL を指定した場合にのみ、GetConnectionString メソッドでその設定値を取得できない原因・理由であった。

既に3年以上前から発覚しているも修正に至らず

事情がわかった上で、改めて "EnvironmentVariablesConfigurationProvider PostgreSQL" などのキーワードでネットで検索してみると、下記 Issue を発見。

この Issue が作られたのは 2019年5月、つまりこの記事を書いている 3年よりも前に、既にこの問題は認識はされていたようだ。しかし大変残念ながら、つい先月に .NET 7 が正式リリースされた今日現在、3年以上が経過したあとでも、この不具合 (?) は解消されていない。上記 Issue を斜め読みする限り、どうも、そもそもこういうハードコードされたプレフィクス実装が好ましくないので根本的に仕組みを変更したいようなことも議論されているようだ。

あと、根本原因は前述のとおり .NET のランタイムライブラリにあるわけだが、この不具合の動作・振る舞いとしては「Azure ポータル画面で、App Service の接続文字列として、種類 = PostgreSQL で登録すると (ないしは Azure CLI で同等の設定を施したとき)、設定が取得できない」ということで、Azure CLI の GitHub リポジトリにも Issue が立てられている。

さておき、Azure App Service 上でデータベース接続文字列を設定する際に、どうして「種類 (Type)」の設定が求められるかというと、「種類 (Type)」に応じたデータベースアクセスプロバイダ名が、"～_ProviderName" のサフィックス付きのエントリに追加される仕掛けがあるためである。

例えば Azure App Service 上で、種類 = MySQL 、エントリ名 = foo、でデータベース接続文字列を設定した場合、GetConnectionString("foo") でその設定した接続文字列が返ってくることに加えて、GetConnectionString("foo_ProviderName") を実行すると "MySql.Data.MySqlClient" という文字列が返ってくるのだ。これが何の役に立つのかは本稿では割愛するが、とにかく、「種類 (Type)」の設定がどこにどう作用するのかというと、こういうことである。

回避策

ということで、とりあえずの回避策としては、たとえ接続先のデータベースが PostgreSQL であったとしても、Azure App Service でのデータベース接続文字列を設定の際は、その「種類 (Type)」として「Custom」を選んでおくのがよさそうである。そうすれば GetConnectionString メソッドでめでたく、その App Service 上に設定した接続文字列を取得できるようになる。

あるいは、冒頭で紹介した Qiita 投稿記事内で解決しているとおり、データベース接続文字列構成を使うのはあきらめて、通常のアプリケーション構成にデータベース接続文字列を設定するので良いかもしれない。Azure App Service に、通常のアプリケーション構成とは別にわざわざ "接続文字列" を設定する枠があるのは、App Service のバックアップ機能で、その接続先データベースもバックアップを取れるようにするためらしいのだが (下記リンク先参照)、もしこのバックアップ機能は使わないよ、ということであれば、通常のアプリケーション構成として PostgreSQL への接続文字列を設定しても問題ないと思われる。

以上、PostgreSQL への接続文字列を Azure App Service へ設定し、ASP.NET Core アプリ内から GetConnectionString で取得しようとする開発者各におかれては、この先躓く人が少しでも減りますようにと思わずにはいられない。