チュートリアル: .NET バックグラウンドサービスで動的な構成を使用する

[アーティクル]
03/18/2024

App Configuration からのデータは、.NET アプリケーションでアプリ設定として読み込むことができます。詳細については、クイックスタートをご覧ください。ただし、.NET の設計により、アプリ設定はアプリケーションの再起動時にのみ更新できます。 App Configuration .NET プロバイダーは、.NET Standard ライブラリです。アプリケーションの再起動なしで、構成の動的なキャッシュと更新がサポートされます。このチュートリアルでは、.NET バックグラウンドサービスに、動的構成の更新を実装する方法について説明します。

このチュートリアルでは、次の作業を行う方法について説明します。

App Configuration ストアへの変更に合わせて構成を更新するように .NET バックグラウンドサービスを設定する。
最新の構成をバックグラウンドサービスに取り込む。

前提条件

アクティブなサブスクリプションが含まれる Azure アカウント。無料で作成できます。
App Configuration ストア。ストアを作成する。
.NET SDK 6.0 以降 - Azure Cloud Shell でも利用できます。

キーと値を追加する

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

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

.NET バックグラウンドサービスを作成する

.NET コマンドラインインターフェイス (CLI) を使用して、新しい .NET アプリプロジェクトを作成します。 Visual Studio ではなく .NET CLI を使用する利点は、Windows、macOS、および Linux プラットフォームで使用できることです。代わりに、Azure Cloud Shell で提供されているプレインストールのツールを使用します。

プロジェクト用の新規フォルダーを作成します。
新しいフォルダーで次のコマンドを実行して、新しい .NET バックグラウンドサービスプロジェクトを作成します。
```
dotnet new worker
```

App Configuration からデータを再度読み込む

次のコマンドを実行して、Microsoft.Extensions.Configuration.AzureAppConfiguration NuGet パッケージへの参照を追加します。
```
dotnet add package Microsoft.Extensions.Configuration.AzureAppConfiguration
```
次のコマンドを実行して、プロジェクトのパッケージを復元します。
```
dotnet restore
```

Program.cs を開き、次のステートメントを追加します。

using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Configuration.AzureAppConfiguration;

App Configuration に接続します。
```
// Existing code in Program.cs
// ... ...

var builder = Host.CreateApplicationBuilder(args);

builder.Configuration.AddAzureAppConfiguration(options =>
{
    options.Connect(Environment.GetEnvironmentVariable("ConnectionString"))
        // Load all keys that start with `TestApp:`.
        .Select("TestApp:*")
        // Configure to reload the key 'TestApp:Settings:Message' if it is modified.
        .ConfigureRefresh(refreshOptions =>
        {
            refreshOptions.Register("TestApp:Settings:Message");
        });

    // Register the refresher so that the Worker service can consume it through DI
    builder.Services.AddSingleton(options.GetRefresher());
});

// The rest of existing code in Program.cs
// ... ...
```
ConfigureRefresh メソッドでは、変更の監視のために App Configuration ストア内のキーが登録されます。 Register メソッドには、登録済みのキーが変更された場合にすべての構成値を更新するかどうかを示すために使用できる、省略可能なブール型パラメーター refreshAll があります。この例では、キー TestApp:Settings:Message のみが更新されます。更新のために登録されたすべての設定には、新しい更新が試行されるまでのキャッシュの有効期間として 30 秒の既定値があります。これは AzureAppConfigurationRefreshOptions.SetCacheExpiration メソッドを呼び出すことで更新できます。
Worker.cs を開きます。 IConfiguration と IConfigurationRefresher を Worker サービスに挿入し、App Configuration から構成データをログに記録します。
```
public class Worker : BackgroundService
{
    private readonly ILogger<Worker> _logger;
    private readonly IConfiguration _configuration;
    private readonly IConfigurationRefresher _refresher;

    public Worker(ILogger<Worker> logger, IConfiguration configuration, IConfigurationRefresher refresher)
    {
        _logger = logger ?? throw new ArgumentNullException(nameof(logger));
        _configuration = configuration ?? throw new ArgumentNullException(nameof(configuration));
        _refresher = refresher ?? throw new ArgumentNullException(nameof(refresher));
    }

    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        while (!stoppingToken.IsCancellationRequested)
        {
            // Intentionally not await TryRefreshAsync to avoid blocking the execution.
            _refresher.TryRefreshAsync(stoppingToken);

            if (_logger.IsEnabled(LogLevel.Information))
            {
                _logger.LogInformation(_configuration["TestApp:Settings:Message"] ?? "No data.");
            }

            await Task.Delay(TimeSpan.FromSeconds(30), stoppingToken);
        }
    }
}
```
ConfigureRefresh メソッドを単独で呼び出しても、構成は自動的に更新されません。インターフェイス IConfigurationRefresher から TryRefreshAsync メソッドを呼び出して、更新をトリガーします。この設計は、アプリケーションがアイドル状態の場合でも App Configuration に要求が送信されるのを回避することを目的としています。アプリケーションがアクティブであるとみなす場所に TryRefreshAsync 呼び出しを含めることができます。たとえば、受信メッセージ、注文、複雑なタスクの反復を処理するときなどです。また、アプリケーションが常にアクティブである場合は、タイマー内に含めることができます。この例では、バックグラウンドサービスが実行されるたびに TryRefreshAsync を呼び出します。何らかの理由で呼び出し TryRefreshAsync が失敗した場合でも、アプリケーションではキャッシュされた構成が引き続き使用されます。構成されたキャッシュの有効期限が切れて、TryRefreshAsync 呼び出しがアプリケーションアクティビティによって再度トリガーされると、もう 1 回試行されます。 TryRefreshAsync の呼び出しは、構成されたキャッシュの有効期限が過ぎる前には操作を実行しないので、頻繁に呼び出された場合でも、パフォーマンスへの影響は最小限になります。

