次の方法で共有

CryptographyClientBuilder クラス

  • リファレンス
パッケージ:
com.azure.security.keyvault.keys.cryptography
Maven 成果物:
com.azure:azure-security-keyvault-keys:4.8.4
  • java.lang.Object
    • com.azure.security.keyvault.keys.cryptography.CryptographyClientBuilder

実装

ConfigurationTrait<CryptographyClientBuilder> HttpTrait<CryptographyClientBuilder> TokenCredentialTrait<CryptographyClientBuilder>

public final class CryptographyClientBuilder
implements TokenCredentialTrait<CryptographyClientBuilder>, HttpTrait<CryptographyClientBuilder>, ConfigurationTrait<CryptographyClientBuilder>

このクラスは、 と CryptographyClientの構成とインスタンス化CryptographyAsyncClientに役立つ fluent builder API を提供します。それぞれ を呼び出buildAsyncClient()buildClient()して、目的のクライアントのインスタンスを構築します。

または をビルドするために必要CryptographyClientBuilderな最小限の構成オプションは、 TokenCredential と または JsonWebKey のいずれかですAzure Key Vault key identifier。CryptographyAsyncClientCryptographyClient

や などのDecryptUnwrapVerify操作を実行するときに正しい動作を保証するには、対応する逆操作Encryptに使用CryptographyAsyncClientされた特定のキー バージョン (、Wrap、または ) に対して、 または CryptographyClientSignを使用することをお勧めします。

CryptographyAsyncClient cryptographyAsyncClient = new CryptographyClientBuilder()
     .keyIdentifier("<your-key-id>")
     .credential(new DefaultAzureCredentialBuilder().build())
     .buildAsyncClient();

JsonWebKey jsonWebKey = new JsonWebKey().setId("SampleJsonWebKey");
 CryptographyAsyncClient cryptographyAsyncClient = new CryptographyClientBuilder()
     .jsonWebKey(jsonWebKey)
     .buildAsyncClient();

では log detail level、複数のカスタム policies とカスタム HttpClient を、必要に応じて で CryptographyClientBuilder構成できます。

CryptographyAsyncClient cryptographyAsyncClient = new CryptographyClientBuilder()
     .keyIdentifier("<your-key-id>")
     .credential(new DefaultAzureCredentialBuilder().build())
     .httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS))
     .httpClient(HttpClient.createDefault())
     .buildAsyncClient();

をビルドするために必要なCryptographyClientBuilder最小限の構成オプションは、 JsonWebKey と Azure Key Vault key identifier ですTokenCredential。CryptographyClient

CryptographyClient cryptographyClient = new CryptographyClientBuilder()
     .keyIdentifier("<your-key-id>")
     .credential(new DefaultAzureCredentialBuilder().build())
     .buildClient();

JsonWebKey jsonWebKey = new JsonWebKey().setId("SampleJsonWebKey");
 CryptographyClient cryptographyClient = new CryptographyClientBuilder()
     .jsonWebKey(jsonWebKey)
     .buildClient();

コンストラクターの概要

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

既定値を持つコンストラクター。

メソッドの概要

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

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

ビルダーで設定された CryptographyAsyncClient オプションに基づいて を作成します。
CryptographyClient buildClient()

ビルダーで設定された CryptographyClient オプションに基づいて を作成します。
CryptographyClientBuilder clientOptions(ClientOptions clientOptions)

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

サービス クライアントの構築中に使用される構成ストアを設定します。
CryptographyClientBuilder credential(TokenCredential credential)

サービスに TokenCredential 送信される要求を承認するために使用する を設定します。
CryptographyClientBuilder disableChallengeResourceVerification()

認証チャレンジ リソースがKey Vaultドメインまたは Managed HSM ドメインと一致するかどうかを検証することを無効にします。
CryptographyClientBuilder httpClient(HttpClient client)

サービスとの間で HttpClient 要求を送受信するために使用する を設定します。
CryptographyClientBuilder httpLogOptions(HttpLogOptions logOptions)

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

JsonWebKeyローカル暗号化操作に使用する を設定します。
CryptographyClientBuilder keyIdentifier(String keyId)

暗号化操作に使用する JSON Web キーの Azure Key Vault キー識別子を設定します。
CryptographyClientBuilder pipeline(HttpPipeline pipeline)

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

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

各要求が RetryPolicy 送信されるときに使用される を設定します。
CryptographyClientBuilder serviceVersion(CryptographyServiceVersion version)

API 要求を CryptographyServiceVersion 行うときに使用する を設定します。

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

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

コンストラクターの詳細

CryptographyClientBuilder

public CryptographyClientBuilder()

既定値を持つコンストラクター。

メソッドの詳細

addPolicy

public CryptographyClientBuilder addPolicy(HttpPipelinePolicy policy)

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

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

Parameters:

policy - HttpPipelinePolicy。

Returns:

更新後の CryptographyClientBuilder オブジェクト。

buildAsyncClient

public CryptographyAsyncClient buildAsyncClient()

ビルダーで設定された CryptographyAsyncClient オプションに基づいて を作成します。 buildAsyncClient()が呼び出されるたびに、 のCryptographyAsyncClient新しいインスタンスが作成されます。

が設定されている場合 jsonWebKey(JsonWebKey jsonWebKey) 、他のすべてのビルダー設定は無視されます。

