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

2025-04-22

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:メッセージ	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;

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

Microsoft Entra ID (推奨)
接続文字列

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

// Existing code in Program.cs
// ... ...

var builder = Host.CreateApplicationBuilder(args);

builder.Configuration.AddAzureAppConfiguration(options =>
{
    string endpoint = Environment.GetEnvironmentVariable("Endpoint"); 
    options.Connect(new Uri(endpoint), new DefaultAzureCredential());
        // Load all keys that start with `TestApp:` and have no label.
        .Select("TestApp:*")
        // Reload configuration if any selected key-values have changed.
        .ConfigureRefresh(refreshOptions =>
        {
            refreshOptions.RegisterAll();
        });

    // 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
// ... ...

// 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:` and have no label.
        .Select("TestApp:*")
        // Reload configuration if any selected key-values have changed.
        .ConfigureRefresh(refreshOptions =>
        {
            refreshOptions.RegisterAll();
        });

    // 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 メソッド内では、RegisterAll メソッドを呼び出して、選択したキー値 (TestApp で始まりラベルのない値) の変更が検出されるたびに、構成全体を再読み込みするように App Configuration プロバイダーに指示します。構成の変更の監視の詳細については、「構成の更新のベストプラクティス」を参照してください。

ヒント

refreshOptions.SetRefreshInterval メソッドの呼び出しを追加して、構成の更新間隔の最小時間を指定できます。今回の例では既定の値である 30 秒を使用します。 App Configuration ストアに対する要求の数を減らす必要がある場合は、より大きな値に調整します。

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 メソッドを単独で呼び出しても、構成は自動的に更新されません。インターフェイス TryRefreshAsync から IConfigurationRefresher メソッドを呼び出して、更新をトリガーします。この設計は、アプリケーションがアイドル状態の場合でも App Configuration に要求が送信されるのを回避することを目的としています。アプリケーションがアクティブであるとみなす場所に TryRefreshAsync 呼び出しを含めることができます。たとえば、受信メッセージ、注文、複雑なタスクの反復を処理するときなどです。また、アプリケーションが常にアクティブである場合は、タイマー内に含めることができます。この例では、バックグラウンドサービスが実行されるたびに TryRefreshAsync を呼び出します。何らかの理由で呼び出し TryRefreshAsync が失敗した場合でも、アプリケーションではキャッシュされた構成が引き続き使用されます。構成された更新間隔が経過し、 TryRefreshAsync 呼び出しがアプリケーションアクティビティによって再度トリガーされたときに、もう 1 回試行されます。 TryRefreshAsyncの呼び出しは、構成された更新間隔が経過する前の no-op であるため、頻繁に呼び出される場合でも、パフォーマンスへの影響は最小限です。

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

環境変数を設定します。
- Microsoft Entra ID (推奨)
- 接続文字列
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>'
```
ConnectionString という名前の環境変数に、Azure portal でストアの [アクセスキー] にある App Configuration ストアの読み取り専用接続文字列を設定します。

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

キー値

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

キー	値
TestApp:Settings:メッセージ	Azure App Configuration からのデータ - 更新済み

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

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

重要

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

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

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

次のステップ

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

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

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

マネージド ID の統合

次の方法で共有

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