KeyClientBuilder Classe

Paquet:

com.azure.security.keyvault.keys

Artefact Maven:

com.azure:azure-security-keyvault-keys:4.7.3

• java.lang.Object
• • com.azure.security.keyvault.keys.KeyClientBuilder

Implémente

ConfigurationTrait<KeyClientBuilder> HttpTrait<KeyClientBuilder> TokenCredentialTrait<KeyClientBuilder>

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

Cette classe fournit une API Fluent Builder pour faciliter la configuration et l’instanciation de et KeyAsyncClientKeyClient, en appelant buildAsyncClient() et buildClient() respectivement. Il construit une instance du client souhaité.

Les options de configuration minimales requises par KeyClientBuilder pour générer KeyAsyncClient sont vaultUrl et TokenCredential.

KeyAsyncClient keyAsyncClient = new KeyClientBuilder()
     .vaultUrl("<your-key-vault-url>")
     .credential(new DefaultAzureCredentialBuilder().build())
     .buildAsyncClient();

, log detail levelplusieurs personnalisés policies et personnalisés HttpClient peuvent éventuellement être configurés dans .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();

Les options de configuration minimales requises par KeyClientBuilder pour générer KeyClient sont vaultUrl et TokenCredential.

KeyClient keyClient = new KeyClientBuilder()
     .vaultUrl("<your-key-vault-url>")
     .credential(new DefaultAzureCredentialBuilder().build())
     .buildClient();

Récapitulatif du constructeur

Constructeur	Description
KeyClientBuilder()	Constructeur avec les valeurs par défaut.

Résumé de la méthode

Modificateur et type	Méthode et description
KeyClientBuilder	addPolicy(HttpPipelinePolicy policy) Ajoute un HttpPipelinePolicy à appliquer à chaque requête envoyée.
KeyAsyncClient	buildAsyncClient() Crée un en fonction des KeyAsyncClient options définies dans le générateur.
KeyClient	buildClient() Crée un en fonction des KeyClient options définies dans le générateur.
KeyClientBuilder	clientOptions(ClientOptions clientOptions) Permet de définir des propriétés courantes telles que l’ID d’application, les en-têtes, la configuration du proxy, etc.
KeyClientBuilder	configuration(Configuration configuration) Définit le magasin de configuration utilisé pendant la construction du client de service.
KeyClientBuilder	credential(TokenCredential credential) Définit le utilisé pour autoriser les TokenCredential demandes envoyées au service.
KeyClientBuilder	disableChallengeResourceVerification() Désactive la vérification si la ressource de défi d’authentification correspond au domaine Key Vault ou HSM managé.
KeyClientBuilder	httpClient(HttpClient client) Définit le HttpClient à utiliser pour envoyer et recevoir des demandes vers et depuis le service.
KeyClientBuilder	httpLogOptions(HttpLogOptions logOptions) Définit le à utiliser lors de l’envoi HttpLogOptions et de la réception de demandes vers et depuis le service.
KeyClientBuilder	pipeline(HttpPipeline pipeline) Définit le HttpPipeline à utiliser pour le client de service.
KeyClientBuilder	retryOptions(RetryOptions retryOptions) Définit le RetryOptions pour toutes les demandes effectuées via le client.
KeyClientBuilder	retryPolicy(RetryPolicy retryPolicy) Définit le RetryPolicy qui est utilisé lors de l’envoi de chaque requête.
KeyClientBuilder	serviceVersion(KeyServiceVersion version) Définit le KeyServiceVersion qui est utilisé lors de l’envoi de demandes d’API.
KeyClientBuilder	vaultUrl(String vaultUrl) Définit l’URL du point de terminaison du coffre à laquelle envoyer des requêtes HTTP.

Méthodes héritées de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Détails du constructeur

KeyClientBuilder

public KeyClientBuilder()

Constructeur avec les valeurs par défaut.

Détails de la méthode

addPolicy

public KeyClientBuilder addPolicy(HttpPipelinePolicy policy)

Ajoute un HttpPipelinePolicy à appliquer à chaque requête envoyée.

Note: Il est important de comprendre l’ordre de priorité des API HttpTrait. En particulier, si un HttpPipeline est spécifié, cela est prioritaire sur toutes les autres API du trait et elles sont ignorées. Si aucun n’est HttpPipeline spécifié, un pipeline HTTP est construit en interne en fonction des paramètres fournis à cette caractéristique. En outre, il peut y avoir d’autres API dans les types qui implémentent ce trait qui sont également ignorées si un HttpPipeline est spécifié. Veillez donc à vous reporter à la documentation des types qui implémentent ce trait pour comprendre l’ensemble complet des implications.

Parameters:

policy - Un HttpPipelinePolicy.

Returns:

Objet mis à jour KeyClientBuilder .

buildAsyncClient

public KeyAsyncClient buildAsyncClient()