が設定されている場合 pipeline(HttpPipeline pipeline) 、 pipeline と keyIdentifier(String keyId)) を使用して を作成します CryptographyAsyncClient。 その他のビルダー設定はすべて無視されます。 が設定されていない場合 pipeline 、 と credential(TokenCredential credential)keyIdentifier(String keyId) は を CryptographyAsyncClientビルドするために必要です。

Returns:

CryptographyAsyncClientビルダーから設定されたオプションを含む 。

buildClient

public CryptographyClient buildClient()

ビルダーで設定された CryptographyClient オプションに基づいて を作成します。 buildClient()が呼び出されるたびに、 のCryptographyClient新しいインスタンスが作成されます。

が設定されている場合 jsonWebKey(JsonWebKey jsonWebKey) 、他のすべてのビルダー設定は無視されます。

が設定されている場合 pipeline(HttpPipeline pipeline) 、 と pipelinekeyIdentifier(String keyId) は を使用して を作成します CryptographyClient。 その他のビルダー設定はすべて無視されます。 が設定されていない場合 pipeline 、 と credential(TokenCredential credential)keyIdentifier(String keyId) は を CryptographyClientビルドするために必要です。

Returns:

CryptographyClientビルダーから設定されたオプションを含む 。

clientOptions

public CryptographyClientBuilder clientOptions(ClientOptions clientOptions)

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

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

Parameters:

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

Returns:

更新後の CryptographyClientBuilder オブジェクト。

configuration

public CryptographyClientBuilder configuration(Configuration configuration)

サービス クライアントの構築中に使用される構成ストアを設定します。 既定の構成ストアは の複製であり、 global configuration storeを使用 NONE して、構築中に構成設定を使用しないようにします。

Parameters:

configuration - 構成の詳細を取得するために使用される構成ストア。

Returns:

更新後の CryptographyClientBuilder オブジェクト。

credential

public CryptographyClientBuilder credential(TokenCredential credential)

サービスに TokenCredential 送信される要求を承認するために使用する を設定します。 型の適切な使用方法の詳細については、Azure SDK for Java の ID と認証 に関するドキュメントを TokenCredential 参照してください。

Parameters:

credential - TokenCredential サービスに送信された要求を承認するために使用されます。

Returns:

更新後の CryptographyClientBuilder オブジェクト。

disableChallengeResourceVerification

public CryptographyClientBuilder disableChallengeResourceVerification()

認証チャレンジ リソースがKey Vaultドメインまたは Managed HSM ドメインと一致するかどうかを検証することを無効にします。 この検証は既定で実行されます。

Returns:

更新後の CryptographyClientBuilder オブジェクト。

httpClient

public CryptographyClientBuilder httpClient(HttpClient client)

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

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

Parameters:

client - HttpClient要求に使用する 。

Returns:

更新後の CryptographyClientBuilder オブジェクト。

httpLogOptions

public CryptographyClientBuilder httpLogOptions(HttpLogOptions logOptions)

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

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

Parameters:

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

Returns:

更新後の CryptographyClientBuilder オブジェクト。

jsonWebKey

public CryptographyClientBuilder jsonWebKey(JsonWebKey jsonWebKey)

JsonWebKeyローカル暗号化操作に使用する を設定します。

が指定されている場合 jsonWebKey 、他のすべてのビルダー設定は無視されます。

Parameters:

jsonWebKey - ローカル暗号化操作に使用する JSON Web キー。

Returns:

更新後の CryptographyClientBuilder オブジェクト。

keyIdentifier

public CryptographyClientBuilder keyIdentifier(String keyId)

暗号化操作に使用する JSON Web キーの Azure Key Vault キー識別子を設定します。 この URL が有効なKey Vaultまたは Managed HSM リソースを参照していることを検証する必要があります。 詳細については、次の ドキュメントを参照 してください。

や などのDecryptVerifyUnwrap操作を実行するときに正しい動作を保証するには、対応する逆操作WrapEncryptに使用CryptographyAsyncClientされた特定のキー バージョン (、または ) に対して、 または CryptographyClientSignを使用することをお勧めします。

Parameters:

keyId - キー コンテナーに格納されている JSON Web キーの Azure Key Vaultキー識別子。

Returns:

更新後の CryptographyClientBuilder オブジェクト。

pipeline

public CryptographyClientBuilder pipeline(HttpPipeline pipeline)

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

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

keyIdentifier(String keyId)が設定されている場合pipeline、 は無視されません。

Parameters:

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

Returns:

更新後の CryptographyClientBuilder オブジェクト。

retryOptions

public CryptographyClientBuilder retryOptions(RetryOptions retryOptions)

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

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

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

Parameters:

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

Returns:

更新後の CryptographyClientBuilder オブジェクト。

retryPolicy

public CryptographyClientBuilder retryPolicy(RetryPolicy retryPolicy)

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

Parameters:

retryPolicy - ユーザーが RetryPolicy 各要求に適用されます。

Returns:

更新後の CryptographyClientBuilder オブジェクト。

serviceVersion

public CryptographyClientBuilder serviceVersion(CryptographyServiceVersion version)

API 要求を CryptographyServiceVersion 行うときに使用する を設定します。

サービス バージョンが指定されていない場合、使用されるサービス バージョンは、使用されているクライアント ライブラリのバージョンに基づく最新の既知のサービス バージョンになります。 サービス バージョンが指定されていない場合、新しいバージョンに更新すると、クライアント ライブラリは新しいサービス バージョンに移行する可能性があります。

Parameters:

version - CryptographyServiceVersion 要求を行うときに使用されるサービスの 。

Returns:

更新後の CryptographyClientBuilder オブジェクト。

適用対象