KeyClientBuilder クラス
- java.
lang. Object - com.
azure. security. keyvault. keys. KeyClientBuilder
- com.
実装
public final class KeyClientBuilder
implements TokenCredentialTrait<KeyClientBuilder>, HttpTrait<KeyClientBuilder>, ConfigurationTrait<KeyClientBuilder>
このクラスは、 と をそれぞれ呼び出buildClient()buildAsyncClient()すことによって、 と のKeyAsyncClientKeyClient構成とインスタンス化を支援する fluent Builder API を提供します。 目的のクライアントのインスタンスを構築します。
をビルドKeyAsyncClientするために必要なKeyClientBuilder最小限の構成オプションは、 と TokenCredentialですvaultUrl。
KeyAsyncClient keyAsyncClient = new KeyClientBuilder()
.vaultUrl("<your-key-vault-url>")
.credential(new DefaultAzureCredentialBuilder().build())
.buildAsyncClient();
では log detail level、複数のカスタム policies とカスタム HttpClient を必要に応じて で KeyClientBuilder構成できます。
KeyAsyncClient keyAsyncClient = new KeyClientBuilder()
.vaultUrl("<your-key-vault-url>")
.credential(new DefaultAzureCredentialBuilder().build())
.httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS))
.httpClient(HttpClient.createDefault())
.buildAsyncClient();
をビルドKeyClientするために必要なKeyClientBuilder最小限の構成オプションは、 と TokenCredentialですvaultUrl。
KeyClient keyClient = new KeyClientBuilder()
.vaultUrl("<your-key-vault-url>")
.credential(new DefaultAzureCredentialBuilder().build())
.buildClient();
コンストラクターの概要
| コンストラクター | 説明 |
|---|---|
| KeyClientBuilder() |
既定値を持つコンストラクター。 |
メソッドの概要
メソッドの継承元: java.lang.Object
コンストラクターの詳細
KeyClientBuilder
public KeyClientBuilder()
既定値を持つコンストラクター。
メソッドの詳細
addPolicy
public KeyClientBuilder addPolicy(HttpPipelinePolicy policy)
HttpPipelinePolicy送信された各要求に適用する を追加します。
メモ： HttpTrait API の優先順位を理解することが重要です。 特に、 が指定されている場合 HttpPipeline 、これは特性内の他のすべての API よりも優先され、無視されます。 が指定されていない HttpPipeline 場合、HTTP パイプラインは、この特性に指定された設定に基づいて内部的に構築されます。 また、 が指定されている場合も無視される、この特性を実装する型には他の API が存在する可能性 HttpPipeline があるため、この特性を実装する型のドキュメントを必ず参照して、影響の完全なセットを理解してください。
Parameters:
Returns:
buildAsyncClient
public KeyAsyncClient buildAsyncClient()
ビルダーで設定された KeyAsyncClient オプションに基づいて を作成します。 buildAsyncClient()が呼び出されるたびに、 のKeyAsyncClient新しいインスタンスが作成されます。
が設定されている場合pipeline(HttpPipeline pipeline)は、 と vaultUrl(String vaultUrl)pipeline を使用して を作成しますKeyClientBuilder。 その他のビルダー設定はすべて無視されます。 が設定されていない場合pipelineは、 をcredential(TokenCredential credential)ビルドKeyAsyncClientするために キー vaultUrl(String vaultUrl) コンテナーの URL が必要です。
Returns:
buildClient
public KeyClient buildClient()
ビルダーで設定された KeyClient オプションに基づいて を作成します。 buildClient()が呼び出されるたびに、 のKeyClient新しいインスタンスが作成されます。
が設定されている場合pipeline(HttpPipeline pipeline)は、 と vaultUrl(String vaultUrl)pipeline を使用して を作成しますKeyClientBuilder。 その他のビルダー設定はすべて無視されます。 が設定されていない場合 pipeline は、 を credential(TokenCredential credential) ビルドするために と vaultUrl(String vaultUrl) が KeyClient必要です。
Returns:
clientOptions
public KeyClientBuilder clientOptions(ClientOptions clientOptions)
アプリケーション ID、ヘッダー、プロキシ構成などの共通プロパティを設定できます。このメソッドは、 クラスのインスタンス (基底クラスの HttpClientOptions サブクラス ClientOptions ) で呼び出することをお勧めします。 HttpClientOptions サブクラスは、HTTP クライアントに適した構成オプションをさらに提供します。これは、この HttpTrait インターフェイスを実装するすべてのクラスに適用できます。
メモ： HttpTrait API の優先順位を理解することが重要です。 特に、 が指定されている場合 HttpPipeline 、これは特性内の他のすべての API よりも優先され、無視されます。 が指定されていない HttpPipeline 場合、HTTP パイプラインは、この特性に指定された設定に基づいて内部的に構築されます。 また、 が指定されている場合も無視される、この特性を実装する型には他の API が存在する可能性 HttpPipeline があるため、この特性を実装する型のドキュメントを必ず参照して、影響の完全なセットを理解してください。
Parameters:
Returns:
configuration
public KeyClientBuilder configuration(Configuration configuration)
サービス クライアントの構築中に使用される構成ストアを設定します。 既定の構成ストアは の複製であり、 global configuration storeを使用 NONE して、構築時に構成設定を使用してバイパスします。
Parameters:
Returns:
credential
public KeyClientBuilder credential(TokenCredential credential)
サービスに TokenCredential 送信された要求を承認するために使用される を設定します。 型の適切な使用方法の詳細については、Azure SDK for Java の ID と認証 に関するドキュメントを TokenCredential 参照してください。
Parameters:
Returns:
disableChallengeResourceVerification
public KeyClientBuilder disableChallengeResourceVerification()
認証チャレンジ リソースがKey Vaultまたはマネージド HSM ドメインと一致するかどうかを検証することを無効にします。 この検証は既定で実行されます。
Returns:
httpClient
public KeyClientBuilder httpClient(HttpClient client)
サービスとの間で HttpClient 要求を送受信するために使用する を設定します。
メモ： HttpTrait API の優先順位を理解することが重要です。 特に、 が指定されている場合 HttpPipeline 、これは特性内の他のすべての API よりも優先され、無視されます。 が指定されていない HttpPipeline 場合、HTTP パイプラインは、この特性に指定された設定に基づいて内部的に構築されます。 また、 が指定されている場合も無視される、この特性を実装する型には他の API が存在する可能性 HttpPipeline があるため、この特性を実装する型のドキュメントを必ず参照して、影響の完全なセットを理解してください。
Parameters:
Returns:
httpLogOptions
public KeyClientBuilder httpLogOptions(HttpLogOptions logOptions)
サービスとの間で HttpLogOptions 要求を送受信するときに使用する を設定します。 が logLevel 指定されていない場合は、 の HttpLogDetailLevel#NONE 既定値が設定されます。
メモ： HttpTrait API の優先順位を理解することが重要です。 特に、 が指定されている場合 HttpPipeline 、これは特性内の他のすべての API よりも優先され、無視されます。 が指定されていない HttpPipeline 場合、HTTP パイプラインは、この特性に指定された設定に基づいて内部的に構築されます。 また、 が指定されている場合 HttpPipeline にも無視されるこの特性を実装する型には他の API が存在する可能性があるため、この特性を実装する型のドキュメントを参照して、影響の完全なセットを理解してください。
Parameters:
Returns:
pipeline
public KeyClientBuilder pipeline(HttpPipeline pipeline)
HttpPipelineサービス クライアントに使用する を設定します。
メモ： HttpTrait API の優先順位を理解することが重要です。 特に、 が指定されている場合 HttpPipeline 、これは特性内の他のすべての API よりも優先され、無視されます。 が指定されていない HttpPipeline 場合、HTTP パイプラインは、この特性に指定された設定に基づいて内部的に構築されます。 また、 が指定されている場合 HttpPipeline にも無視されるこの特性を実装する型には他の API が存在する可能性があるため、この特性を実装する型のドキュメントを参照して、影響の完全なセットを理解してください。
vaultUrl(String vaultUrl)が設定されている場合pipeline、 は無視されません。
Parameters:
Returns:
retryOptions
public KeyClientBuilder retryOptions(RetryOptions retryOptions)
クライアントを RetryOptions 介して行われたすべての要求の を設定します。
メモ： HttpTrait API の優先順位を理解することが重要です。 特に、 が指定されている場合 HttpPipeline 、これは特性内の他のすべての API よりも優先され、無視されます。 が指定されていない HttpPipeline 場合、HTTP パイプラインは、この特性に指定された設定に基づいて内部的に構築されます。 また、 が指定されている場合 HttpPipeline にも無視されるこの特性を実装する型には他の API が存在する可能性があるため、この特性を実装する型のドキュメントを参照して、影響の完全なセットを理解してください。
この設定は、 を使用する場合 retryPolicy(RetryPolicy retryPolicy)と相互に排他的です。
Parameters:
Returns:
retryPolicy
public KeyClientBuilder retryPolicy(RetryPolicy retryPolicy)
各要求が RetryPolicy 送信されるときに使用される を設定します。 既定の再試行ポリシーは、指定されていない場合はパイプラインで使用されます。 この設定は、 を使用する場合 retryOptions(RetryOptions retryOptions)と相互に排他的です。
Parameters:
Returns:
serviceVersion
public KeyClientBuilder serviceVersion(KeyServiceVersion version)
API 要求を KeyServiceVersion 行うときに使用する を設定します。
サービス バージョンが指定されていない場合、使用されるサービス バージョンは、使用されているクライアント ライブラリのバージョンに基づく最新の既知のサービス バージョンになります。 サービス バージョンが指定されていない場合、新しいバージョンに更新すると、クライアント ライブラリは新しいサービス バージョンに移行する可能性があります。
Parameters:
Returns:
vaultUrl
public KeyClientBuilder vaultUrl(String vaultUrl)
HTTP 要求を送信するコンテナー エンドポイント URL を設定します。 この URL が有効なKey Vaultまたは Managed HSM リソースを参照していることを検証する必要があります。 詳細については、次の ドキュメントを参照 してください。
Parameters:
vaultUrl 取得します。
Returns:
適用対象
Azure SDK for Java