@azure/identity package

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

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

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

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

https://video2.skills-academy.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 では、もう一度サインインするように求められます。

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

この資格情報では、Azure PowerShell モジュールから現在ログインしているユーザー情報が使用されます。 これを行うには、Azure PowerShell コマンドを使用してユーザー アクセス トークンを読み取り、有効期限を切 Get-AzAccessToken -ResourceUrl {ResourceScope}

getToken メソッドのいずれかがアクセス トークンを返すまで、複数の TokenCredential 実装を順番に試行できるようにします。

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

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

https://video2.skills-academy.com/en-us/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-azure-ad

アプリ登録用に生成されたクライアント シークレットを使用して、Microsoft Entra ID に対する認証を有効にします。 クライアント シークレットを構成する方法の詳細については、以下を参照してください。

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

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

Azure SDK を使用するほとんどのアプリケーションで動作する必要がある既定の ChainedTokenCredential 構成を提供します。

ユーザーが https://microsoft.com/deviceloginに入力できるデバイス コードを使用して、Microsoft Entra ID への認証を有効にします。

クライアント シークレットまたは証明書を使用して、またはユーザー名とパスワードを持つユーザーとして、Microsoft Entra ID への認証を有効にします。

対話型ログイン フローを使用して、Web ブラウザー内の Microsoft Entra ID に対する認証を有効にします。

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

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

On Behalf Of フローを使用して、Microsoft Entra ID への認証を有効にします。

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

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

この資格情報は、0.9.11より新しいバージョン Azure アカウント拡張機能 使用できないこと 既知の問題です。 この問題に対する長期的な修正が進行中です。 それまでの間は、AzureCliCredentialを使用した認証を検討してください。

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

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

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

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

Id ライブラリが Microsoft Entra ID への認証要求中に機関検証を行う方法を構成するオプションを提供します。

AuthorizationCodeCredential のオプション

AzureCliCredential のオプション

AzureDeveloperCliCredential のオプション

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

AzurePowerShellCredential のオプション

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

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

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

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

ClientAssertionCredential のオプション

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

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

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

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

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

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

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

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

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

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

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

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

https://video2.skills-academy.com/en-us/azure/active-directory/develop/v1-protocols-oauth-code#error-response-1

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Visual Studio Code 資格情報を構成するためのオプションを提供します。

WorkloadIdentityCredential のオプション

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

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

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

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

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

Azure Identity プラグインの種類。プラグイン コンテキストを受け入れる関数。

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

既知の Azure 機関ホストの一覧

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

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

• "authority"
• "homeAccountId"
• "clientId"
• "tenantId"
• "username"
• "version"

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

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

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

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

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 を文字列にシリアル化します。

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

• "authority"
• "homeAccountId"
• "clientId"
• "tenantId"
• "username"
• "version"

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

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

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

例：

import { cachePersistencePlugin } from "@azure/identity-cache-persistence";

import { useIdentityPlugin, DefaultAzureCredential } from "@azure/identity";
useIdentityPlugin(cachePersistencePlugin);

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