Crée un en fonction des KeyAsyncClient options définies dans le générateur. Chaque fois buildAsyncClient() qu’est appelé, une nouvelle instance de KeyAsyncClient est créée.

Si pipeline(HttpPipeline pipeline) est défini, les pipeline et vaultUrl(String vaultUrl) sont utilisés pour créer le KeyClientBuilder. Tous les autres paramètres du générateur sont ignorés. Si pipeline n’est pas défini, et credential(TokenCredential credential)vaultUrl(String vaultUrl) l’URL du coffre de clés sont nécessaires pour générer le KeyAsyncClient.

Returns:

avec KeyAsyncClient les options définies à partir du générateur.

buildClient

public KeyClient buildClient()

Crée un en fonction des KeyClient options définies dans le générateur. Chaque fois buildClient() qu’est appelé, une nouvelle instance de KeyClient est créée.

Si pipeline(HttpPipeline pipeline) est défini, les pipeline et vaultUrl(String vaultUrl) sont utilisés pour créer le KeyClientBuilder. Tous les autres paramètres du générateur sont ignorés. Si pipeline n’est pas défini, et credential(TokenCredential credential)vaultUrl(String vaultUrl) sont requis pour générer le KeyClient.

Returns:

avec KeyClient les options définies à partir du générateur.

clientOptions

public KeyClientBuilder clientOptions(ClientOptions clientOptions)

Permet de définir des propriétés courantes telles que l’ID d’application, les en-têtes, la configuration du proxy, etc. Notez qu’il est recommandé d’appeler cette méthode avec un instance de la HttpClientOptions classe (une sous-classe de la ClientOptions classe de base). La sous-classe HttpClientOptions fournit davantage d’options de configuration adaptées aux clients HTTP, ce qui s’applique à toute classe qui implémente cette interface HttpTrait.

Note: Il est important de comprendre l’ordre de priorité des API HttpTrait. En particulier, si un HttpPipeline est spécifié, cela est prioritaire sur toutes les autres API du trait et elles sont ignorées. Si aucun n’est HttpPipeline spécifié, un pipeline HTTP est construit en interne en fonction des paramètres fournis à cette caractéristique. En outre, il peut y avoir d’autres API dans les types qui implémentent ce trait qui sont également ignorées si un HttpPipeline est spécifié. Veillez donc à vous reporter à la documentation des types qui implémentent ce trait pour comprendre l’ensemble complet des implications.

Parameters:

clientOptions - Un instance configuré de HttpClientOptions.

Returns:

Objet mis à jour KeyClientBuilder .

configuration

public KeyClientBuilder configuration(Configuration configuration)

Définit le magasin de configuration utilisé pendant la construction du client de service. Le magasin de configuration par défaut est un clone du , utilisez NONE pour contourner l’utilisation des paramètres de configuration pendant la global configuration storeconstruction.

Parameters:

configuration - Magasin de configuration utilisé pour obtenir les détails de la configuration.

Returns:

Objet mis à jour KeyClientBuilder .

credential

public KeyClientBuilder credential(TokenCredential credential)

Définit le utilisé pour autoriser les TokenCredential demandes envoyées au service. Pour plus d’informations sur l’utilisation appropriée du type, consultez la documentation sur l’identité et l’authentification du TokenCredential Kit de développement logiciel (SDK) Azure pour Java.

Parameters:

credential - TokenCredential permet d’autoriser les demandes envoyées au service.

Returns:

Objet mis à jour KeyClientBuilder .

disableChallengeResourceVerification

public KeyClientBuilder disableChallengeResourceVerification()

Désactive la vérification si la ressource de défi d’authentification correspond au domaine Key Vault ou HSM managé. Cette vérification est effectuée par défaut.

Returns:

Objet mis à jour KeyClientBuilder .

httpClient

public KeyClientBuilder httpClient(HttpClient client)

Définit le HttpClient à utiliser pour envoyer et recevoir des demandes vers et depuis le service.

Note: Il est important de comprendre l’ordre de priorité des API HttpTrait. En particulier, si un HttpPipeline est spécifié, cela est prioritaire sur toutes les autres API du trait et elles sont ignorées. Si aucun n’est HttpPipeline spécifié, un pipeline HTTP est construit en interne en fonction des paramètres fournis à cette caractéristique. En outre, il peut y avoir d’autres API dans les types qui implémentent ce trait qui sont également ignorées si un HttpPipeline est spécifié. Veillez donc à vous reporter à la documentation des types qui implémentent ce trait pour comprendre l’ensemble complet des implications.

Parameters:

client - HttpClient à utiliser pour les requêtes.

Returns:

Objet mis à jour KeyClientBuilder .

httpLogOptions

public KeyClientBuilder httpLogOptions(HttpLogOptions logOptions)

Définit le à utiliser lors de l’envoi HttpLogOptions et de la réception de demandes vers et depuis le service. Si un logLevel n’est pas fourni, la valeur par défaut de HttpLogDetailLevel#NONE est définie.

