次の方法で共有

クイック スタート:Azure App Configuration を使用して .NET Framework アプリを作成する

  • [アーティクル]

.NET Framework ベースのアプリに Azure App Configuration を組み込むには、2 つの方法があります。

  • App Configuration 用の構成ビルダーを使用すると、App Configuration からのデータをアプリ設定に読み込むことができます。 アプリは、いつもと同様に ConfigurationManager を使用して構成にアクセスします。 app.config または web.config ファイルへの更新以外に、コードに変更を加える必要はありません。 このクイックスタートでは、このオプションについて説明します。
  • .NET Framework の設計により、アプリ設定はアプリケーションの再起動時にのみ更新できます。 App Configuration .NET プロバイダーは、.NET Standard ライブラリです。 アプリケーションの再起動なしで、構成の動的なキャッシュと更新がサポートされます。 動的構成が不可欠な場合にコードを変更するには、.NET Framework コンソール アプリまたは ASP.NET Web アプリで動的構成の更新を実装する方法に関するチュートリアルを参照してください。

このクイックスタートでは、例として .NET Framework コンソール アプリを使用しますが、同じ手法が ASP.NET Web Forms/MVC アプリにも適用されます。

前提条件

キーと値を追加する

App Configuration ストアに次のキーと値を追加し、[ラベル] と [コンテンツのタイプ] を既定値のままにします。 Azure portal または CLI を使用してストアにキーと値を追加する方法の詳細については、キーと値の作成に関する記事を参照してください。

キー 値
TestApp:Settings:Message Azure App Configuration からのデータ

.NET Framework コンソール アプリを作成する

  1. Visual Studio を開始し、 [新しいプロジェクトの作成] を選択します。

  2. [新しいプロジェクトの作成] で、 [コンソール] プロジェクトの種類でフィルターを掛け、プロジェクト テンプレート リストから [コンソール アプリ (.NET Framework)] と C# を選びます。 [次へ] を押します。

  3. [新しいプロジェクトの構成] で、プロジェクト名を入力します。 [フレームワーク] で、 .NET Framework 4.7.2 以上を選択します。 [作成] をクリックします。

App Configuration ストアに接続する

Microsoft Entra ID (推奨) または接続文字列を使用して App Configuration ストアに接続します。

  1. プロジェクトを右クリックし、 [NuGet パッケージの管理] を選択します。 [参照] タブで、次の NuGet パッケージの最新の安定バージョンを検索し、プロジェクトに追加します。

    • Microsoft.Configuration.ConfigurationBuilders.AzureAppConfiguration
    • Microsoft.Configuration.ConfigurationBuilders.Environment
    • System.Configuration.ConfigurationManager

  2. プロジェクトの App.config ファイルを次のように更新します。 Microsoft Entra ID (推奨) または接続文字列を使用して App Configuration ストアに接続できます。

    DefaultAzureCredential を使用して、既定で App Configuration ストアに対する認証を行います。 手順に従って、資格情報に App Configuration データ閲覧者ロールを割り当てます。 アプリケーションを実行する前に、アクセス許可が伝わるのに十分な時間をおいてください。

    <configSections>
    <section name="configBuilders" type="System.Configuration.ConfigurationBuildersSection, System.Configuration, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" restartOnExternalChanges="false" requirePermission="false" />
</configSections>

<configBuilders>
    <builders>
        <add name="MyConfigStore" mode="Greedy" endpoint="${Endpoint}" type="Microsoft.Configuration.ConfigurationBuilders.AzureAppConfigurationBuilder, Microsoft.Configuration.ConfigurationBuilders.AzureAppConfiguration" />
        <add name="Environment" mode="Greedy" type="Microsoft.Configuration.ConfigurationBuilders.EnvironmentConfigBuilder, Microsoft.Configuration.ConfigurationBuilders.Environment" />
    </builders>
</configBuilders>

<appSettings configBuilders="Environment,MyConfigStore">
    <add key="AppName" value="Console App Demo" />
    <add key="Endpoint" value ="Set via an environment variable - for example, dev, test, staging, or production endpoint." />
</appSettings>

    App Configuration ストアのエンドポイント値は、環境変数 Endpoint から読み取られます。 appSettings セクションの configBuilders プロパティの MyConfigStore の前に、Environment 構成ビルダーも追加します。

  3. Program.cs を開き、ConfigurationManager を呼び出して App Configuration を使用するように Main メソッドを更新します。

    static void Main(string[] args)
{
    string message = System.Configuration.ConfigurationManager.AppSettings["TestApp:Settings:Message"];

    Console.WriteLine(message);
    Console.ReadKey();
}

アプリのビルドと実行

  1. 環境変数を設定します。

    Endpoint という名前の環境変数に、Azure portal でストアの [概要] にある App Configuration ストアのエンドポイントを設定します。

    Windows コマンド プロンプトを使用する場合は、次のコマンドを実行してコマンド プロンプトを再起動し、変更が反映されるようにします。

    setx Endpoint "<endpoint-of-your-app-configuration-store>"

    PowerShell を使っている場合は、次のコマンドを実行します。

    $Env:Endpoint = "<endpoint-of-your-app-configuration-store>"

    macOS または Linux を使用する場合は、次のコマンドを実行します。

    export Endpoint='<endpoint-of-your-app-configuration-store>'

  2. 変更を有効にするために、Visual Studio を再起動します。

  3. Ctrl + F5 キーを押して、アプリをビルドし、実行します。 コンソールに App Configuration の出力からのメッセージが表示されます。

リソースをクリーンアップする

この記事で作成したリソースを継続して使用しない場合は、ここで作成したリソース グループを削除して課金されないようにしてください。

重要

リソース グループを削除すると、元に戻すことができません。 リソース グループとそのすべてのリソースは完全に削除されます。 間違ったリソース グループやリソースをうっかり削除しないようにしてください。 この記事のリソースを、保持したい他のリソースを含むリソース グループ内に作成した場合は、リソース グループを削除する代わりに、各リソースをそれぞれのペインから個別に削除します。

  1. Azure portal にサインインし、 [リソース グループ] を選択します。
  2. [名前でフィルター] ボックスにリソース グループの名前を入力します。
  3. 結果一覧でリソース グループ名を選択し、概要を表示します。
  4. [リソース グループの削除] を選択します。
  5. リソース グループの削除の確認を求めるメッセージが表示されます。 確認のためにリソース グループの名前を入力し、 [削除] を選択します。

しばらくすると、リソース グループとそのすべてのリソースが削除されます。

次のステップ

このクイックスタートでは、新しい App Configuration ストアを作成して、.NET Framework コンソール アプリと共に使用しました。 .NET Framework アプリで構成設定を動的に更新できるようにする方法については、次のチュートリアルに進んでください。

.NET Framework アプリで動的な構成を有効にする

ASP.NET Web アプリで動的な構成を有効にする