Share via


models Paket

Klassen

AdminKeyResult

Antwort, die die primären und sekundären Administrator-API-Schlüssel für einen bestimmten Azure Cognitive Search Dienst enthält.

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

AsyncOperationResult

Die Details eines zeitintensiven asynchronen Freigegebenen Private Link-Ressourcenvorgangs.

CheckNameAvailabilityInput

Eingabe der Verfügbarkeits-API für Überprüfungsnamen.

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

Alle erforderlichen Parameter müssen aufgefüllt werden, um an Azure senden zu können.

CheckNameAvailabilityOutput

Ausgabe der Verfügbarkeits-API für Überprüfungsnamen.

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

CloudErrorBody

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.

DataPlaneAadOrApiKeyAuthOption

Gibt an, dass entweder der API-Schlüssel oder ein Zugriffstoken aus Azure Active Directory für die Authentifizierung verwendet werden kann.

DataPlaneAuthOptions

Definiert die Optionen, wie die Datenebenen-API eines Suchdienst Anforderungen authentifiziert. Dies kann nicht festgelegt werden, wenn "disableLocalAuth" auf "true" festgelegt ist.

EncryptionWithCmk

Beschreibt eine Richtlinie, die bestimmt, wie Ressourcen innerhalb des Suchdiensts mit kundenseitig verwalteten Schlüsseln verschlüsselt werden sollen.

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

Identity

Identität für die Ressource.

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

Alle erforderlichen Parameter müssen aufgefüllt werden, um an Azure senden zu können.

IpRule

Die IP-Einschränkungsregel des Azure Cognitive Search-Diensts.

ListQueryKeysResult

Antwort, die die Abfrage-API-Schlüssel für einen bestimmten Azure Cognitive Search-Dienst enthält.

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

NetworkRuleSet

Netzwerkspezifische Regeln, die bestimmen, wie der Azure Cognitive Search Dienst erreicht werden kann.

Operation

Beschreibt einen REST-API-Vorgang.

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

OperationDisplay

Das -Objekt, das den Vorgang beschreibt.

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

OperationListResult

Das Ergebnis der Anforderung zum Auflisten von REST-API-Vorgängen. Sie enthält eine Liste von Vorgängen und eine URL, um den nächsten Satz von Ergebnissen zu erhalten.

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

PrivateEndpointConnection

Beschreibt eine vorhandene Private Endpunkt-Verbindung mit dem Azure Cognitive Search-Dienst.

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

PrivateEndpointConnectionListResult

Antwort, die eine Liste der Verbindungen mit privaten Endpunkten enthält.

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

PrivateEndpointConnectionProperties

Beschreibt die Eigenschaften einer vorhandenen Privaten Endpunktverbindung mit dem Azure Cognitive Search-Dienst.

PrivateEndpointConnectionPropertiesPrivateEndpoint

Die private Endpunktressource des Microsoft.Network-Anbieters.

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState

Beschreibt den aktuellen Zustand einer vorhandenen Private Link Service-Verbindung mit dem privaten Azure-Endpunkt.

PrivateLinkResource

Beschreibt eine unterstützte Private Link-Ressource für den Azure Cognitive Search-Dienst.

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

PrivateLinkResourceProperties

Beschreibt die Eigenschaften einer unterstützten Private Link-Ressource für den Azure Cognitive Search-Dienst. Für eine bestimmte API-Version stellt dies die "unterstützten" groupIds beim Erstellen einer freigegebenen Private Link-Ressource dar.

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

PrivateLinkResourcesResult

Antwort mit einer Liste der unterstützten Private Link Ressourcen.

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

QueryKey

Beschreibt einen API-Schlüssel für einen bestimmten Azure Cognitive Search Dienst, der nur über Berechtigungen für Abfragevorgänge verfügt.

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

Resource

Allgemeine Felder, die in der Antwort für alle Azure Resource Manager-Ressourcen zurückgegeben werden.

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

SearchManagementRequestOptions

