CredentialBuilderBase<T> Classe

Paquet:

com.azure.identity

Artefact Maven:

com.azure:azure-identity:1.10.4

• java.lang.Object
• • com.azure.identity.CredentialBuilderBase<T>

Paramètres de type

T

type du générateur d’informations d’identification

Implémente

HttpTrait<T>

public abstract class CredentialBuilderBase
implements HttpTrait<T>

Classe de base pour tous les générateurs d’informations d’identification.

Résumé de la méthode

Modificateur et type	Méthode et description
T	addPolicy(HttpPipelinePolicy policy) Ajoute un HttpPipelinePolicy à appliquer à chaque requête envoyée.
T	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.
T	configuration(Configuration configuration) Définit le magasin de configuration utilisé lors de la construction des informations d’identification.
T	enableAccountIdentifierLogging() Permet aux identificateurs de compte d’être connectés côté client à des fins de débogage/surveillance.
T	httpClient(HttpClient client) Définit le client HTTP à utiliser pour envoyer et recevoir des requêtes vers et depuis le service.
T	httpLogOptions(HttpLogOptions logOptions) Définit le à utiliser lors de l’envoi HttpLogOptions et de la réception de demandes vers et depuis le service.
T	httpPipeline(HttpPipeline httpPipeline) Déprécié Cette méthode est déconseillée. Utilisation de pipeline(HttpPipeline pipeline) à la place Spécifie le pipeline Httppour envoyer toutes les requêtes.
T	maxRetry(int maxRetry) Spécifie le nombre maximal de nouvelles tentatives en cas d’échec d’une demande d’authentification.
T	pipeline(HttpPipeline pipeline) Définit le HttpPipeline à utiliser pour le client de service.
T	proxyOptions(ProxyOptions proxyOptions) Déprécié Configurez les options de proxy sur le à la HttpClient place, puis définissez ce client sur les informations d’identification à l’aide httpClient(HttpClient client)de . Spécifie les options de configuration du proxy.
T	retryOptions(RetryOptions retryOptions) Définit le RetryOptions pour toutes les demandes effectuées via le client.
T	retryPolicy(RetryPolicy retryPolicy) Définit le RetryPolicy qui est utilisé lors de l’envoi de chaque requête.
T	retryTimeout(Function<Duration,Duration> retryTimeout) Spécifie une fonction pour calculer le délai d’expiration en secondes sur chaque demande retentée.

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

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Détails de la méthode

addPolicy

public T 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:

Une instance mise à jour de ce générateur avec la stratégie configurée.

clientOptions

public T 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:

Une instance mise à jour de ce générateur avec les options client configurées.

configuration

public T configuration(Configuration configuration)

Définit le magasin de configuration utilisé lors de la construction des informations d’identification. Le magasin de configuration par défaut est un clone du global configuration store.

Parameters:

configuration - Magasin de configuration utilisé pour charger des variables Env et/ou des propriétés à partir de .

Returns:

Une instance mise à jour de ce générateur avec le magasin de configuration défini comme spécifié.

enableAccountIdentifierLogging

public T enableAccountIdentifierLogging()

Permet aux identificateurs de compte d’être connectés côté client à des fins de débogage/surveillance. Elle est désactivée par défaut.

Les journaux d’identification de compte peuvent contenir des informations sensibles et doivent être activés uniquement sur les machines protégées. L’activation de ce journal journalise l’ID d’application, l’ID d’objet, l’ID de locataire et le nom d’utilisateur principal au niveau INFO lorsqu’un jeton d’accès est récupéré avec succès. Vérifiez que les journaux d’activité au niveau INFO sont activés pour afficher les journaux d’identificateur de compte.

Returns:

Mise à jour instance de ce générateur.

httpClient

public T httpClient(HttpClient client)

Définit le client HTTP à utiliser pour envoyer et recevoir des requêtes vers et depuis le service.

Parameters:

client - Client HTTP à utiliser pour les requêtes.

Returns:

Une instance mise à jour de ce générateur avec le client http défini comme spécifié.

httpLogOptions

public T 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:

Mise à jour instance de ce générateur avec les options de journal Http configurées.

httpPipeline

@Deprecated
public T httpPipeline(HttpPipeline httpPipeline)

Déprécié

Cette méthode est déconseillée. Utilisation de pipeline(HttpPipeline pipeline) à la place

Spécifie le httpPipeline à envoyer toutes les requêtes. Ce paramètre remplace les autres.

Parameters:

httpPipeline - HttpPipeline pour envoyer toutes les requêtes

Returns:

Une instance mise à jour de ce générateur avec le pipeline HTTP défini comme spécifié.

maxRetry

public T maxRetry(int maxRetry)

Spécifie le nombre maximal de nouvelles tentatives en cas d’échec d’une demande d’authentification.

Parameters:

maxRetry - nombre de nouvelles tentatives

Returns:

Mise à jour instance de ce générateur avec la nouvelle tentative maximale définie comme spécifié.

pipeline

public T 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.

Parameters:

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

Returns:

Une instance mise à jour de ce générateur avec le pipeline HTTP défini comme spécifié.

proxyOptions

@Deprecated
public T proxyOptions(ProxyOptions proxyOptions)

Déprécié

Configurez les options de proxy sur le à la HttpClient place, puis définissez ce client sur les informations d’identification à l’aide httpClient(HttpClient client)de .

Spécifie les options de configuration du proxy.

Parameters:

proxyOptions - options pour la configuration du proxy

Returns:

Une instance mise à jour de ce générateur avec les options de proxy définies comme spécifié.

retryOptions

public T 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 seront 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és si un HttpPipeline est spécifié. Veillez donc à consulter la documentation des types qui implémentent cette caractéristique pour comprendre l’ensemble complet des implications.

La définition de cette valeur s’exclue mutuellement avec l’utilisation de retryPolicy(RetryPolicy retryPolicy).

Parameters:

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

Returns:

Une instance mise à jour de ce générateur avec les options de nouvelle tentative configurées.

retryPolicy

public T retryPolicy(RetryPolicy retryPolicy)

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

Parameters:

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

Returns:

Une instance mise à jour de ce générateur avec la stratégie de nouvelle tentative configurée.

retryTimeout

public T retryTimeout(Function retryTimeout)

Spécifie une fonction pour calculer le délai d’expiration en secondes sur chaque demande retentée.

Parameters:

retryTimeout - la fonction qui retourne un délai d’expiration en secondes en fonction du nombre de nouvelles tentatives

Returns:

Une instance mise à jour de ce générateur avec le délai d’expiration des nouvelles tentatives défini comme spécifié.