次の方法で共有

DeviceCodeCredentialOptions interface

  • リファレンス
パッケージ:
@azure/identity

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

Extends

InteractiveCredentialOptions,CredentialPersistenceOptions

プロパティ

clientId

テナント内のアプリの登録のクライアント (アプリケーション) ID。
tenantId

Microsoft Entra テナント (ディレクトリ) ID。
userPromptCallback

DeviceCodeInfo をユーザーに表示するために呼び出されるコールバック関数。 未割り当てのままにすると、デバイス コード情報と認証手順がコンソールに自動的に記録されます。

継承されたプロパティ

additionallyAllowedTenants

マルチテナント アプリケーションの場合は、資格情報がトークンを取得できる追加のテナントを指定します。 ワイルドカード値 "*" を追加して、アプリケーションがインストールされている任意のテナントのトークンを資格情報で取得できるようにします。
additionalPolicies

HTTP パイプラインに含める追加のポリシー。
allowInsecureConnection

要求が HTTPS ではなく HTTP 経由で送信される場合は true に設定します
authenticationRecord

個々のアカウントのキャッシュされた資格情報を取得するために使用できる以前の認証の結果。 これは、アプリケーションがクライアント ID とテナント ID のペアごとに複数のアカウントを操作する場合に必要です。

このレコードは、次のように資格情報の authenticate() メソッドを呼び出すことによって取得できます。

const authenticationRecord = await credential.authenticate();
authorityHost

認証要求に使用する機関ホスト。 使用可能な値は、 AzureAuthorityHosts を使用して使用できます。 既定値は "https://login.microsoftonline.com" です。
disableAutomaticAuthentication

手動認証が必要な場合に getToken スローを行います。 開発者は を呼び出 authenticate() して、手動で認証するタイミングを制御する必要があります。
disableInstanceDiscovery

フィールドは、認証を試みるときにインスタンス検出を実行するかどうかを決定します。 これを に true 設定すると、インスタンスの検出と機関の検証の両方が完全に無効になります。 その結果、構成された機関ホストが有効で信頼できることを確認することが重要です。 この機能は、プライベート クラウドや Azure Stack など、メタデータ エンドポイントに到達できないシナリオでの使用を目的としています。 インスタンス検出のプロセスでは、 から https://login.microsoft.com/ 機関メタデータを取得して機関を検証する必要があります。
httpClient

HTTP 要求の送信に使用される HttpClient。
loggingOptions

ユーザーは、ログ ポリシー オプションの設定を構成し、顧客サポートのアカウント情報と個人を特定できる情報をログに記録できるようにします。
proxyOptions

送信要求のプロキシを構成するためのオプション。
redirectOptions

リダイレクト応答の処理方法のオプション。
retryOptions

失敗した要求を再試行する方法を制御するオプション。
telemetryOptions

一般的なテレメトリとトレース情報を送信要求に設定するためのオプション。
tlsOptions

TLS 認証を構成するためのオプション
tokenCachePersistenceOptions

資格情報を格納するときに永続化レイヤーに提供するオプション (使用可能な場合)。

最初に永続化プロバイダー プラグインを登録する必要があります。 NPM の @azure/identity-cache-persistence パッケージを参照してください。

例:

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

useIdentityPlugin(cachePersistencePlugin);

async function main() {
  const credential = new DeviceCodeCredential({
    tokenCachePersistenceOptions: {
      enabled: true
    }
  });
}

main().catch((error) => {
  console.error("An error occurred:", error);
  process.exit(1);
});
userAgentOptions

送信要求にユーザー エージェントの詳細を追加するためのオプション。

プロパティの詳細

clientId

テナント内のアプリの登録のクライアント (アプリケーション) ID。

clientId?: string

プロパティ値

string

tenantId

Microsoft Entra テナント (ディレクトリ) ID。

tenantId?: string

プロパティ値

string

userPromptCallback

DeviceCodeInfo をユーザーに表示するために呼び出されるコールバック関数。 未割り当てのままにすると、デバイス コード情報と認証手順がコンソールに自動的に記録されます。

userPromptCallback?: DeviceCodePromptCallback

プロパティ値

DeviceCodePromptCallback

継承されたプロパティの詳細

additionallyAllowedTenants

マルチテナント アプリケーションの場合は、資格情報がトークンを取得できる追加のテナントを指定します。 ワイルドカード値 "*" を追加して、アプリケーションがインストールされている任意のテナントのトークンを資格情報で取得できるようにします。

additionallyAllowedTenants?: string[]

プロパティ値

string[]

InteractiveCredentialOptions.additionallyAllowedTenantsから継承されます

additionalPolicies

HTTP パイプラインに含める追加のポリシー。

additionalPolicies?: AdditionalPolicyConfig[]