Parametergruppe.

SearchService

Beschreibt einen Azure Cognitive Search Dienst und seinen aktuellen Zustand.

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

Alle erforderlichen Parameter müssen aufgefüllt werden, um an Azure senden zu können.

SearchServiceListResult

Antwort, die eine Liste der Azure Cognitive Search Dienste enthält.

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

SearchServiceUpdate

Die Parameter, die zum Aktualisieren eines Azure Cognitive Search-Diensts verwendet werden.

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

ShareablePrivateLinkResourceProperties

Beschreibt die Eigenschaften eines Ressourcentyps, der in den Private Link-Dienst integriert wurde und von Azure Cognitive Search unterstützt wird.

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

ShareablePrivateLinkResourceType

Beschreibt einen Ressourcentyp, der in den Private Link-Dienst integriert wurde und von Azure Cognitive Search unterstützt wird.

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

SharedPrivateLinkResource

Beschreibt eine freigegebene Private Link-Ressource, die vom Azure Cognitive Search-Dienst verwaltet wird.

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

SharedPrivateLinkResourceListResult

Antwort, die eine Liste der freigegebenen Private Link Ressourcen enthält.

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

SharedPrivateLinkResourceProperties

Beschreibt die Eigenschaften einer vorhandenen shared Private Link-Ressource, die vom Azure Cognitive Search-Dienst verwaltet wird.

Sku

Definiert die SKU eines Azure Cognitive Search-Diensts, der preis- und kapazitätslimits bestimmt.

TrackedResource

Die Ressourcenmodelldefinition für eine Azure-Resource Manager nachverfolgte Ressource der obersten Ebene mit "Tags" und einem "Standort".

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

Zum Senden an Azure müssen alle erforderlichen Parameter aufgefüllt werden.

Enumerationen

AadAuthFailureMode

Beschreibt, welche Antwort die Datenebenen-API eines Suchdienst für Anforderungen sendet, bei denen die Authentifizierung fehlgeschlagen ist.

AdminKeyKind

AdminKeyKind.

HostingMode

Gilt nur für die Standard3-SKU. Sie können diese Eigenschaft so festlegen, dass bis zu 3 Partitionen mit hoher Dichte aktiviert werden, die bis zu 1000 Indizes zulassen, was viel höher ist als die maximal zulässigen Indizes für jede andere SKU. Für die Standard3-SKU ist der Wert entweder "default" oder "highDensity". Für alle anderen SKUs muss dieser Wert "default" sein.

IdentityType

Der Identitätstyp.

PrivateLinkServiceConnectionProvisioningState

Der Bereitstellungsstatus der Private Link-Dienstverbindung. Kann aktualisieren, löschen, fehlgeschlagen, erfolgreich oder unvollständig sein.

PrivateLinkServiceConnectionStatus

Status der Private Link-Dienstverbindung. Kann ausstehend, genehmigt, abgelehnt oder getrennt sein.

ProvisioningState

Der Status des letzten Bereitstellungsvorgangs, der für den Suchdienst ausgeführt wurde. Die Bereitstellung ist ein vorübergehender Zustand während der Einrichtung der Dienstkapazität. Nachdem die Kapazität eingerichtet wurde, ändert sich provisioningState entweder in "succeeded" oder "failed". Clientanwendungen können den Bereitstellungsstatus abfragen (das empfohlene Abrufintervall liegt zwischen 30 Sekunden und einer Minute), indem sie den Suchdienst abrufen-Vorgang verwenden, um zu sehen, wann ein Vorgang abgeschlossen ist. Wenn Sie den kostenlosen Dienst verwenden, wird dieser Wert in der Regel direkt im Aufruf des Suchdiensts erstellen als "erfolgreich" zurückgegeben. Grund hierfür ist, dass der kostenlose Dienst bereits eingerichtete Kapazitäten verwendet.

PublicNetworkAccess

