EnvironmentCredentialBuilder クラス

  • リファレンス
パッケージ:
com.azure.identity
Maven 成果物:
com.azure:azure-identity:1.10.4

public class EnvironmentCredentialBuilder
extends CredentialBuilderBase<EnvironmentCredentialBuilder>

をインスタンス化 EnvironmentCredentialするための Fluent 資格情報ビルダー。

EnvironmentCredentialは、アプリケーションが環境変数から資格情報を読み取るシナリオに適しています。 資格情報では、サービス プリンシパルとユーザー資格情報ベースの認証がサポートされており、シナリオごとに一連の環境変数を構成する必要があります。

サンプル: 環境の構築Credential

次のコード サンプルは、 を使用して EnvironmentCredentialBuilder を構成する のEnvironmentCredential作成を示しています。 この資格情報が作成されると、多くの Azure SDK for Java クライアント ビルダーのビルダーに 'credential' パラメーターとして渡される場合があります。

TokenCredential environmentCredential = new EnvironmentCredentialBuilder()
     .build();

コンストラクターの概要

コンストラクター 説明
EnvironmentCredentialBuilder()

メソッドの概要

修飾子と型 メソッドと説明
EnvironmentCredentialBuilder authorityHost(String authorityHost)

トークンを取得する Azure Active Directory エンドポイントを指定します。
EnvironmentCredential build()

現在の構成で新しい EnvironmentCredential を作成します。
EnvironmentCredentialBuilder executorService(ExecutorService executorService)

認証要求の実行に使用する Executorサービスを指定します。

メソッドの継承元: CredentialBuilderBase

addPolicy clientOptions configuration enableAccountIdentifierLogging httpClient httpLogOptions httpPipeline maxRetry pipeline proxyOptions retryOptions retryPolicy retryTimeout

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

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

コンストラクターの詳細

EnvironmentCredentialBuilder

public EnvironmentCredentialBuilder()

メソッドの詳細

authorityHost

public EnvironmentCredentialBuilder authorityHost(String authorityHost)

トークンを取得する Azure Active Directory エンドポイントを指定します。

Parameters:

authorityHost - Azure Active Directory エンドポイント

Returns:

指定された権限ホストが設定された、このビルダーの更新されたインスタンス。

build

public EnvironmentCredential build()

現在の構成で新しい EnvironmentCredential を作成します。

Returns:

現在 EnvironmentCredential の構成を含む 。

executorService

public EnvironmentCredentialBuilder executorService(ExecutorService executorService)

認証要求の実行に使用する ExecutorService を指定します。 開発者は ExecutorService のライフサイクルを維持する責任があります。

これが構成されていない場合は、 ForkJoinPool#commonPool() が使用され、他のアプリケーション タスクとも共有されます。 共通プールが他のタスクに頻繁に使用されている場合、認証要求が枯渇する可能性があり、この Executor サービスの設定を検討する必要があります。

Executor サービスと は、TokenCredential が Azure SDK クライアントによって使用されなくなり、アプリケーションが終了する前にシャットダウンする必要がある場合は、安全にシャットダウンできます。

Parameters:

executorService - 認証要求の実行に使用する Executor サービス。

Returns:

Executor サービスが指定されたとおりに設定された、このビルダーの更新されたインスタンス。

適用対象