次の方法で共有

ClientCertificateCredentialBuilder クラス

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

public class ClientCertificateCredentialBuilder
extends AadCredentialBuilderBase<ClientCertificateCredentialBuilder>

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

ClientCertificateCredential は、サービス プリンシパル認証を使用してトークンを取得します。 Azure での認証の一種であり、 Azure Active Directory (Azure AD) への非対話型ログインを可能にし、アプリケーションまたはサービスが Azure リソースで自身を認証できるようにします。 サービス プリンシパルは、基本的には、Azure リソースで認証するために使用できる Azure AD 内のアプリケーション用に作成された ID です。 これは、アプリケーションまたはサービスの "ユーザー ID" のようなもので、ユーザーの資格情報を使用しなくても、アプリケーションが Azure リソースで自身を認証する方法を提供します。 Azure Active Directory (Azure AD) を使用すると、ユーザーは認証の ID として使用できるサービス プリンシパルを登録できます。 登録されたサービス プリンシパルに関連付けられているクライアント証明書は、サービス プリンシパルを認証するときにパスワードとして使用されます。 は ClientCertificateCredentialBuilder 、サービス プリンシパルまたは登録済みの AAD アプリケーションのクライアント証明書を使用してアクセス トークンを取得します。 この資格情報がアクセス トークンを取得するには、サービス プリンシパルの tenantId、clientId、clientCertificate が必要です。 認証には、Azure でホストされる開発環境とローカル開発環境の両方で使用できます。 詳細については、概念に関する 知識と構成の詳細を参照してください。

サンプル: 単純な ClientCertificateCredential を構築する

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

TokenCredential clientCertificateCredential = new ClientCertificateCredentialBuilder()
     .tenantId(tenantId)
     .clientId(clientId)
     .pemCertificate("<PATH-TO-PEM-CERTIFICATE>")
     .build();

サンプル: プロキシの背後に ClientCertificateCredential を構築する

次のコード サンプルは、 を使用して ClientCertificateCredentialBuilder を構成する のClientCertificateCredential作成を示しています。 をtenantId作成ClientSecretCredentialするには、 パラメーターと certificate パラメーターclientIdが必要です。 は proxyOptions 、必要に応じてプロキシをターゲットにするように構成できます。 この資格情報が作成されると、多くの Azure SDK for Java クライアント ビルダーのビルダーに 'credential' パラメーターとして渡される場合があります。

TokenCredential certificateCredential = new ClientCertificateCredentialBuilder()
     .tenantId(tenantId)
     .clientId(clientId)
     .pfxCertificate("<PATH-TO-PFX-CERTIFICATE>", "P@s$w0rd")
     .proxyOptions(new ProxyOptions(Type.HTTP, new InetSocketAddress("10.21.32.43", 5465)))
     .build();

コンストラクターの概要

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

メソッドの概要

修飾子と型 メソッドと説明
ClientCertificateCredential build()

現在の構成で新しい ClientCertificateCredential を作成します。
ClientCertificateCredentialBuilder pemCertificate(String certificatePath)

認証用の PEM 証明書のパスを AAD に設定します。
ClientCertificateCredentialBuilder pfxCertificate(String certificatePath, String clientCertificatePassword)

AAD に認証するための PFX 証明書のパスとパスワードを設定します。
ClientCertificateCredentialBuilder sendCertificateChain(boolean sendCertificateChain)

x5c 要求 (証明書の公開キー) を認証要求の一部として送信し、サブジェクト名/発行者ベースの認証を有効にする必要があるかどうかを指定します。
ClientCertificateCredentialBuilder tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)

永続的な共有トークン キャッシュ オプションを構成し、既定で無効になっている永続的なトークン キャッシュを有効にします。

メソッドの継承元: AadCredentialBuilderBase

additionallyAllowedTenants additionallyAllowedTenants authorityHost clientId disableInstanceDiscovery enableUnsafeSupportLogging executorService tenantId

メソッドの継承元: 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

コンストラクターの詳細

ClientCertificateCredentialBuilder

public ClientCertificateCredentialBuilder()

メソッドの詳細

build

public ClientCertificateCredential build()

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

Returns:

現在 ClientCertificateCredential の構成を含む 。

pemCertificate

public ClientCertificateCredentialBuilder pemCertificate(String certificatePath)

認証用の PEM 証明書のパスを AAD に設定します。

Parameters:

certificatePath - 証明書を含む PEM ファイル

Returns:

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

pfxCertificate

public ClientCertificateCredentialBuilder pfxCertificate(String certificatePath, String clientCertificatePassword)

AAD に認証するための PFX 証明書のパスとパスワードを設定します。

Parameters:

certificatePath - 証明書を含むパスワードで保護された PFX ファイル
clientCertificatePassword - PFX ファイルを保護するパスワード

Returns:

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

sendCertificateChain

public ClientCertificateCredentialBuilder sendCertificateChain(boolean sendCertificateChain)

x5c 要求 (証明書の公開キー) を認証要求の一部として送信し、サブジェクト名/発行者ベースの認証を有効にする必要があるかどうかを指定します。 既定値は false です。

Parameters:

sendCertificateChain - 認証要求の一部として証明書チェーンを送信する必要があるかどうかを示す フラグ。

Returns:

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

tokenCachePersistenceOptions

public ClientCertificateCredentialBuilder tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)

永続的な共有トークン キャッシュ オプションを構成し、既定で無効になっている永続的なトークン キャッシュを有効にします。 構成されている場合、資格情報は、現在のユーザーに対して保護されたコンピューターに永続化されたキャッシュにトークンを格納します。これは、他の資格情報とプロセスで共有できます。

Parameters:

tokenCachePersistenceOptions - トークン キャッシュ構成オプション

Returns:

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

適用対象