CredentialBuilderBase<T> Klasse

Paket:

com.azure.identity

Maven-Artefakt:

com.azure:azure-identity:1.10.4

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

Typparameter

T

Der Typ des Anmeldeinformations-Generators

Implementiert

HttpTrait<T>

public abstract class CredentialBuilderBase
implements HttpTrait<T>

Die Basisklasse für alle Anmeldeinformations-Generatoren.

Methodenzusammenfassung

Modifizierer und Typ	Methode und Beschreibung
T	addPolicy(HttpPipelinePolicy policy) Fügt eine HttpPipelinePolicy hinzu, die auf jede gesendete Anforderung angewendet werden soll.
T	clientOptions(ClientOptions clientOptions) Ermöglicht das Festlegen allgemeiner Eigenschaften wie Anwendungs-ID, Header, Proxykonfiguration usw.
T	configuration(Configuration configuration) Legt den Konfigurationsspeicher fest, der beim Erstellen der Anmeldeinformationen verwendet wird.
T	enableAccountIdentifierLogging() Ermöglicht die clientseitige Protokollierung von Kontobezeichnern zu Debug-/Überwachungszwecken.
T	httpClient(HttpClient client) Legt den HTTP-Client fest, der zum Senden und Empfangen von Anforderungen an und vom Dienst verwendet werden soll.
T	httpLogOptions(HttpLogOptions logOptions) Legt fest, dass beim HttpLogOptions Senden und Empfangen von Anforderungen an und vom Dienst verwendet werden soll.
T	httpPipeline(HttpPipeline httpPipeline) Als veraltet markiert Diese Methode ist als veraltet markiert. Verwenden Sie stattdessen pipeline(HttpPipeline pipeline). Gibt die Http-Pipelinezum Senden aller Anforderungen an.
T	maxRetry(int maxRetry) Gibt die maximale Anzahl von Wiederholungsversuchen an, wenn bei einer Authentifizierungsanforderung ein Fehler auftritt.
T	pipeline(HttpPipeline pipeline) Legt die fest, die HttpPipeline für den Dienstclient verwendet werden soll.
T	proxyOptions(ProxyOptions proxyOptions) Als veraltet markiert Konfigurieren Sie stattdessen die Proxyoptionen auf dem HttpClient , und legen Sie diesen Client für die Anmeldeinformationen mithilfe von httpClient(HttpClient client)fest. Gibt die Optionen für die Proxykonfiguration an.
T	retryOptions(RetryOptions retryOptions) Legt den RetryOptions für alle Anforderungen fest, die über den Client gesendet werden.
T	retryPolicy(RetryPolicy retryPolicy) Legt den fest, der RetryPolicy verwendet wird, wenn jede Anforderung gesendet wird.
T	retryTimeout(Function<Duration,Duration> retryTimeout) Gibt eine Funktion zum Berechnen von Sekunden des Timeouts für jede wiederholte Anforderung an.

Geerbte Methoden von java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Details zur Methode

addPolicy

public T addPolicy(HttpPipelinePolicy policy)

Fügt eine HttpPipelinePolicy hinzu, die auf jede gesendete Anforderung angewendet werden soll.

Hinweis: Es ist wichtig, die Rangfolge der HttpTrait-APIs zu verstehen. Insbesondere, wenn ein HttpPipeline angegeben wird, hat dies Vorrang vor allen anderen APIs im Trait, und sie werden ignoriert. Wenn nein HttpPipeline angegeben ist, wird eine HTTP-Pipeline intern basierend auf den Einstellungen erstellt, die für dieses Merkmal bereitgestellt werden. Darüber hinaus gibt es möglicherweise andere APIs in Typen, die dieses Merkmal implementieren, die auch ignoriert werden, wenn ein HttpPipeline angegeben ist. Lesen Sie daher unbedingt die Dokumentation der Typen, die dieses Merkmal implementieren, um den vollständigen Satz von Auswirkungen zu verstehen.

Parameters:

policy - einen HttpPipelinePolicy

Returns:

Eine aktualisierte instance dieses Generators mit konfigurierter Richtlinie.

clientOptions

public T clientOptions(ClientOptions clientOptions)

Ermöglicht das Festlegen allgemeiner Eigenschaften wie Anwendungs-ID, Header, Proxykonfiguration usw. Beachten Sie, dass es empfohlen wird, diese Methode mit einem instance der HttpClientOptions -Klasse (einer Unterklasse der ClientOptions Basisklasse) zu aufrufen. Die Unterklasse HttpClientOptions bietet weitere Konfigurationsoptionen, die für HTTP-Clients geeignet sind. Dies gilt für jede Klasse, die diese HttpTrait-Schnittstelle implementiert.

