DefaultAzureCredentialBuilder クラス
- java.
lang. Object - com.
azure. identity. CredentialBuilderBase<T> - com.
azure. identity. DefaultAzureCredentialBuilder
- com.
- com.
public class DefaultAzureCredentialBuilder
extends CredentialBuilderBase<DefaultAzureCredentialBuilder>
をインスタンス化 DefaultAzureCredentialするための Fluent 資格情報ビルダー。
DefaultAzureCredentialは、アプリケーションが最終的に Azure で実行されることを意図しているほとんどのシナリオに適しています。 DefaultAzureCredential では、デプロイ時に一般的に認証に使用される資格情報と、開発環境での認証に使用される資格情報が組み合わされます。 DefaultAzureCredential は、次のメカニズムを順に経由して認証を試行します。
サンプル: DefaultAzureCredential の構築
次のコード サンプルは、DefaultAzureCredentialBuilder を使用して を構成する の作成 DefaultAzureCredentialを示しています。 この資格情報が作成されると、多くの Azure SDK for Java クライアント ビルダーのビルダーに 'credential' パラメーターとして渡される場合があります。
TokenCredential defaultAzureCredential = new DefaultAzureCredentialBuilder()
.build();
サンプル: ユーザー割り当てマネージド ID を使用して DefaultAzureCredential を構築する
Azure User-Assigned マネージド ID (UAMI) は、1 つ以上の Azure リソースに関連付けられている Azure Active Directory (Azure AD) で ID を作成できる機能です。 その後、この ID を使用して、さまざまな Azure サービスとリソースへのアクセスを認証および承認できます。 次の DefaultAzureCredential コード サンプルは、DefaultAzureCredentialBuilder を使用してユーザー割り当てマネージド ID をターゲットにする の作成を示しています。 この資格情報が作成されると、多くの Azure SDK for Java クライアント ビルダーのビルダーに 'credential' パラメーターとして渡される場合があります。
TokenCredential dacWithUserAssignedManagedIdentity = new DefaultAzureCredentialBuilder()
.managedIdentityClientId("<Managed-Identity-Client-Id")
.build();
コンストラクターの概要
| コンストラクター | 説明 |
|---|---|
| DefaultAzureCredentialBuilder() |
既定 |
メソッドの概要
メソッドの継承元: CredentialBuilderBase
メソッドの継承元: java.lang.Object
コンストラクターの詳細
DefaultAzureCredentialBuilder
public DefaultAzureCredentialBuilder()
DefaultAzureCredentialBuilder のインスタンスを作成します。
メソッドの詳細
additionallyAllowedTenants
public DefaultAzureCredentialBuilder additionallyAllowedTenants(String[] additionallyAllowedTenants)
マルチテナント アプリケーションの場合は、資格情報がトークンを取得できる追加のテナントを指定します。 ワイルドカード値 "*" を追加して、アプリケーションがインストールされている任意のテナントのトークンを資格情報で取得できるようにします。
Parameters:
Returns:
additionallyAllowedTenants
public DefaultAzureCredentialBuilder additionallyAllowedTenants(List
マルチテナント アプリケーションの場合は、資格情報がトークンを取得できる追加のテナントを指定します。 ワイルドカード値 "*" を追加して、アプリケーションがインストールされている任意のテナントのトークンを資格情報で取得できるようにします。
Parameters:
Returns:
authorityHost
public DefaultAzureCredentialBuilder authorityHost(String authorityHost)
トークンを取得する Azure Active Directory エンドポイントを指定します。
Parameters:
Returns:
build
public DefaultAzureCredential build()
構成済みのオプション セットを使用して新規 DefaultAzureCredential を作成します。
Returns:
credentialProcessTimeout
public DefaultAzureCredentialBuilder credentialProcessTimeout(Duration credentialProcessTimeout)
個別の Duration プロセス呼び出しに依存する開発者資格情報 (Azure CLI など) のタイムアウトを指定します。
Parameters:
Returns:
disableInstanceDiscovery
public DefaultAzureCredentialBuilder disableInstanceDiscovery()
認証を試みるときにインスタンス検出を実行するかどうかを決定する設定を無効にします。 これにより、インスタンスの検出と機関の検証の両方が完全に無効になります。 この機能は、プライベート クラウドや Azure Stack など、メタデータ エンドポイントに到達できないシナリオでの使用を目的としています。 インスタンス検出のプロセスでは、 から https://login.microsoft.com/ 機関メタデータを取得して機関を検証する必要があります。 この API を使用すると、機関の検証が無効になります。 その結果、構成された機関ホストが有効で信頼できることを確認することが重要です。
Returns:
executorService
public DefaultAzureCredentialBuilder executorService(ExecutorService executorService)
認証要求の実行に使用する ExecutorService を指定します。 開発者は ExecutorService のライフサイクルを維持する責任があります。
これが構成されていない場合は、 common fork join pool が使用され、他のアプリケーション タスクとも共有されます。 共通プールが他のタスクに頻繁に使用されている場合、認証要求が枯渇する可能性があり、この Executor サービスの設定を検討する必要があります。
Executor サービスと は、TokenCredential が Azure SDK クライアントによって使用されなくなり、アプリケーションが終了する前にシャットダウンする必要がある場合は、安全にシャットダウンできます。
Parameters:
Returns:
intelliJKeePassDatabasePath
public DefaultAzureCredentialBuilder intelliJKeePassDatabasePath(String databasePath)
Azure Toolkit for IntelliJ プラグインのキャッシュされた資格情報を読み取る KeePass データベース パスを指定します。 databasePathは Windows プラットフォームで必要です。 macOS および Linux プラットフォームのネイティブ キー チェーン/キー リングにそれぞれアクセスして、キャッシュされた資格情報を取得します。
このパスは IntelliJ IDE に配置できます。 Windows: ファイル -> 設定 - 外観&の>動作 -> システム設定 -> パスワード。
Parameters:
Returns:
managedIdentityClientId
public DefaultAzureCredentialBuilder managedIdentityClientId(String clientId)
マネージド ID を持つ環境でこの資格情報が実行されている場合に、ユーザー割り当て ID またはシステム割り当て ID のクライアント ID を指定します。 設定を解除すると、AZURE_CLIENT_ID環境変数の値が使用されます。 どちらも設定されていない場合、既定値は null であり、ユーザー割り当てマネージド ID ではなく、システム割り当てマネージド ID でのみ機能します。 指定できるのは、managedIdentityClientId と managedIdentityResourceId のいずれか 1 つだけです。
Parameters:
Returns:
managedIdentityResourceId
public DefaultAzureCredentialBuilder managedIdentityResourceId(String resourceId)
マネージド ID を持つ環境でこの資格情報が実行されている場合に、ユーザー割り当て ID またはシステム割り当て ID のリソース ID を指定します。 設定を解除すると、AZURE_CLIENT_ID環境変数の値が使用されます。 どちらも設定されていない場合、既定値は null であり、ユーザー割り当てマネージド ID ではなく、システム割り当てマネージド ID でのみ機能します。 指定できるのは、managedIdentityResourceId と managedIdentityClientId のいずれか 1 つだけです。
Parameters:
Returns:
tenantId
public DefaultAzureCredentialBuilder tenantId(String tenantId)
を使用して認証するユーザーのテナント ID を設定します DefaultAzureCredential。 設定を解除すると、AZURE_TENANT_ID環境変数の値が使用されます。 どちらも設定されていない場合、既定値は null であり、既定のテナントに対してユーザーを認証します。
Parameters:
Returns:
workloadIdentityClientId
public DefaultAzureCredentialBuilder workloadIdentityClientId(String clientId)
AKS ワークロード ID 認証に使用する Azure AD アプリのクライアント ID を指定します。 未設定の場合は、 managedIdentityClientId(String clientId) が使用されます。 両方の値が設定されていない場合は、AZURE_CLIENT_ID環境変数の値が使用されます。 何も設定されていない場合、既定値は null であり、ワークロード ID 認証は試行されません。
Parameters:
Returns: