Azure AI Foundry への認証方法について考える（TypeScript利用）

概要

TypeScriptで開発しているバックエンドのアプリケーションから、Azure AI Foundry に接続したい。具体的には Azure AI Foundry のエージェント機能を使いたい。
そのためにはいくつかのパッケージをインストールして、Azure の認証状態を作る必要がある。その方法について考える。
※筆者はAzure初心者です

必要なパッケージ

まず、こちらが Azure AI Foundry のプレイグラウンドで表示されるサンプルコード。一部を抜粋。

import { AIProjectsClient } from "@azure/ai-projects";
import { DefaultAzureCredential } from "@azure/identity";

const client = AIProjectsClient.fromConnectionString(
  "ここに接続文字列",
  new DefaultAzureCredential()
);

@azure/ai-projects と @azure/identity の2つのパッケージが必要そう。

DefaultAzureCredential とは何か

認証に使っている DefaultAzureCredential とは何なのか。必須な引数は無し。

以下のドキュメントによると、裏側で9通りの認証が実行される。

https://learn.microsoft.com/en-us/dotnet/api/azure.identity.defaultazurecredential?view=azure-dotnet

9通りの認証が上から順に行われ、1つもパスしなければ、認証失敗エラーとなる模様。

キー認証は使えないっぽい

自分たちのアプリケーションでは、今までキーによる認証を行っていた。以下のような感じ。

import {
    AzureKeyCredential,
    SearchClient,
} from '@azure/search-documents';
import env from 'env';

export const searchClient = new SearchClient(
    "ここにエンドポイントURL",
    "ここにインデックス名",
    new AzureKeyCredential(env.AZURE_API_KEY),
);

しかし、今回利用する @azure/ai-projects パッケージでは、この AzureKeyCredential を使った認証に対応していない。

どの認証方法を使うべきか

それでは、9通りの認証方法のうち、どれを使うべきか。

以下、ChatGPTに要約してもらったもの。

どの認証方法が良いのか

以下の3つの認証方法がいいかなと思った。

EnvironmentCredential（ローカル環境、CI/CD環境）、AzureCliCredential（ローカル環境）、ManagedIdentityCredential（本番環境）

本番環境を Azure 以外でホスティングしているなら、本番環境の認証はまた別のものになるかも。