@azure/identity package

errorsの資格情報からの認証エラーに対する認証エラーの AuthenticationError インスタンスを含む 配列を提供します。

Azure Active Directoryでの認証失敗についての詳細を提供します。 errorResponse フィールドには、特定のエラーに関する詳細が含まれています。

トークンをサイレントで取得しようとした後に認証を強制するために使用されるエラー。

Microsoft Entra IDのドキュメントで詳細に説明されている認可コードフローを通じて取得した認証コードを使用して、Microsoft Entra IDへの認証を可能にします。

https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow

この認証情報は、現在ログイン中のユーザーログイン情報をAzure CLI('az')コマンドラインツール経由で使用します。 そのためには、Azure CLIコマンド「az account get-access-token」でユーザーアクセストークンと有効期限を読み取ります。

Azure Developer CLIは、開発者がAzure上でリソースを作成、管理、デプロイできるコマンドラインインターフェースツールです。 Azure CLIの上に構築されており、Azure開発者向けの追加機能を提供します。 ユーザーはユーザーおよび/またはサービスプリンシパルとして認証できます。Microsoft Entra IDに対して。 AzureDeveloperCliCredentialは開発環境で認証し、Azure Developer CLIでログインしたユーザーまたはサービスプリンシパルを代表してトークンを取得します。 これはAzure Developer CLIのユーザーまたはサービスプリンシパルとして機能し、その下にAzure CLIコマンドを実行してアプリケーションをMicrosoft Entra IDに対して認証します。

AzureDeveloperCliCredential の構成

この認証情報を使用するには、開発者は以下のコマンドのいずれかを使ってローカルでAzure Developer CLIで認証する必要があります:

1. Azure Developer CLIで「azd auth login」を実行して、ユーザーとしてインタラクティブに認証してください。
2. "azd auth login --client-id clientID --client-secret clientSecret --tenant-id tenantID" を実行して、サービス プリンシパルとして認証します。

組織の更新トークンの有効性によっては、一定期間後にこのプロセスを繰り返す必要がある場合があります。 一般に、更新トークンの有効期間は数週間から数か月です。 AzureDeveloperCliCredential では、もう一度サインインするように求められます。

この資格は、Azure Pipelinesでサービス接続と共にワークロードアイデンティティフェデレーションのセットアップとして使用されるように設計されています。

この認証情報は、Azure PowerShellモジュールの現在ログインしているユーザー情報を使用します。 そのためには、コマンドGet-AzAccessToken -ResourceUrl {ResourceScope}でユーザーアクセストークンと有効期限を読み込みAzure PowerShell

getToken メソッドのいずれかがアクセス トークンを返すまで、複数の TokenCredential 実装を順番に試行できるようにします。 詳細については、「ChainedTokenCredential の概要を参照してください。

JWT アサーションを使用してサービス プリンシパルを認証します。

PEMでエンコードされた証明書を用いてMicrosoft Entra IDへの認証を可能にし、アプリ登録に割り当てられます。 証明書認証を構成する方法の詳細については、以下を参照してください。

https://learn.microsoft.com/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-azure-ad

App Registration用に生成されたクライアントシークレットを使ってMicrosoft Entra IDへの認証を可能にします。 クライアント シークレットを構成する方法の詳細については、以下を参照してください。

https://learn.microsoft.com/entra/identity-platform/quickstart-configure-app-access-web-apis#add-credentials-to-your-web-application

これは、チェーンされた資格情報で試行された資格情報を資格情報として使用できなかったことを示します。 チェーンを停止する必要があるエラーとしてこれを扱うのではなく、チェーンがキャッチされ、チェーンが続行されます

クライアントライブラリを使用するほとんどのアプリケーションで動作するデフォルトのChainedTokenCredential構成Azure SDKを提供します。 詳細については、「DefaultAzureCredential の概要」を参照してください。

次の資格情報の種類が順番に試行されます。

• 環境資格情報
• WorkloadIdentityCredential
• ManagedIdentityCredential
• VisualStudioCodeCredential
• AzureCliCredential (英語)
• AzurePowerShell資格情報
• AzureDeveloperCliCredential
• BrokerCredential ( @azure/identity-broker がインストールされている必要があるブローカー対応資格情報)

認証の試行方法の詳細については、これらの資格情報の種類のドキュメントを参照してください。

次の例は、 requiredEnvVars オプションを使用して、 DefaultAzureCredential がインスタンス化される前に特定の環境変数が設定されていることを確認する方法を示しています。 指定された環境変数のいずれかが欠落しているか空の場合、エラーがスローされ、必要な構成なしでアプリケーションの実行を続行できなくなります。 また、 AZURE_TOKEN_CREDENTIALS 環境変数を設定して、チェーンに含める資格情報を制御する方法も示します。

import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential({
  requiredEnvVars: [
    "AZURE_CLIENT_ID",
    "AZURE_TENANT_ID",
    "AZURE_CLIENT_SECRET",
    "AZURE_TOKEN_CREDENTIALS",
  ],
});