アプリをビルドしてローカルで実行する

ConnectionString という名前の環境変数に、App Configuration ストアへのアクセスキーを設定します。コマンドラインで次のコマンドを実行します。
Windows コマンドプロンプトを使用してアプリをローカルでビルドして実行するには、次のコマンドを実行します。
```
setx ConnectionString "connection-string-of-your-app-configuration-store"
```
変更を有効にするために、コマンドプロンプトを再起動します。環境変数の値を出力して、正しく設定されていることを確認します。
Windows PowerShell を使用する場合、次のコマンドを実行します。
```
$Env:ConnectionString = "connection-string-of-your-app-configuration-store"
```
macOS を使用する場合は、次のコマンドを実行します。
```
export ConnectionString='connection-string-of-your-app-configuration-store'
```
Linux を使用する場合は、次のコマンドを実行します。
```
export ConnectionString='connection-string-of-your-app-configuration-store'
```
次のコマンドを実行して、アプリをビルドします。
```
dotnet build
```
ビルドが正常に完了したら、次のコマンドを実行して、アプリをローカルで実行します。
```
dotnet run
```
コンソールに以下の出力が表示されます。
Azure portal で、App Configuration ストアの [構成エクスプローラー] に移動し、次のキーの値を更新します。

キー値

TestApp:Settings:Message Azure App Configuration からのデータ - 更新済み
更新間隔の時間枠が経過するまでしばらく待ちます。変更されたコンソール出力が表示されます。

キー	値
TestApp:Settings:Message	Azure App Configuration からのデータ - 更新済み

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

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

重要

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

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

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

次のステップ

このチュートリアルでは、App Configuration から動的に構成設定を更新できるように .NET バックグラウンドサービスを設定しました。 ASP.NET Web アプリケーションで動的構成を有効にする方法については、次のチュートリアルに進んでください。

ASP.NET Web アプリケーションで動的構成を有効にする

App Configuration へのアクセスを効率化する Azure マネージド ID を使用する方法については、次のチュートリアルに進んでください。

マネージド ID の統合

次の方法で共有

チュートリアル: .NET バックグラウンドサービスで動的な構成を使用する

前提条件

キーと値を追加する

.NET バックグラウンドサービスを作成する

App Configuration からデータを再度読み込む

アプリをビルドしてローカルで実行する

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

次のステップ

フィードバック

その他のリソース

次の方法で共有

チュートリアル: .NET バックグラウンド サービスで動的な構成を使用する

前提条件

キーと値を追加する

.NET バックグラウンド サービスを作成する

App Configuration からデータを再度読み込む

アプリをビルドしてローカルで実行する

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

次のステップ

フィードバック

その他のリソース

チュートリアル: .NET バックグラウンドサービスで動的な構成を使用する

.NET バックグラウンドサービスを作成する