TokenCredentialOptions interface

パッケージ:

@azure/identity

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

Extends

CommonClientOptions

プロパティ

authorityHost	認証要求に使用する機関ホスト。 使用可能な値は、AzureAuthorityHostsを使用して使用できます。 既定値は "https://login.microsoftonline.com"です。
loggingOptions	ユーザーは、ポリシー オプションのログ記録の設定を構成したり、アカウント情報のログ記録を許可したり、カスタマー サポートのために個人を特定できる情報を許可したりできます。

継承されたプロパティ

additionalPolicies	HTTP パイプラインに含める追加のポリシー。
agent	送信要求のエージェント インスタンスを構成するためのオプション
allowInsecureConnection	要求が HTTPS ではなく HTTP 経由で送信される場合は true に設定します
httpClient	HTTP 要求の送信に使用される HttpClient。
proxyOptions	送信要求のプロキシを構成するためのオプション。
redirectOptions	リダイレクト応答の処理方法のオプション。
retryOptions	失敗した要求を再試行する方法を制御するオプション。
telemetryOptions	一般的なテレメトリとトレース情報を送信要求に設定するためのオプション。
tlsOptions	TLS 認証を構成するためのオプション
userAgentOptions	送信要求にユーザー エージェントの詳細を追加するためのオプション。

プロパティの詳細

authorityHost

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

authorityHost?: string

プロパティ値

string

loggingOptions

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

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

プロパティ値

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

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

additionalPolicies

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

additionalPolicies?: AdditionalPolicyConfig[]

プロパティ値

AdditionalPolicyConfig[]

CommonClientOptions.additionalPolicies から継承された

agent

送信要求のエージェント インスタンスを構成するためのオプション

agent?: Agent

プロパティ値

Agent

commonClientOptions.agent から継承

allowInsecureConnection

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

allowInsecureConnection?: boolean

プロパティ値

boolean

CommonClientOptions.allowInsecureConnection から継承された

httpClient

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

httpClient?: HttpClient

プロパティ値

HttpClient

CommonClientOptions.httpClient から継承された

proxyOptions

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

proxyOptions?: ProxySettings

プロパティ値

ProxySettings

CommonClientOptions.proxyOptions から継承

redirectOptions

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

redirectOptions?: RedirectPolicyOptions

プロパティ値

RedirectPolicyOptions

CommonClientOptions.redirectOptions から継承された

retryOptions

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

retryOptions?: PipelineRetryOptions

プロパティ値

PipelineRetryOptions

commonClientOptions.retryOptions から継承

telemetryOptions

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

telemetryOptions?: TelemetryOptions

プロパティ値

TelemetryOptions

CommonClientOptions.telemetryOptions から継承された

tlsOptions

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

tlsOptions?: TlsSettings

プロパティ値

TlsSettings

CommonClientOptions.tlsOptions から継承された

userAgentOptions

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

userAgentOptions?: UserAgentPolicyOptions

プロパティ値

UserAgentPolicyOptions

CommonClientOptions.userAgentOptions から継承された