次の方法で共有

UsernamePasswordCredentialOptions interface

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

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

Extends

MultiTenantTokenCredentialOptions,CredentialPersistenceOptions,AuthorityValidationOptions

継承されたプロパティ

additionallyAllowedTenants

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

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

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

認証要求に使用する機関ホスト。 使用可能な値は 、AzureAuthorityHosts を通じて使用できます。 既定値は "https://login.microsoftonline.com" です。
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

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

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

additionallyAllowedTenants

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

additionallyAllowedTenants?: string[]

プロパティ値

string[]

MultiTenantTokenCredentialOptions.additionallyAllowedTenantsから継承されます

additionalPolicies

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

additionalPolicies?: AdditionalPolicyConfig[]

プロパティ値

AdditionalPolicyConfig[]

MultiTenantTokenCredentialOptions.additionalPoliciesから継承されます

allowInsecureConnection

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

allowInsecureConnection?: boolean

プロパティ値

boolean

MultiTenantTokenCredentialOptions.allowInsecureConnectionから継承されます

authorityHost

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

authorityHost?: string

プロパティ値

string

MultiTenantTokenCredentialOptions.authorityHostから継承されます

disableInstanceDiscovery

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

disableInstanceDiscovery?: boolean

プロパティ値

boolean

Inherited FromAuthorityValidationOptions.disableInstanceDiscovery

httpClient

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

httpClient?: HttpClient

プロパティ値

HttpClient

MultiTenantTokenCredentialOptions.httpClientから継承されます

loggingOptions

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

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

プロパティ値

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

MultiTenantTokenCredentialOptions.loggingOptionsから継承されます

proxyOptions

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

proxyOptions?: ProxySettings

プロパティ値

ProxySettings

MultiTenantTokenCredentialOptions.proxyOptionsから継承

redirectOptions

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

redirectOptions?: RedirectPolicyOptions

プロパティ値

RedirectPolicyOptions

MultiTenantTokenCredentialOptions.redirectOptionsから継承

retryOptions

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

retryOptions?: PipelineRetryOptions

プロパティ値

PipelineRetryOptions

MultiTenantTokenCredentialOptions.retryOptionsから継承

telemetryOptions

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

telemetryOptions?: TelemetryOptions

プロパティ値

TelemetryOptions

MultiTenantTokenCredentialOptions.telemetryOptionsから継承

tlsOptions

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

tlsOptions?: TlsSettings

プロパティ値

TlsSettings

MultiTenantTokenCredentialOptions.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

MultiTenantTokenCredentialOptions.userAgentOptionsから継承されます