ユーザーがhttps://microsoft.com/deviceloginに入力できるデバイスコードを使って認証Microsoft Entra IDを可能にします。

クライアントシークレットまたは証明書を使ってMicrosoft Entra IDへの認証を可能にします。

インタラクティブなログインフローを用いて、ウェブブラウザ内でMicrosoft Entra IDへの認証を可能にします。

デプロイ環境で使用可能なマネージド ID を使用して認証を試みます。 この認証タイプはAzure VM、App Serviceインスタンス、Azure Functionsアプリケーション、Azure Kubernetes Services、Azure Service Fabricインスタンス、そしてAzure Cloud Shell内部で動作します。

マネージド ID の構成の詳細については、次を参照してください:https://learn.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview

On Behalf Of flowを使って認証Microsoft Entra IDを可能にします。

ユーザーのユーザー名とパスワードでMicrosoft Entra IDへの認証を可能にします。 この資格情報には高度な信頼が必要であるため、他のセキュリティで保護された資格情報の種類を使用できない場合にのみ使用する必要があります。

Visual Studio CodeのAzure Resources拡張機能からサインインしたユーザーアカウントでAzureに接続します。 ユーザーが拡張機能を使用してログインすると、この資格情報は拡張機能によってキャッシュされたのと同じ更新トークンを共有できます。

ワークロード識別認証は、Azureの機能で、仮想マシン(VM)上で動作するアプリケーションがサービスプリンシパルやマネージドIDを必要とせずに他のAzureリソースにアクセスできるようにします。 ワークロード ID 認証では、アプリケーションは、共有サービス プリンシパルまたはマネージド ID を使用するのではなく、独自の ID を使用して自身を認証します。 その内部では、ワークロードID認証はサービスアカウント認証(SAC)という概念を利用しており、これはAzureによって自動的に作成され、VMに安全に保存されます。 ワークロード ID 認証を使用すると、各 VM 上の各アプリケーションのサービス プリンシパルまたはマネージド ID を管理およびローテーションする必要がなくなります。 さらに、SACは自動的に作成されAzureによって管理されるため、機密資格情報自体の保存や保護を心配する必要はありません。 WorkloadIdentityCredentialはAzure Kubernetes上でMicrosoft Entra ワークロード ID 認証をサポートし、Azure Kubernetes環境で利用可能なSACを使ってトークンを取得します。 詳細はMicrosoft Entra ワークロード ID を参照してください。

有効期限のあるアクセス トークンを表します。

キャッシュ内のキャッシュされたトークンを検索するために使用するレコード。

AuthenticationRequiredError の省略可能なパラメーター

認証要求時にアイデンティティライブラリがどのように権威検証を行うかを設定するオプションMicrosoft Entra ID。

AuthorizationCodeCredential のオプション

AzureCliCredential のオプション

AzureDeveloperCliCredential のオプション

AzurePipelinesCredential クラスの省略可能なパラメーター。

AzurePowerShellCredential のオプション

WAM Broker 認証をサポートするための InteractiveBrowserCredential の構成オプション。

WAM ブローカー認証が無効になっている場合のパラメーター。

WAM ブローカー認証が有効な場合のパラメーター。

ブラウザーのカスタマイズ用の共有構成オプション

ClientAssertionCredential のオプション

ClientCertificateCredential クラスの省略可能なパラメーター。

PEM 証明書の文字列内容を含む、ClientCertificateCredentialに必要な構成オプション

PEM 証明書へのパスを含む、ClientCertificateCredentialに必要な構成オプション。

ClientSecretCredential クラスの省略可能なパラメーター。

永続的なトークン キャッシュをサポートする資格情報の共有構成オプション。

DefaultAzureCredential クラス 構成するためのオプションを提供します。 このバリエーションでは、両方の 1 つだけがサポートされているため、managedIdentityClientIdではなく、managedIdentityResourceId がサポートされます。

DefaultAzureCredential クラス 構成するためのオプションを提供します。

DefaultAzureCredential クラス 構成するためのオプションを提供します。 このバリエーションでは、両方の 1 つだけがサポートされているため、managedIdentityResourceIdではなく、managedIdentityClientId がサポートされます。

Node.jsの InteractiveBrowserCredential クラスのオプションを定義します。

コードを入力する必要があるユーザー コードと検証 URI を提供します。 また、これらの詳細を含む命令を含むユーザーに表示するメッセージも提供します。

利用可能な環境変数に応じてMicrosoft Entra IDへの認証を可能にします。 EnvironmentCredential クラスのオプションを定義します。

詳細については、公式ドキュメントを参照してください。

https://learn.microsoft.com/azure/active-directory/develop/v1-protocols-oauth-code#error-response-1

注: このドキュメントは v1 OAuth サポート用ですが、同じエラー応答の詳細が v2 にも引き続き適用されます。

トークン プロバイダーを構成するためのオプション。