Dieser Wert kann auf "aktiviert" festgelegt werden, um Breaking Changes an vorhandenen Kundenressourcen und -vorlagen zu vermeiden. Wenn diese Einstellung auf "deaktiviert" festgelegt ist, ist datenverkehr über die öffentliche Schnittstelle nicht zulässig, und Verbindungen mit privaten Endpunkten sind die exklusive Zugriffsmethode.

SearchEncryptionComplianceStatus

Beschreibt, ob der Suchdienst in Bezug auf nicht kundenseitig verschlüsselte Ressourcen konform ist. Wenn ein Dienst über mehrere nicht kundenseitig verschlüsselte Ressourcen verfügt und "Erzwingung" aktiviert ist, wird der Dienst als "nicht konform" markiert.

SearchEncryptionWithCmk

Beschreibt, wie ein Suchdienst erzwingen soll, dass mindestens eine nicht kundenseitig verschlüsselte Ressource vorhanden ist.

SearchServiceStatus

Der Status des Suchdiensts. Mögliche Werte sind: "running": Der Suchdienst wird ausgeführt, und es werden keine Bereitstellungsvorgänge ausgeführt. "Bereitstellung": Der Suchdienst wird bereitgestellt oder hoch- oder herunterskaliert. "delete": Der Suchdienst wird gelöscht. "heruntergestuft": Der Suchdienst wird heruntergestuft. Dies kann auftreten, wenn die zugrunde liegenden Sucheinheiten nicht fehlerfrei sind. Der Suchdienst ist höchstwahrscheinlich betriebsbereit, aber die Leistung kann langsam sein, und einige Anforderungen werden möglicherweise gelöscht. "deaktiviert": Der Suchdienst ist deaktiviert. Mit diesem Status lehnt der Dienst alle API-Anforderungen ab. 'error': Der Suchdienst befindet sich in einem Fehlerzustand. Wenn sich Ihr Dienst im Status "Heruntergestuft", "Deaktiviert" oder "Fehler" befindet, bedeutet dies, dass das Azure Cognitive Search Team das zugrunde liegende Problem aktiv untersucht. Dedizierte Dienste mit diesen Status sind weiterhin auf Basis der Anzahl der bereitgestellten Sucheinheiten fakturierbar.

SharedPrivateLinkResourceAsyncOperationResult

Der aktuelle Status des zeitintensiven asynchronen Freigegebenen Private Link-Ressourcenvorgangs.

SharedPrivateLinkResourceProvisioningState

Der Bereitstellungsstatus der freigegebenen Private Link-Ressource. Kann aktualisieren, löschen, fehlgeschlagen, erfolgreich oder unvollständig sein.

SharedPrivateLinkResourceStatus

Status der freigegebenen Private Link-Ressource. Kann ausstehend, genehmigt, abgelehnt oder getrennt sein.

SkuName

Die SKU des Suchdiensts. Gültige Werte sind: "free": Shared service. "basic": Dedizierter Dienst mit bis zu 3 Replikaten. "Standard": Dedizierter Dienst mit bis zu 12 Partitionen und 12 Replikaten. "standard2": Ähnlich wie standard, aber mit mehr Kapazität pro Sucheinheit. "Standard3": Das größte Standardangebot mit bis zu 12 Partitionen und 12 Replikaten (oder bis zu 3 Partitionen mit mehr Indizes, wenn Sie auch die hostingMode-Eigenschaft auf "highDensity" festlegen). 'storage_optimized_l1': Unterstützt 1 TB pro Partition, bis zu 12 Partitionen. 'storage_optimized_l2': Unterstützt 2 TB pro Partition, bis zu 12 Partitionen.'.

UnavailableNameReason

Der Grund, warum der Name nicht verfügbar ist. "Ungültig" gibt an, dass der angegebene Name nicht den Benennungsanforderungen entspricht (falsche Länge, nicht unterstützte Zeichen usw.). "AlreadyExists" gibt an, dass der Name bereits verwendet wird und daher nicht verfügbar ist.