SearchService interface

Paket:

@azure/arm-search

Beschreibt einen Azure Cognitive Search Dienst und seinen aktuellen Status.

Extends

TrackedResource

Eigenschaften

authOptions	Definiert die Optionen dafür, wie die Datenebenen-API eines Suchdiensts Anforderungen authentifiziert. Dies kann nicht festgelegt werden, wenn "disableLocalAuth" auf true festgelegt ist.
disableLocalAuth	Wenn auf true festgelegt ist, dürfen Aufrufe des Suchdiensts keine API-Schlüssel für die Authentifizierung verwenden. Dies kann nicht auf true festgelegt werden, wenn "dataPlaneAuthOptions" definiert ist.
encryptionWithCmk	Gibt jede Richtlinie zur Verschlüsselung von Ressourcen (z. B. Indizes) mithilfe von Kunden-Manager-Schlüsseln innerhalb eines Suchdiensts an.
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 1.000 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 "standard" sein.
identity	Die Identität der Ressource.
networkRuleSet	Netzwerkspezifische Regeln, die bestimmen, wie der Azure Cognitive Search Dienst erreicht werden kann.
partitionCount	Die Anzahl der Partitionen im Suchdienst; wenn angegeben, kann es 1, 2, 3, 4, 6 oder 12 sein. Werte größer als 1 sind nur für Standard-SKUs gültig. Bei "Standard3"-Diensten, bei denen hostingMode auf "highDensity" festgelegt ist, liegen die zulässigen Werte zwischen 1 und 3.
privateEndpointConnections	Die Liste der privaten Endpunktverbindungen mit dem Azure Cognitive Search-Dienst. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
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 kapazität eingerichtet wurde, ändert sich provisioningState entweder in "erfolgreich" oder "failed". Clientanwendungen können die Bereitstellung status abfragen (das empfohlene Abrufintervall beträgt 30 Sekunden bis eine Minute), indem sie den Vorgang Abrufen des Suchdiensts verwenden, um zu ermitteln, 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. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
publicNetworkAccess	Dieser Wert kann auf "aktiviert" festgelegt werden, um fehlerhafte Änderungen an vorhandenen Kundenressourcen und -vorlagen zu vermeiden. Wenn auf "deaktiviert" festgelegt ist, ist der Datenverkehr über die öffentliche Schnittstelle nicht zulässig, und private Endpunktverbindungen sind die exklusive Zugriffsmethode.
replicaCount	Die Anzahl der Replikate im Suchdienst. Wenn angegeben, muss es sich um einen Wert zwischen 1 und 12 inklusive für Standard-SKUs oder zwischen 1 und 3 inklusive für die Basis-SKU sein.
semanticSearch	Legt Optionen fest, die die Verfügbarkeit der semantischen Suche steuern. Diese Konfiguration ist nur für bestimmte Azure Cognitive Search SKUs an bestimmten Standorten möglich.
sharedPrivateLinkResources	Die Liste der freigegebenen Private Link-Ressourcen, die vom Azure Cognitive Search-Dienst verwaltet werden. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
sku	Die SKU des Suchdiensts, die preis- und kapazitätslimits bestimmt. Diese Eigenschaft ist beim Erstellen eines neuen Suchdiensts erforderlich.
status	Die 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. "löschen": Der Suchdienst wird gelöscht. "degraded": Der Suchdienst ist beeinträchtigt. 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 Fehlerstatus. Wenn sich Ihr Dienst im Status "Degraded", "Disabled" oder "Error" 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. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
statusDetails	Die Details des Suchdiensts status. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

Geerbte Eigenschaften

id	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName} HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
location	Der geografische Standort, an dem sich die Ressource befindet
name	Der Name der Ressource HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
tags	Ressourcentags.
type	Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

Details zur Eigenschaft

authOptions

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

authOptions?: DataPlaneAuthOptions

Eigenschaftswert

DataPlaneAuthOptions

disableLocalAuth

Wenn auf true festgelegt ist, dürfen Aufrufe des Suchdiensts keine API-Schlüssel für die Authentifizierung verwenden. Dies kann nicht auf true festgelegt werden, wenn "dataPlaneAuthOptions" definiert ist.

disableLocalAuth?: boolean

Eigenschaftswert

boolean

encryptionWithCmk