TokenCredential.getToken のオプションを定義します。

InteractiveBrowserCredential クラスの共通オプションを定義します。

InteractiveBrowserCredential クラスの共通オプションを定義します。

ユーザーの操作を必要とする ID 資格情報の一般的なコンストラクター オプション。

ManagedIdentityCredential コンストラクターで送信するオプション。 このバリエーションでは、両方の 1 つだけがサポートされているため、clientIdではなく、resourceId がサポートされます。

ManagedIdentityCredential コンストラクターで送信するオプション。 このバリエーションでは、コンストラクター引数として objectId がサポートされています。

ManagedIdentityCredential コンストラクターで送信するオプション。 このバリエーションでは、両方の 1 つだけがサポートされているため、resourceIdではなく、clientId がサポートされます。

追加で許可されるテナントを許可するマルチテナント アプリケーションのオプション。

OnBehalfOfCredential をアサーションで認証するためのパラメーターを定義します。

証明書を使用して OnBehalfOfCredential を認証するパラメーターを定義します。

OnBehalfOfCredential をシークレットで認証するためのパラメーターを定義します。

ID 資格情報でトークン キャッシュの永続化を有効にするパラメーター。

認証トークンを提供できる資格情報を表します。

IdentityライブラリがMicrosoft Entra IDに認証要求を行う方法を設定するオプションを提供します。

UsernamePasswordCredential クラスのオプションを定義します。

Visual Studio Codeの認証情報を設定するオプションを提供します。

WorkloadIdentityCredential のオプション

InteractiveBrowserCredential で WAM ブローカー認証を有効にするパラメーター。

(ブラウザーのみの機能)認証フローで使用する "ログイン スタイル" :

• "リダイレクト" は、認証ページにユーザーをリダイレクトし、認証が完了するとページにリダイレクトします。
• "popup" は、リダイレクト フローが開始されると、新しいブラウザー ウィンドウを開きます。 ユーザーの既存のブラウザー ウィンドウが現在のページから離れない

ClientCertificateCredentialに必要な構成オプション。PEM 証明書の文字列の内容、または PEM 証明書へのパスを指定します。

DefaultAzureCredential クラスで一般的にサポートされている環境変数。

ユーザーに認証の詳細を表示するために DeviceCodeCredential に渡されるコールバックの署名を定義します。

Azure Identityプラグインのタイプで、プラグインコンテキストを受け入れる関数です。

OnBehalfOfCredential クラスの省略可能なパラメーター。

既知のAzureオーソリティホストの一覧

以前にシリアル化された認証レコードを文字列からオブジェクトに逆シリアル化します。

入力文字列には、次のプロパティが含まれている必要があります。

• 「権威」
• "ホームアカウントID"
• "clientId" (クライアント・イド)
• "テナントID"
• 「ユーザー名」
• "バージョン"

受信したバージョンがサポートされていない場合は、エラーがスローされます。

現時点では、使用可能なバージョンは "1.0" のみです。これは、認証レコードがシリアル化されるときに常に設定されます。

ベアラー トークンを提供するコールバックを返します。 たとえば、ベアラー トークンを使用して、次のように要求を認証できます。

import { DefaultAzureCredential, getBearerTokenProvider } from "@azure/identity";
import { createPipelineRequest } from "@azure/core-rest-pipeline";

const credential = new DefaultAzureCredential();
const scope = "https://cognitiveservices.azure.com/.default";
const getAccessToken = getBearerTokenProvider(credential, scope);
const token = await getAccessToken();

// usage
const request = createPipelineRequest({ url: "https://example.com" });
request.headers.set("Authorization", `Bearer ${token}`);

DefaultAzureCredentialの新しいインスタンスを返します。

AuthenticationRecord を文字列にシリアル化します。

シリアル化された認証レコードの出力には、次のプロパティが含まれます。

• 「権威」
• "ホームアカウントID"
• "clientId" (クライアント・イド)
• "テナントID"
• 「ユーザー名」
• "バージョン"

後でこの文字列をシリアル化された AuthenticationRecordに変換するには、エクスポートされた関数 deserializeAuthenticationRecord()を使用してください。

Azure Identityに追加機能を拡張する。 次のようなプラグイン パッケージからプラグインを渡します。

• @azure/identity-cache-persistence: 永続的なトークン キャッシュを提供します
• @azure/identity-vscode: VisualStudioCodeCredential の依存関係を提供し、有効にします

例：

import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";

useIdentityPlugin(cachePersistencePlugin);
// The plugin has the capability to extend `DeviceCodeCredential` and to
// add middleware to the underlying credentials, such as persistence.
const credential = new DeviceCodeCredential({
  tokenCachePersistenceOptions: {
    enabled: true,
  },
});

AggregateAuthenticationErrorの Error.name 値

認証エラーの Error.name 値

CredentialUnavailableの Error.name 価値

アイデンティティパッケージ内のすべてのクライアントで使われるAzureLogger