Note: Il est important de comprendre l’ordre de priorité des API HttpTrait. En particulier, si un HttpPipeline est spécifié, cela est prioritaire sur toutes les autres API du trait et elles sont ignorées. Si aucun n’est HttpPipeline spécifié, un pipeline HTTP est construit en interne en fonction des paramètres fournis à cette caractéristique. En outre, il peut y avoir d’autres API dans les types qui implémentent ce trait qui sont également ignorées si un HttpPipeline est spécifié. Veillez donc à vous reporter à la documentation des types qui implémentent ce trait pour comprendre l’ensemble complet des implications.

Parameters:

logOptions - HttpLogOptions à utiliser lors de l’envoi et de la réception de demandes vers et depuis le service.

Returns:

Objet mis à jour KeyClientBuilder .

pipeline

public KeyClientBuilder pipeline(HttpPipeline pipeline)

Définit le HttpPipeline à utiliser pour le client de service.

Note: Il est important de comprendre l’ordre de priorité des API HttpTrait. En particulier, si un HttpPipeline est spécifié, cela est prioritaire sur toutes les autres API du trait et elles sont ignorées. Si aucun n’est HttpPipeline spécifié, un pipeline HTTP est construit en interne en fonction des paramètres fournis à cette caractéristique. En outre, il peut y avoir d’autres API dans les types qui implémentent ce trait qui sont également ignorées si un HttpPipeline est spécifié. Veillez donc à vous reporter à la documentation des types qui implémentent ce trait pour comprendre l’ensemble complet des implications.

Le vaultUrl(String vaultUrl) n’est pas ignoré lorsque pipeline est défini.

Parameters:

pipeline - HttpPipeline à utiliser pour envoyer des demandes de service et recevoir des réponses.

Returns:

Objet mis à jour KeyClientBuilder .

retryOptions

public KeyClientBuilder retryOptions(RetryOptions retryOptions)

Définit le RetryOptions pour toutes les demandes effectuées via le client.

Note: Il est important de comprendre l’ordre de priorité des API HttpTrait. En particulier, si un HttpPipeline est spécifié, cela est prioritaire sur toutes les autres API du trait et elles sont ignorées. Si aucun n’est HttpPipeline spécifié, un pipeline HTTP est construit en interne en fonction des paramètres fournis à cette caractéristique. En outre, il peut y avoir d’autres API dans les types qui implémentent ce trait qui sont également ignorées si un HttpPipeline est spécifié. Veillez donc à vous reporter à la documentation des types qui implémentent ce trait pour comprendre l’ensemble complet des implications.

La définition de ce paramètre s’exclue mutuellement avec l’utilisation de retryPolicy(RetryPolicy retryPolicy).

Parameters:

retryOptions - RetryOptions à utiliser pour toutes les demandes effectuées via le client.

Returns:

Objet mis à jour KeyClientBuilder .

retryPolicy

public KeyClientBuilder retryPolicy(RetryPolicy retryPolicy)

Définit le RetryPolicy qui est utilisé lors de l’envoi de chaque requête. La stratégie de nouvelle tentative par défaut est utilisée dans le pipeline, si elle n’est pas fournie. La définition de ce paramètre s’exclue mutuellement avec l’utilisation de retryOptions(RetryOptions retryOptions).

Parameters:

retryPolicy - stratégie de nouvelle tentative de l’utilisateur appliquée à chaque requête.

Returns:

Objet mis à jour KeyClientBuilder .

serviceVersion

public KeyClientBuilder serviceVersion(KeyServiceVersion version)

Définit le KeyServiceVersion qui est utilisé lors de l’envoi de demandes d’API.

Si aucune version de service n’est fournie, la version de service qui sera utilisée sera la dernière version de service connue en fonction de la version de la bibliothèque cliente utilisée. Si aucune version de service n’est spécifiée, la mise à jour vers une version plus récente de la bibliothèque cliente entraîne potentiellement un déplacement vers une version de service plus récente.

Parameters:

version - KeyServiceVersion du service à utiliser lors de l’envoi de demandes.

Returns:

Objet mis à jour KeyClientBuilder .

vaultUrl

public KeyClientBuilder vaultUrl(String vaultUrl)

Définit l’URL du point de terminaison du coffre à laquelle envoyer des requêtes HTTP. Vous devez vérifier que cette URL fait référence à une ressource Key Vault ou HSM managée valide. Pour plus d’informations, consultez la documentation suivante.

Parameters:

vaultUrl - L’URL du coffre est utilisée comme destination sur Azure pour envoyer des demandes. Si vous avez un identificateur de clé, créez-en un KeyVaultKeyIdentifier pour l’analyser et obtenir les vaultUrl autres informations et .

Returns:

Objet mis à jour KeyClientBuilder .