プロパティ値

AdditionalPolicyConfig[]

InteractiveCredentialOptions.additionalPoliciesから継承

allowInsecureConnection

要求が HTTPS ではなく HTTP 経由で送信される場合は true に設定します

allowInsecureConnection?: boolean

プロパティ値

boolean

InteractiveCredentialOptions.allowInsecureConnectionから継承

authenticationRecord

個々のアカウントのキャッシュされた資格情報を取得するために使用できる以前の認証の結果。 これは、アプリケーションがクライアント ID とテナント ID のペアごとに複数のアカウントを操作する場合に必要です。

このレコードは、次のように資格情報の authenticate() メソッドを呼び出すことによって取得できます。

const authenticationRecord = await credential.authenticate();

authenticationRecord?: AuthenticationRecord

プロパティ値

AuthenticationRecord

InteractiveCredentialOptions.authenticationRecordから継承

authorityHost

認証要求に使用する機関ホスト。 使用可能な値は、 AzureAuthorityHosts を使用して使用できます。 既定値は "https://login.microsoftonline.com" です。

authorityHost?: string

プロパティ値

string

InteractiveCredentialOptions.authorityHostから継承

disableAutomaticAuthentication

手動認証が必要な場合に getToken スローを行います。 開発者は を呼び出 authenticate() して、手動で認証するタイミングを制御する必要があります。

disableAutomaticAuthentication?: boolean

プロパティ値

boolean

InteractiveCredentialOptions.disableAutomaticAuthenticationから継承

disableInstanceDiscovery

フィールドは、認証を試みるときにインスタンス検出を実行するかどうかを決定します。 これを に true 設定すると、インスタンスの検出と機関の検証の両方が完全に無効になります。 その結果、構成された機関ホストが有効で信頼できることを確認することが重要です。 この機能は、プライベート クラウドや Azure Stack など、メタデータ エンドポイントに到達できないシナリオでの使用を目的としています。 インスタンス検出のプロセスでは、 から https://login.microsoft.com/ 機関メタデータを取得して機関を検証する必要があります。

disableInstanceDiscovery?: boolean

プロパティ値

boolean

InteractiveCredentialOptions.disableInstanceDiscoveryから継承

httpClient

HTTP 要求の送信に使用される HttpClient。

httpClient?: HttpClient

プロパティ値

HttpClient

InteractiveCredentialOptions.httpClientから継承

loggingOptions

ユーザーは、ログ ポリシー オプションの設定を構成し、顧客サポートのアカウント情報と個人を特定できる情報をログに記録できるようにします。

loggingOptions?: LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

プロパティ値

LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

InteractiveCredentialOptions.loggingOptionsから継承

proxyOptions

送信要求のプロキシを構成するためのオプション。

proxyOptions?: ProxySettings

プロパティ値

ProxySettings

InteractiveCredentialOptions.proxyOptionsから継承

redirectOptions

リダイレクト応答の処理方法のオプション。

redirectOptions?: RedirectPolicyOptions

プロパティ値

RedirectPolicyOptions

InteractiveCredentialOptions.redirectOptionsから継承

retryOptions

失敗した要求を再試行する方法を制御するオプション。

retryOptions?: PipelineRetryOptions

プロパティ値

PipelineRetryOptions

InteractiveCredentialOptions.retryOptionsから継承

telemetryOptions

一般的なテレメトリとトレース情報を送信要求に設定するためのオプション。

telemetryOptions?: TelemetryOptions

プロパティ値

TelemetryOptions

InteractiveCredentialOptions.telemetryOptionsから継承

tlsOptions

TLS 認証を構成するためのオプション

tlsOptions?: TlsSettings

プロパティ値

TlsSettings

InteractiveCredentialOptions.tlsOptionsから継承

tokenCachePersistenceOptions

資格情報を格納するときに永続化レイヤーに提供するオプション (使用可能な場合)。

最初に永続化プロバイダー プラグインを登録する必要があります。 NPM の @azure/identity-cache-persistence パッケージを参照してください。

例:

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

useIdentityPlugin(cachePersistencePlugin);

async function main() {
  const credential = new DeviceCodeCredential({
    tokenCachePersistenceOptions: {
      enabled: true
    }
  });
}

main().catch((error) => {
  console.error("An error occurred:", error);
  process.exit(1);
});

tokenCachePersistenceOptions?: TokenCachePersistenceOptions

プロパティ値

TokenCachePersistenceOptions

CredentialPersistenceOptions.tokenCachePersistenceOptionsから継承

userAgentOptions

送信要求にユーザー エージェントの詳細を追加するためのオプション。

userAgentOptions?: UserAgentPolicyOptions

プロパティ値

UserAgentPolicyOptions

InteractiveCredentialOptions.userAgentOptionsから継承