DefaultAzureCredentialについて

2024年7月1日

少し宣伝させてください！Azureの試験対策本を執筆しました。

DefaultAzureCredentialクラスの複数の認証方法を透過的に試み、利用可能な認証情報を自動的に選択する機能について、詳しく見ていきます。DefaultAzureCredentialは、Azureサービスへの認証を簡素化するために設計された便利なクラスです。このクラスは、複数の認証方法を順番に試行し、最初に成功した方法を使用してAzureサービスへの認証を行います。

こちらの記事が非常に参考になりました。

。主な特徴は

  1. 複数の認証方法の試行：DefaultAzureCredentialは、以下のような複数の認証方法を順番に試みます：
    • 環境変数
    • マネージドアイデンティティ
    • Visual Studioの認証情報
    • Visual Studio Codeの認証情報
    • Azure CLIの認証情報
    • Azure PowerShellの認証情報
    • インタラクティブブラウザ認証
  2. 透過的な試行プロセス：開発者は、これらの認証方法を個別に実装する必要がありません。DefaultAzureCredentialが自動的に適切な方法を選択します。
  3. 環境に応じた適応：ローカル開発環境では、Visual StudioやAzure CLIの認証情報を使用し、Azure上では主にマネージドアイデンティティを使用するなど、実行環境に応じて適切な認証方法を選択します。
  4. カスタマイズ可能性：DefaultAzureCredentialOptionsを使用することで、特定の認証方法を除外したり、認証プロセスをカスタマイズしたりすることができます。

オプションのドキュメントはこちら。

例えば、以下のようにオプションを設定することで、特定の認証方法を除外できます。

この例では、環境変数、インタラクティブブラウザ、Visual Studio、Azure PowerShell、共有トークンキャッシュを介した認証方法が除外されています。これは、trueに設定されたExclude*Credentialプロパティによって指定されます。一方で、ExcludeVisualStudioCodeCredentialだけがfalseに設定されており、これはVisual Studio Codeを介した認証方法が有効であることを意味します。

1
2
3
4
5
6
7
8
9
10
11
12
// Azure認証情報を取得
var isDevelopmentEnvironment = Environment.GetEnvironmentVariable("AZURE_FUNCTIONS_ENVIRONMENT") == "Dev";
var credential = new DefaultAzureCredential(new DefaultAzureCredentialOptions
{
    ExcludeEnvironmentCredential = isDevelopmentEnvironment,
    ExcludeInteractiveBrowserCredential = isDevelopmentEnvironment,
    ExcludeVisualStudioCredential = isDevelopmentEnvironment,
    ExcludeAzurePowerShellCredential = isDevelopmentEnvironment,
    ExcludeSharedTokenCacheCredential = isDevelopmentEnvironment,
    // 開発環境ではVisual Studio Code認証を使用し、それ以外の場合は除外
    ExcludeVisualStudioCodeCredential = !isDevelopmentEnvironment
});

この設定は、特定の認証方法を意図的に選択または除外したい場合に便利です。例えば、開発中にはVisual Studio Codeの認証を利用し、他の認証方法を避けたいというシナリオが考えられます。このアプローチにより、アプリケーションの認証フローをより細かく制御し、セキュリティを強化することができます。

この機能により、開発者は認証ロジックを簡素化し、異なる環境間でのコードの移植性を高めることができます。ローカル開発環境からAzureクラウド環境まで、同じコードで一貫した認証処理を実現できるのがDefaultAzureCredentialの大きな利点です。

Azure, FunctionsAzure Functions, C#

Posted by takumioda