SearchClientOptions Klasse

Definition

Stellt die Clientkonfigurationsoptionen zum Herstellen einer Verbindung mit Azure Cognitive Search bereit.

public class SearchClientOptions : Azure.Core.ClientOptions
type SearchClientOptions = class
    inherit ClientOptions
Public Class SearchClientOptions
Inherits ClientOptions
Vererbung
SearchClientOptions

Konstruktoren

SearchClientOptions(SearchClientOptions+ServiceVersion)

Initialisiert eine neue Instanz der SearchClientOptions-Klasse.

Eigenschaften

Audience

Ruft die Zielgruppe ab, die für die Authentifizierung mit Azure Active Directory (AAD) verwendet werden soll, oder legt sie fest. Die Zielgruppe wird bei verwendung eines gemeinsam verwendeten Schlüssels nicht berücksichtigt.

Diagnostics

Ruft die Clientdiagnoseoptionen ab.

(Geerbt von ClientOptions)
Retry

Ruft die Clientwiebele-Wiederholungsoptionen ab.

(Geerbt von ClientOptions)
RetryPolicy

Ruft die Richtlinie ab, die für Wiederholungsversuche verwendet werden soll, oder legt sie fest. Wenn eine Richtlinie angegeben wird, wird sie anstelle der Retry -Eigenschaft verwendet. Der RetryPolicy Typ kann von abgeleitet werden, um das Standardverhalten zu ändern, ohne die Wiederholungslogik vollständig implementieren zu müssen. Wenn Process(HttpMessage, ReadOnlyMemory<HttpPipelinePolicy>) überschrieben wird oder ein benutzerdefinierter HttpPipelinePolicy Wert angegeben ist, ist es die Verantwortung des Implementierers, die ProcessingContext Werte zu aktualisieren.

(Geerbt von ClientOptions)
Serializer

Ruft einen ObjectSerializer ab, der zum Anpassen der Serialisierung von stark typisierten Modellen verwendet werden kann, oder legt diesen fest. Das Serialisierungsprogramm muss JSON unterstützen und JsonObjectSerializer wird verwendet, wenn kein Wert angegeben wird.

Transport

Die , die HttpPipelineTransport für diesen Client verwendet werden soll. Standardmäßig wird eine instance von verwendetHttpClientTransport.

(Geerbt von ClientOptions)
Version

Ruft die SearchClientOptions.ServiceVersion der Dienst-API ab, die beim Senden von Anforderungen verwendet wird. Weitere Informationen finden Sie unter API-Versionen in Azure Cognitive Search.

Methoden

AddPolicy(HttpPipelinePolicy, HttpPipelinePosition)

Fügt der Clientpipeline eine Richtlinie hinzu HttpPipeline . Die Position der Richtlinie in der Pipeline wird durch den position -Parameter gesteuert. Wenn die Richtlinie einmal pro Clientanforderung ausgeführt werden soll, verwenden PerRetry Sie PerCall andernfalls , um die Richtlinie für jeden Wiederholungsversuch auszuführen. Beachten Sie, dass derselbe instance von policy allen Pipelines des Clients hinzugefügt wird, die mit diesem ClientOptions Objekt erstellt wurden.

(Geerbt von ClientOptions)

Gilt für: