次の方法で共有


CredentialBuilderBase<T> クラス

  • java.lang.Object
    • com.azure.identity.CredentialBuilderBase<T>

型パラメーター

T

資格情報ビルダーの種類

実装

public abstract class CredentialBuilderBase
implements HttpTrait<T>

すべての資格情報ビルダーの基底クラス。

メソッドの概要

修飾子と型 メソッドと説明
T addPolicy(HttpPipelinePolicy policy)

HttpPipelinePolicy送信された各要求に適用する を追加します。

T clientOptions(ClientOptions clientOptions)

アプリケーション ID、ヘッダー、プロキシ構成などの一般的なプロパティを設定できます。

T configuration(Configuration configuration)

資格情報の構築中に使用される構成ストアを設定します。

T enableAccountIdentifierLogging()

デバッグ/監視の目的で、クライアント側でアカウント識別子をログに記録できるようにします。

T httpClient(HttpClient client)

サービスとの間で要求を送受信するために使用する HTTP クライアントを設定します。

T httpLogOptions(HttpLogOptions logOptions)

サービスとの間で HttpLogOptions 要求を送受信するときに使用する を設定します。

T httpPipeline(HttpPipeline httpPipeline)

非推奨

このメソッドは非推奨とされます。 代わりに pipeline(HttpPipeline pipeline) を使用してください

すべての要求を送信する Httpパイプラインを指定します。

T maxRetry(int maxRetry)

認証要求が失敗した場合の最大再試行回数を指定します。

T pipeline(HttpPipeline pipeline)

HttpPipelineサービス クライアントに使用する を設定します。

T proxyOptions(ProxyOptions proxyOptions)

非推奨

代わりに でプロキシ オプションを HttpClient 構成し、 を使用して httpClient(HttpClient client)資格情報にそのクライアントを設定します。

プロキシ構成のオプションを指定します。

T retryOptions(RetryOptions retryOptions)

クライアントを RetryOptions 介して行われたすべての要求の を設定します。

T retryPolicy(RetryPolicy retryPolicy)

各要求が RetryPolicy 送信されるときに使用される を設定します。

T retryTimeout(Function<Duration,Duration> retryTimeout)

再試行された要求ごとにタイムアウトの秒数を計算する関数を指定します。

メソッドの継承元: java.lang.Object

メソッドの詳細

addPolicy

public T addPolicy(HttpPipelinePolicy policy)

HttpPipelinePolicy送信された各要求に適用する を追加します。

メモ: HttpTrait API の優先順位を理解することが重要です。 特に、 が指定されている場合 HttpPipeline 、これは特性内の他のすべての API よりも優先され、無視されます。 が指定されていない HttpPipeline 場合、HTTP パイプラインは、この特性に指定された設定に基づいて内部的に構築されます。 また、 が指定されている場合 HttpPipeline にも無視されるこの特性を実装する型には他の API が存在する可能性があるため、この特性を実装する型のドキュメントを参照して、影響の完全なセットを理解してください。

Parameters:

policy - HttpPipelinePolicy

Returns:

ポリシーが構成された、このビルダーの更新されたインスタンス。

clientOptions

public T clientOptions(ClientOptions clientOptions)

アプリケーション ID、ヘッダー、プロキシ構成などの一般的なプロパティを設定できます。このメソッドは、 クラスのインスタンス (基底クラスの HttpClientOptions サブクラス ClientOptions ) で呼び出することをお勧めします。 HttpClientOptions サブクラスは、HTTP クライアントに適した構成オプションを提供します。これは、この HttpTrait インターフェイスを実装するすべてのクラスに適用できます。

メモ: HttpTrait API の優先順位を理解することが重要です。 特に、 が指定されている場合 HttpPipeline 、これは特性内の他のすべての API よりも優先され、無視されます。 が指定されていない HttpPipeline 場合、HTTP パイプラインは、この特性に指定された設定に基づいて内部的に構築されます。 また、 が指定されている場合 HttpPipeline にも無視されるこの特性を実装する型には他の API が存在する可能性があるため、この特性を実装する型のドキュメントを参照して、影響の完全なセットを理解してください。

Parameters:

clientOptions - の構成済みインスタンス HttpClientOptions

Returns:

クライアント オプションが構成された、このビルダーの更新されたインスタンス。

configuration

public T configuration(Configuration configuration)

資格情報の構築中に使用される構成ストアを設定します。 既定の構成ストアは、 の複製です global configuration store

Parameters:

configuration - Env 変数やプロパティの読み込みに使用される構成ストア。

Returns:

構成ストアが指定どおりに設定された、このビルダーの更新されたインスタンス。

enableAccountIdentifierLogging

public T enableAccountIdentifierLogging()

デバッグ/監視の目的で、クライアント側でアカウント識別子をログに記録できるようにします。 既定では無効になっています。

アカウント識別子ログには機密情報を含めることができます。保護されたマシンでのみ有効にする必要があります。 この機能を有効にすると、アクセス トークンが正常に取得されたときに、アプリケーション ID、オブジェクト ID、テナント ID、およびユーザー プリンシパル名が INFO レベルでログに記録されます。 アカウント識別子ログを表示するには、INFO レベルのログが有効になっていることを確認します。

