@azure/identity package
クラス
| AggregateAuthenticationError |
|
| AuthenticationError |
Azure Active Directory での認証の失敗に関する詳細を提供します。 フィールドには |
| 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でローカルで認証する必要があります。
組織内の更新トークンの有効性によっては、一定期間後にこのプロセスを繰り返す必要がある場合があります。 一般に、更新トークンの有効期間は数週間から数か月です。 AzureDeveloperCliCredential では、もう一度サインインするように求められます。 |
| AzurePowerShellCredential |
この資格情報では、Azure PowerShell モジュールから現在ログインしているユーザー情報が使用されます。 これを行うには、ユーザー アクセス トークンを読み取り、Azure PowerShell コマンドを使用して有効期限が切れます |
| ChainedTokenCredential |
getToken メソッドの 1 つがアクセス トークンを返すまで、複数 |
| ClientAssertionCredential |
JWT アサーションを使用してサービス プリンシパルを認証します。 |
| ClientCertificateCredential |
アプリ登録に割り当てられている PEM でエンコードされた証明書を使用して認証をMicrosoft Entra IDできるようにします。 証明書認証を構成する方法の詳細については、こちらを参照してください。 |
| ClientSecretCredential |
アプリ登録用に生成されたクライアント シークレットを使用して認証をMicrosoft Entra IDできるようにします。 クライアント シークレットを構成する方法の詳細については、こちらを参照してください。 |
| 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 |
代理フローを使用して認証を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 でのワークロード ID 認証Microsoft Entraサポートし、Azure Kubernetes 環境で使用可能な SAC を使用してトークンを取得します。 詳細については、「Microsoft Entra ワークロード ID」を参照してください。 |
インターフェイス
| AccessToken |
有効期限を持つアクセス トークンを表します。 |
| AuthenticationRecord |
キャッシュ内のキャッシュされたトークンを検索するために使用するレコード。 |
| AuthenticationRequiredErrorOptions |
AuthenticationRequiredError の省略可能なパラメーター |
| AuthorityValidationOptions |
Microsoft Entra IDへの認証要求時に ID ライブラリが機関の検証を行う方法を構成するオプションを提供します。 |
| AuthorizationCodeCredentialOptions |
AuthorizationCodeCredential のオプション |
| AzureCliCredentialOptions |
AzureCliCredential のオプション |
| AzureDeveloperCliCredentialOptions | |
| AzurePowerShellCredentialOptions | |
| BrokerAuthOptions |
WAM Broker 認証をサポートするための InteractiveBrowserCredential の構成オプション。 |
| BrokerDisabledOptions |
WAM ブローカー認証が無効になっている場合のパラメーター。 |
| BrokerEnabledOptions |
WAM ブローカー認証が有効になっている場合のパラメーター。 |
| BrowserCustomizationOptions |
ブラウザーのカスタマイズ用の共有構成オプション |
| ClientAssertionCredentialOptions | |
| ClientCertificateCredentialOptions |
ClientCertificateCredential クラスの省略可能なパラメーター。 |
| ClientCertificatePEMCertificate |
PEM 証明書の文字列内容を含 む ClientCertificateCredential に必要な構成オプション |
| ClientCertificatePEMCertificatePath |
PEM 証明書へのパスを含 む ClientCertificateCredential に必要な構成オプション。 |
| ClientSecretCredentialOptions |
ClientSecretCredential クラスの省略可能なパラメーター。 |
| CredentialPersistenceOptions |
永続的なトークン キャッシュをサポートする資格情報の共有構成オプション。 |
| DefaultAzureCredentialClientIdOptions |
DefaultAzureCredential クラスを構成するためのオプションを提供します。
両方の 1 つだけが |
| DefaultAzureCredentialOptions |
DefaultAzureCredential クラスを構成するためのオプションを提供します。 |
| DefaultAzureCredentialResourceIdOptions |
DefaultAzureCredential クラスを構成するためのオプションを提供します。
両方の 1 つだけが |
| DeviceCodeCredentialOptions |
Node.js の InteractiveBrowserCredential クラスのオプションを定義します。 |
| DeviceCodeInfo |
コードを入力する必要があるユーザー コードと検証 URI を提供します。 また、これらの詳細を含む命令を含むユーザーに表示するメッセージも提供します。 |
| EnvironmentCredentialOptions |
使用可能な環境変数に応じて認証をMicrosoft Entra IDできるようにします。 EnvironmentCredential クラスのオプションを定義します。 |
| ErrorResponse |
詳細については、公式ドキュメントを参照してください。 注: このドキュメントは v1 OAuth サポート用ですが、同じエラー応答の詳細が v2 にも適用されます。 |
| GetTokenOptions |
TokenCredential.getToken のオプションを定義します。 |
| InteractiveBrowserCredentialInBrowserOptions |
InteractiveBrowserCredential クラスの一般的なオプションを定義します。 |
| InteractiveBrowserCredentialNodeOptions |
InteractiveBrowserCredential クラスの一般的なオプションを定義します。 |
| InteractiveCredentialOptions |
ユーザー操作を必要とする ID 資格情報の一般的なコンストラクター オプション。 |
| ManagedIdentityCredentialClientIdOptions |
ManagedIdentityCredential コンストラクターで送信するオプション。
両方の 1 つだけが |
| ManagedIdentityCredentialResourceIdOptions |
ManagedIdentityCredential コンストラクターで送信するオプション。
両方の 1 つだけが |
| MultiTenantTokenCredentialOptions |
追加で許可されるテナントを許可するマルチテナント アプリケーションのオプション。 |
| OnBehalfOfCredentialCertificateOptions |
証明書を使用して OnBehalfOfCredential を 認証するパラメーターを定義します。 |
| OnBehalfOfCredentialSecretOptions |
シークレットを使用して OnBehalfOfCredential を認証するパラメーターを定義します。 |
| TokenCachePersistenceOptions |
ID 資格情報でトークン キャッシュの永続化を有効にするパラメーター。 |
| TokenCredential |
認証トークンを提供できる資格情報を表します。 |
| TokenCredentialOptions |
ID ライブラリがMicrosoft Entra IDへの認証要求を行う方法を構成するオプションを提供します。 |
| UsernamePasswordCredentialOptions |
UsernamePasswordCredential クラスのオプションを定義します。 |
| VisualStudioCodeCredentialOptions |
Visual Studio Code 資格情報を構成するためのオプションを提供します。 |
| WorkloadIdentityCredentialOptions |
型エイリアス
| BrokerOptions |
InteractiveBrowserCredential で WAM ブローカー認証を有効にするパラメーター。 |
| BrowserLoginStyle |
(ブラウザー専用機能)認証フローで使用する "ログイン スタイル":
|
| ClientCertificateCredentialPEMConfiguration |
PEM 証明書の文字列内容、または PEM 証明書へのパスを含む ClientCertificateCredential に必要な構成オプション。 |
| DeviceCodePromptCallback |
ユーザーに認証の詳細を表示するために DeviceCodeCredential に渡されるコールバックの署名を定義します。 |
| IdentityPlugin |
Azure Identity プラグインの種類。プラグイン コンテキストを受け入れる関数です。 |
| OnBehalfOfCredentialOptions |
OnBehalfOfCredential クラスの省略可能なパラメーター。 |
列挙型
| AzureAuthorityHosts |
既知の Azure 機関ホストの一覧 |
機能
| deserialize |
以前にシリアル化された認証レコードを文字列から オブジェクトに逆シリアル化します。 入力文字列には、次のプロパティが含まれている必要があります。
受信したバージョンがサポートされていない場合は、エラーがスローされます。 現時点では、使用可能なバージョンは "1.0" のみです。これは、認証レコードがシリアル化されるときに常に設定されます。 |
| get |
DefaultAzureCredential の新しいインスタンスを返します。 |
| serialize |
を シリアル化された認証レコードの出力には、次のプロパティが含まれます。
後でこの文字列をシリアル化された に変換するには、エクスポートされた |
| use |
追加の機能を使用して Azure ID を拡張します。 次のようなプラグイン パッケージからプラグインを渡します。
例: |
関数の詳細
deserializeAuthenticationRecord(string)
以前にシリアル化された認証レコードを文字列から オブジェクトに逆シリアル化します。
入力文字列には、次のプロパティが含まれている必要があります。
- "authority"
- "homeAccountId"
- "clientId"
- "tenantId"
- "username"
- "version"
受信したバージョンがサポートされていない場合は、エラーがスローされます。
現時点では、使用可能なバージョンは "1.0" のみです。これは、認証レコードがシリアル化されるときに常に設定されます。
function deserializeAuthenticationRecord(serializedRecord: string): AuthenticationRecordパラメーター
- serializedRecord
-
string
以前に文字列にシリアル化された認証レコード。
戻り値
AuthenticationRecord。
getDefaultAzureCredential()
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
登録するプラグイン