Hinweis: Es ist wichtig, die Rangfolge der HttpTrait-APIs zu verstehen. Insbesondere, wenn ein HttpPipeline angegeben wird, hat dies Vorrang vor allen anderen APIs im Trait, und sie werden ignoriert. Wenn nein HttpPipeline angegeben ist, wird eine HTTP-Pipeline intern basierend auf den Einstellungen erstellt, die für dieses Merkmal bereitgestellt werden. Darüber hinaus gibt es möglicherweise andere APIs in Typen, die dieses Merkmal implementieren, die auch ignoriert werden, wenn ein HttpPipeline angegeben ist. Lesen Sie daher unbedingt die Dokumentation der Typen, die dieses Merkmal implementieren, um den vollständigen Satz von Auswirkungen zu verstehen.

Parameters:

clientOptions - Eine konfigurierte instance von HttpClientOptions.

Returns:

Eine aktualisierte instance dieses Generators mit konfigurierten Clientoptionen.

configuration

public T configuration(Configuration configuration)

Legt den Konfigurationsspeicher fest, der beim Erstellen der Anmeldeinformationen verwendet wird. Der Standardkonfigurationsspeicher ist ein Klon von global configuration store.

Parameters:

configuration - Der Konfigurationsspeicher, der zum Laden von Env-Variablen und/oder -Eigenschaften verwendet wird.

Returns:

Eine aktualisierte instance dieses Generators, wobei der Konfigurationsspeicher wie angegeben festgelegt ist.

enableAccountIdentifierLogging

public T enableAccountIdentifierLogging()

Ermöglicht die clientseitige Protokollierung von Kontobezeichnern zu Debug-/Überwachungszwecken. Sie ist standardmäßig deaktiviert.

Die Kontobezeichnerprotokolle können vertrauliche Informationen enthalten und sollten nur auf geschützten Computern aktiviert werden. Aktivieren dieser Protokolle Anwendungs-ID, Objekt-ID, Mandanten-ID und Benutzerprinzipalname auf INFO-Ebene, wenn ein Zugriffstoken erfolgreich abgerufen wird. Stellen Sie sicher, dass Protokolle der INFO-Ebene aktiviert sind, um die Kontobezeichnerprotokolle anzuzeigen.

Returns:

Eine aktualisierte instance dieses Generators.

httpClient

public T httpClient(HttpClient client)

Legt den HTTP-Client fest, der zum Senden und Empfangen von Anforderungen an und vom Dienst verwendet werden soll.

Parameters:

client - Der HTTP-Client, der für Anforderungen verwendet werden soll.

Returns:

Ein aktualisierter instance dieses Generators mit festgelegtem HTTP-Client.

httpLogOptions

public T httpLogOptions(HttpLogOptions logOptions)

Legt fest, dass beim HttpLogOptions Senden und Empfangen von Anforderungen an und vom Dienst verwendet werden soll. Wenn ein logLevel nicht angegeben ist, wird der Standardwert von HttpLogDetailLevel#NONE festgelegt.

Hinweis: Es ist wichtig, die Rangfolge der HttpTrait-APIs zu verstehen. Insbesondere, wenn ein HttpPipeline angegeben wird, hat dies Vorrang vor allen anderen APIs im Trait, und sie werden ignoriert. Wenn nein HttpPipeline angegeben ist, wird eine HTTP-Pipeline intern basierend auf den Einstellungen erstellt, die für dieses Merkmal bereitgestellt werden. Darüber hinaus gibt es möglicherweise andere APIs in Typen, die dieses Merkmal implementieren, die auch ignoriert werden, wenn ein HttpPipeline angegeben ist. Lesen Sie daher unbedingt die Dokumentation der Typen, die dieses Merkmal implementieren, um den vollständigen Satz von Auswirkungen zu verstehen.

Parameters:

logOptions - Die HttpLogOptions , die beim Senden und Empfangen von Anforderungen an und vom Dienst verwendet werden soll.

Returns:

Eine aktualisierte instance dieses Generators mit konfigurierten HTTP-Protokolloptionen.

httpPipeline

@Deprecated
public T httpPipeline(HttpPipeline httpPipeline)

Als veraltet markiert

Diese Methode ist als veraltet markiert. Verwenden Sie stattdessen pipeline(HttpPipeline pipeline).

Gibt die HttpPipeline zum Senden aller Anforderungen an. Diese Einstellung setzt die anderen außer Kraft.

Parameters:

httpPipeline - die HttpPipeline zum Senden aller Anforderungen

Returns:

Eine aktualisierte instance dieses Generators, wobei die HTTP-Pipeline wie angegeben festgelegt ist.

maxRetry

public T maxRetry(int maxRetry)

Gibt die maximale Anzahl von Wiederholungsversuchen an, wenn bei einer Authentifizierungsanforderung ein Fehler auftritt.

Parameters:

maxRetry - die Anzahl der Wiederholungen

Returns:

Eine aktualisierte instance dieses Generators mit dem angegebenen Maximalen Wiederholungssatz.

pipeline

public T pipeline(HttpPipeline pipeline)

Legt die fest, die HttpPipeline für den Dienstclient verwendet werden soll.

Hinweis: Es ist wichtig, die Rangfolge der HttpTrait-APIs zu verstehen. Insbesondere, wenn ein HttpPipeline angegeben wird, hat dies Vorrang vor allen anderen APIs im Trait, und sie werden ignoriert. Wenn nein HttpPipeline angegeben ist, wird eine HTTP-Pipeline intern basierend auf den Einstellungen erstellt, die für dieses Merkmal bereitgestellt werden. Darüber hinaus gibt es möglicherweise andere APIs in Typen, die dieses Merkmal implementieren, die auch ignoriert werden, wenn ein HttpPipeline angegeben ist. Lesen Sie daher unbedingt die Dokumentation der Typen, die dieses Merkmal implementieren, um den vollständigen Satz von Auswirkungen zu verstehen.

Parameters:

pipeline - HttpPipeline zum Senden von Dienstanforderungen und zum Empfangen von Antworten verwenden.

Returns:

Eine aktualisierte instance dieses Generators, wobei die HTTP-Pipeline wie angegeben festgelegt ist.

proxyOptions

@Deprecated
public T proxyOptions(ProxyOptions proxyOptions)

Als veraltet markiert

Konfigurieren Sie stattdessen die Proxyoptionen auf dem HttpClient , und legen Sie diesen Client für die Anmeldeinformationen mithilfe von httpClient(HttpClient client)fest.

Gibt die Optionen für die Proxykonfiguration an.

Parameters:

proxyOptions - Die Optionen für die Proxykonfiguration

Returns:

Ein aktualisierter instance dieses Generators mit festgelegten Proxyoptionen.

retryOptions

public T retryOptions(RetryOptions retryOptions)

Legt den RetryOptions für alle Anforderungen fest, die über den Client gesendet werden.

Hinweis: Es ist wichtig, die Rangfolge der HttpTrait-APIs zu verstehen. Insbesondere wenn ein HttpPipeline angegeben wird, hat dies Vorrang vor allen anderen APIs in der Eigenschaft, und sie werden ignoriert. Wenn kein HttpPipeline angegeben ist, wird intern eine HTTP-Pipeline basierend auf den Einstellungen erstellt, die für dieses Merkmal bereitgestellt werden. Darüber hinaus können andere APIs in Typen vorhanden sein, die dieses Merkmal implementieren, die auch ignoriert werden, wenn ein HttpPipeline angegeben wird. Lesen Sie daher unbedingt die Dokumentation der Typen, die dieses Merkmal implementieren, um den vollständigen Satz von Auswirkungen zu verstehen.

Das Festlegen dieser Einstellung schließt sich mit gegenseitig retryPolicy(RetryPolicy retryPolicy)aus.

Parameters:

retryOptions - Die RetryOptions , die für alle Anforderungen verwendet werden soll, die über den Client gesendet werden.

Returns:

Eine aktualisierte instance dieses Generators mit den konfigurierten Wiederholungsoptionen.

retryPolicy

public T retryPolicy(RetryPolicy retryPolicy)

Legt den fest, der RetryPolicy verwendet wird, wenn jede Anforderung gesendet wird. Das Festlegen dieser Einstellung schließt sich mit gegenseitig retryOptions(RetryOptions retryOptions)aus. Die Standardwiebelrichtlinie wird in der Pipeline verwendet, sofern nicht angegeben.

Parameters:

retryPolicy - Die Wiederholungsrichtlinie des Benutzers, die auf jede Anforderung angewendet wird.

Returns:

Eine aktualisierte instance dieses Generators mit konfigurierter Wiederholungsrichtlinie.

retryTimeout

public T retryTimeout(Function retryTimeout)

Gibt eine Funktion zum Berechnen von Sekunden des Timeouts für jede wiederholte Anforderung an.

Parameters:

retryTimeout - Die Funktion, die bei der Anzahl der Wiederholungen ein Timeout in Sekunden zurückgibt.

Returns:

Eine aktualisierte instance dieses Generators mit festgelegtem Wiederholungstimeout.