Returns:

このビルダーの更新されたインスタンス。

httpClient

public T httpClient(HttpClient client)

サービスとの間で要求を送受信するために使用する HTTP クライアントを設定します。

Parameters:

client - 要求に使用する HTTP クライアント。

Returns:

http クライアントが指定どおりに設定された、このビルダーの更新されたインスタンス。

httpLogOptions

public T httpLogOptions(HttpLogOptions logOptions)

サービスとの間で HttpLogOptions 要求を送受信するときに使用する を設定します。 logLevelが指定されていない場合、 のHttpLogDetailLevel#NONE既定値が設定されます。

メモ: HttpTrait API の優先順位を理解することが重要です。 特に、 が指定されている場合 HttpPipeline 、これは特性内の他のすべての API よりも優先され、無視されます。 が指定されていない HttpPipeline 場合、HTTP パイプラインは、この特性に指定された設定に基づいて内部的に構築されます。 また、 が指定されている場合 HttpPipeline にも無視されるこの特性を実装する型には他の API が存在する可能性があるため、この特性を実装する型のドキュメントを参照して、影響の完全なセットを理解してください。

Parameters:

logOptions - HttpLogOptionsサービスとの間で要求を送受信するときに使用する 。

Returns:

Http ログ オプションが構成された、このビルダーの更新されたインスタンス。

httpPipeline

@Deprecated
public T httpPipeline(HttpPipeline httpPipeline)

非推奨

このメソッドは非推奨とされます。 代わりに pipeline(HttpPipeline pipeline) を使用してください

すべての要求を送信する HttpPipeline を指定します。 この設定は、他の設定よりも優先されます。

Parameters:

httpPipeline - すべての要求を送信する HttpPipeline

Returns:

http パイプラインが指定どおりに設定された、このビルダーの更新されたインスタンス。

maxRetry

public T maxRetry(int maxRetry)

認証要求が失敗した場合の最大再試行回数を指定します。

Parameters:

maxRetry - 再試行回数

Returns:

指定した最大再試行回数が設定された、このビルダーの更新されたインスタンス。

pipeline

public T pipeline(HttpPipeline pipeline)

HttpPipelineサービス クライアントに使用する を設定します。

メモ: HttpTrait API の優先順位を理解することが重要です。 特に、 が指定されている場合 HttpPipeline 、これは特性内の他のすべての API よりも優先され、無視されます。 が指定されていない HttpPipeline 場合、HTTP パイプラインは、この特性に指定された設定に基づいて内部的に構築されます。 また、 が指定されている場合 HttpPipeline にも無視されるこの特性を実装する型には他の API が存在する可能性があるため、この特性を実装する型のドキュメントを参照して、影響の完全なセットを理解してください。

Parameters:

pipeline - HttpPipeline を使用して、サービス要求の送信と応答の受信に使用します。

Returns:

http パイプラインが指定どおりに設定された、このビルダーの更新されたインスタンス。

proxyOptions

@Deprecated
public T proxyOptions(ProxyOptions proxyOptions)

非推奨

代わりに でプロキシ オプションを HttpClient 構成し、 を使用して httpClient(HttpClient client)資格情報にそのクライアントを設定します。

プロキシ構成のオプションを指定します。

Parameters:

proxyOptions - プロキシ構成のオプション

Returns:

プロキシ オプションが指定どおりに設定された、このビルダーの更新されたインスタンス。

retryOptions

public T retryOptions(RetryOptions retryOptions)

クライアントを RetryOptions 介して行われたすべての要求の を設定します。

メモ: HttpTrait API の優先順位を理解することが重要です。 特に、 が指定されている場合 HttpPipeline 、これは特性内の他のすべての API よりも優先され、無視されます。 が指定されていない HttpPipeline 場合、HTTP パイプラインは、この特性に指定された設定に基づいて内部的に構築されます。 また、 が指定されている場合 HttpPipeline にも無視されるこの特性を実装する型には他の API が存在する可能性があるため、この特性を実装する型のドキュメントを参照して、影響の完全なセットを理解してください。

この設定は、 を使用する場合 retryPolicy(RetryPolicy retryPolicy)と相互に排他的です。

Parameters:

retryOptions - RetryOptionsクライアントを介して行われたすべての要求に使用する 。

Returns:

再試行オプションが構成された、このビルダーの更新されたインスタンス。

retryPolicy

public T retryPolicy(RetryPolicy retryPolicy)

各要求が RetryPolicy 送信されるときに使用される を設定します。 この設定は、 を使用する場合 retryOptions(RetryOptions retryOptions)と相互に排他的です。 既定の再試行ポリシーは、指定されていない場合はパイプラインで使用されます。

Parameters:

retryPolicy - ユーザーの再試行ポリシーが各要求に適用されます。

Returns:

再試行ポリシーが構成された、このビルダーの更新されたインスタンス。

retryTimeout

public T retryTimeout(Function retryTimeout)

再試行された要求ごとにタイムアウトの秒数を計算する関数を指定します。

Parameters:

retryTimeout - 再試行回数を指定してタイムアウトを秒単位で返す 関数

Returns:

指定した再試行タイムアウトが設定された、このビルダーの更新されたインスタンス。

適用対象