次の方法で共有

@azure/identity package

  • リファレンス

クラス

AggregateAuthenticationError

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

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

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

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

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

この資格情報は、Azure CLI ('az') コマンドライン ツールを使用して、現在ログインしているユーザー ログイン情報を使用します。 これを行うには、ユーザー アクセス トークンを読み取り、Azure CLI コマンド "az account get-access-token" を使用して有効期限を切ります。
AzureDeveloperCliCredential

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 では、もう一度サインインするように求められます。
AzurePipelinesCredential

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ワークロード 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 を参照してください。

インターフェイス

AccessToken

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

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

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

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

AuthorizationCodeCredential のオプション
AzureCliCredentialOptions

AzureCliCredential のオプション
AzureDeveloperCliCredentialOptions

AzureDeveloperCliCredential のオプション
AzurePipelinesCredentialOptions

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

AzurePowerShellCredential のオプション
BrokerAuthOptions

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

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

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

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

ClientAssertionCredential のオプション
ClientCertificateCredentialOptions

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

WorkloadIdentityCredential のオプション

型エイリアス

BrokerOptions

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

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

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

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

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

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

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

列挙型

AzureAuthorityHosts

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

関数

deserializeAuthenticationRecord(string)

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

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

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

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

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

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

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}`);
getDefaultAzureCredential()

DefaultAzureCredentialの新しいインスタンスを返します。
serializeAuthenticationRecord(AuthenticationRecord)

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

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

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

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

追加機能を使用して 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
  }
});

関数の詳細

deserializeAuthenticationRecord(string)

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

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

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

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

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

function deserializeAuthenticationRecord(serializedRecord: string): AuthenticationRecord

パラメーター

serializedRecord

string

以前に文字列にシリアル化された認証レコード。

戻り値

AuthenticationRecord

AuthenticationRecord。

getBearerTokenProvider(TokenCredential, string | string[], GetBearerTokenProviderOptions)

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

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}`);

function getBearerTokenProvider(credential: TokenCredential, scopes: string | string[], options?: GetBearerTokenProviderOptions): () => Promise<string>

パラメーター

credential
TokenCredential

要求の認証に使用される資格情報。

scopes

string | string[]

ベアラー トークンに必要なスコープ。

options
GetBearerTokenProviderOptions

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

戻り値

() => Promise<string>

ベアラー トークンを提供するコールバック。

getDefaultAzureCredential()

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

function getDefaultAzureCredential(): TokenCredential

戻り値

TokenCredential

serializeAuthenticationRecord(AuthenticationRecord)

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

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

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

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

function serializeAuthenticationRecord(record: AuthenticationRecord): string

パラメーター

record
AuthenticationRecord

戻り値

string

useIdentityPlugin(IdentityPlugin)

追加機能を使用して 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
  }
});

function useIdentityPlugin(plugin: IdentityPlugin)

パラメーター

plugin
IdentityPlugin

登録するプラグイン