Gibt jede Richtlinie zur Verschlüsselung von Ressourcen (z. B. Indizes) mithilfe von Kunden-Manager-Schlüsseln innerhalb eines Suchdiensts an.

encryptionWithCmk?: EncryptionWithCmk

Eigenschaftswert

EncryptionWithCmk

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 1.000 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 "standard" sein.

hostingMode?: HostingMode

Eigenschaftswert

HostingMode

identity

Die Identität der Ressource.

identity?: Identity

Eigenschaftswert

Identity

networkRuleSet

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

networkRuleSet?: NetworkRuleSet

Eigenschaftswert

NetworkRuleSet

partitionCount

Die Anzahl der Partitionen im Suchdienst; wenn angegeben, kann es 1, 2, 3, 4, 6 oder 12 sein. Werte größer als 1 sind nur für Standard-SKUs gültig. Bei "Standard3"-Diensten, bei denen hostingMode auf "highDensity" festgelegt ist, liegen die zulässigen Werte zwischen 1 und 3.

partitionCount?: number

Eigenschaftswert

number

privateEndpointConnections

Die Liste der privaten Endpunktverbindungen mit dem Azure Cognitive Search-Dienst. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

privateEndpointConnections?: PrivateEndpointConnection[]

Eigenschaftswert

PrivateEndpointConnection[]

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 kapazität eingerichtet wurde, ändert sich provisioningState entweder in "erfolgreich" oder "failed". Clientanwendungen können die Bereitstellung status abfragen (das empfohlene Abrufintervall beträgt 30 Sekunden bis eine Minute), indem sie den Vorgang Abrufen des Suchdiensts verwenden, um zu ermitteln, 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. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

provisioningState?: ProvisioningState

Eigenschaftswert

ProvisioningState

publicNetworkAccess

Dieser Wert kann auf "aktiviert" festgelegt werden, um fehlerhafte Änderungen an vorhandenen Kundenressourcen und -vorlagen zu vermeiden. Wenn auf "deaktiviert" festgelegt ist, ist der Datenverkehr über die öffentliche Schnittstelle nicht zulässig, und private Endpunktverbindungen sind die exklusive Zugriffsmethode.

publicNetworkAccess?: PublicNetworkAccess

Eigenschaftswert

PublicNetworkAccess

replicaCount

Die Anzahl der Replikate im Suchdienst. Wenn angegeben, muss es sich um einen Wert zwischen 1 und 12 inklusive für Standard-SKUs oder zwischen 1 und 3 inklusive für die Basis-SKU sein.

replicaCount?: number

Eigenschaftswert

number

semanticSearch

Legt Optionen fest, die die Verfügbarkeit der semantischen Suche steuern. Diese Konfiguration ist nur für bestimmte Azure Cognitive Search SKUs an bestimmten Standorten möglich.

semanticSearch?: string

Eigenschaftswert

string

sharedPrivateLinkResources

Die Liste der freigegebenen Private Link-Ressourcen, die vom Azure Cognitive Search-Dienst verwaltet werden. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

Eigenschaftswert

SharedPrivateLinkResource[]

sku

Die SKU des Suchdiensts, die preis- und kapazitätslimits bestimmt. Diese Eigenschaft ist beim Erstellen eines neuen Suchdiensts erforderlich.

sku?: Sku

Eigenschaftswert

Sku

status

Die 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. "löschen": Der Suchdienst wird gelöscht. "degraded": Der Suchdienst ist beeinträchtigt. 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 Fehlerstatus. Wenn sich Ihr Dienst im Status "Degraded", "Disabled" oder "Error" 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. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

status?: SearchServiceStatus

Eigenschaftswert

SearchServiceStatus

statusDetails

Die Details des Suchdiensts status. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

statusDetails?: string

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

id

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName} HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

id?: string

Eigenschaftswert

string

Geerbt vonTrackedResource.id

location

Der geografische Standort, an dem sich die Ressource befindet

location: string

Eigenschaftswert

string

Geerbt vonTrackedResource.location

name

Der Name der Ressource HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

name?: string

Eigenschaftswert

string

Geerbt vonTrackedResource.name

tags

Ressourcentags.

tags?: {[propertyName: string]: string}

Eigenschaftswert

{[propertyName: string]: string}

Geerbt vonTrackedResource.tags

type

Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

type?: string

Eigenschaftswert

string

Geerbt vonTrackedResource.type