クイック スタート: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 アプリにも適用されます。
前提条件
- アクティブなサブスクリプションが含まれる Azure アカウント。 無料で作成できます。
- App Configuration ストア。 ストアを作成する。
- Visual Studio
- .NET Framework 4.7.2 以降
キーと値を追加する
App Configuration ストアに次のキーと値を追加し、[ラベル] と [コンテンツのタイプ] を既定値のままにします。 Azure portal または CLI を使用してストアにキーと値を追加する方法の詳細については、キーと値の作成に関する記事を参照してください。
キー | 値 |
---|---|
TestApp:Settings:Message | Azure App Configuration からのデータ |
.NET Framework コンソール アプリを作成する
Visual Studio を開始し、 [新しいプロジェクトの作成] を選択します。
[新しいプロジェクトの作成] で、 [コンソール] プロジェクトの種類でフィルターを掛け、プロジェクト テンプレート リストから [コンソール アプリ (.NET Framework)] と C# を選びます。 [次へ] を押します。
[新しいプロジェクトの構成] で、プロジェクト名を入力します。 [フレームワーク] で、 .NET Framework 4.7.2 以上を選択します。 [作成] をクリックします。
App Configuration ストアに接続する
プロジェクトを右クリックし、 [NuGet パッケージの管理] を選択します。 [参照] タブで以下の NuGet パッケージを検索し、プロジェクトに追加します。
- Microsoft.Configuration.ConfigurationBuilders.AzureAppConfiguration バージョン 1.0.0 以降
- Microsoft.Configuration.ConfigurationBuilders.Environment バージョン 2.0.0 以降
- System.Configuration.ConfigurationManager バージョン 4.6.0 以降
プロジェクトの App.config ファイルを次のように更新します。
<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" connectionString="${ConnectionString}" 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="ConnectionString" value ="Set via an environment variable - for example, dev, test, staging, or production connection string." /> </appSettings>
App Configuration ストアの接続文字列は環境変数
ConnectionString
から読み取られます。appSettings
セクションのconfigBuilders
プロパティのMyConfigStore
の前に、Environment
構成ビルダーを追加します。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(); }
アプリのビルドと実行
ConnectionString という名前の環境変数を、App Configuration ストアの作成中に取得した読み取り専用のキー接続文字列に設定します。
Windows コマンド プロンプトを使用する場合は、次のコマンドを実行します。
setx ConnectionString "connection-string-of-your-app-configuration-store"
Windows PowerShell を使用する場合は、次のコマンドを実行します。
$Env:ConnectionString = "connection-string-of-your-app-configuration-store"
変更を有効にするために、Visual Studio を再起動します。
Ctrl + F5 キーを押して、アプリをビルドし、実行します。 コンソールに App Configuration の出力からのメッセージが表示されます。
リソースをクリーンアップする
この記事で作成したリソースを継続して使用しない場合は、ここで作成したリソース グループを削除して課金されないようにしてください。
重要
リソース グループを削除すると、元に戻すことができません。 リソース グループとそのすべてのリソースは完全に削除されます。 間違ったリソース グループやリソースをうっかり削除しないようにしてください。 この記事のリソースを、保持したい他のリソースを含むリソース グループ内に作成した場合は、リソース グループを削除する代わりに、各リソースをそれぞれのペインから個別に削除します。
- Azure portal にサインインし、 [リソース グループ] を選択します。
- [名前でフィルター] ボックスにリソース グループの名前を入力します。
- 結果一覧でリソース グループ名を選択し、概要を表示します。
- [リソース グループの削除] を選択します。
- リソース グループの削除の確認を求めるメッセージが表示されます。 確認のためにリソース グループの名前を入力し、 [削除] を選択します。
しばらくすると、リソース グループとそのすべてのリソースが削除されます。
次のステップ
このクイックスタートでは、新しい App Configuration ストアを作成して、.NET Framework コンソール アプリと共に使用しました。 .NET Framework アプリで構成設定を動的に更新できるようにする方法については、次のチュートリアルに進んでください。