SearchServiceUpdate interface

Paket:

@azure/arm-search

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

Extends

Resource

Eigenschaften

authOptions	Definiert die Optionen, wie die Datenebenen-API eines Suchdiensts Anforderungen authentifiziert. Dies kann nicht festgelegt werden, wenn "disableLocalAuth" auf "true" festgelegt ist.
computeType	Konfigurieren Sie diese Eigenschaft, um den Suchdienst entweder mit dem Standardmäßigen Compute oder azure Confidential Compute zu unterstützen.
dataExfiltrationProtections	Eine Liste der Datenexfiltrationsszenarien, die explizit für den Suchdienst unzulässig sind. Derzeit ist der einzige unterstützte Wert "Alle", um alle möglichen Datenexportszenarien mit feineren Steuerelementen zu deaktivieren, die für die Zukunft geplant sind.
disableLocalAuth	Wenn dieser Wert 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 eine Richtlinie zur Verschlüsselung von Ressourcen (z. B. Indizes) mithilfe von Kunden-Manager-Schlüsseln innerhalb eines Suchdiensts an.
endpoint	Der Endpunkt des Azure AI Search-Diensts.
eTag	Eine vom System generierte Eigenschaft, die das Etag des Diensts darstellt, das für eine optimistische Parallelitätssteuerung bei Updates sein kann. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
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.
identity	Details zur Suchdienstidentität. Ein Nullwert gibt an, dass dem Suchdienst keine Identität zugewiesen ist.
location	Der geografische Standort der Ressource. Dies muss eine der unterstützten und registrierten Azure-Geo-Regionen sein (z. B. West-USA, Ost-USA, Südostasien usw.). Diese Eigenschaft ist beim Erstellen einer neuen Ressource erforderlich.
networkRuleSet	Netzwerkspezifische Regeln, die bestimmen, wie der Azure AI 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. Für "Standard3"-Dienste mit hostingMode-Wert auf "highDensity" festgelegt, liegen die zulässigen Werte zwischen 1 und 3.
privateEndpointConnections	Die Liste der privaten Endpunktverbindungen mit dem Azure AI Search-Dienst. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er 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 Zwischenzustand, der auftritt, während die Dienstkapazität eingerichtet wird. Nachdem die Kapazität eingerichtet wurde, ändert sich "provisioningState" entweder in "Erfolgreich" oder "Fehlgeschlagen". Clientanwendungen können den Bereitstellungsstatus abfragen (das empfohlene Abrufintervall liegt zwischen 30 Sekunden und einer Minute) mithilfe des Suchdienstvorgangs abrufen, um festzustellen, wann ein Vorgang abgeschlossen ist. Wenn Sie den kostenlosen Dienst verwenden, wird dieser Wert in der Regel als "Erfolgreich" direkt im Aufruf des Create-Suchdiensts zurückgegeben. Dies liegt daran, dass der kostenlose Dienst bereits eingerichtete Kapazität verwendet. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
publicNetworkAccess	Dieser Wert kann auf "aktiviert" festgelegt werden, um änderungen an vorhandenen Kundenressourcen und -vorlagen zu vermeiden. Wenn dieser Wert 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 einschließlich für Standard-SKUs oder zwischen 1 und 3 einschließlich für einfache SKU handeln.
semanticSearch	Legt Optionen fest, die die Verfügbarkeit der semantischen Suche steuern. Diese Konfiguration ist nur für bestimmte Azure AI Search-SKUs an bestimmten Standorten möglich.
serviceUpgradedAt	Das Datum und die Uhrzeit, zu dem der Suchdienst zuletzt aktualisiert wurde. Dieses Feld ist null, bis der Dienst zum ersten Mal aktualisiert wird. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
sharedPrivateLinkResources	Die Liste der freigegebenen privaten Linkressourcen, die vom Azure AI Search-Dienst verwaltet werden. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
sku	Die SKU des Suchdiensts, die Preisniveau- und Kapazitätsgrenzen bestimmt. Diese Eigenschaft ist beim Erstellen eines neuen Suchdiensts erforderlich.
status	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 nach oben oder unten skaliert. 'delete': Der Suchdienst wird gelöscht. "degradiert": Der Suchdienst wird herabgestuft. Dies kann auftreten, wenn die zugrunde liegenden Sucheinheiten nicht fehlerfrei sind. Der Suchdienst ist wahrscheinlich betriebsbereit, die Leistung kann jedoch langsam sein, und einige Anforderungen werden möglicherweise verworfen. 'disabled': Der Suchdienst ist deaktiviert. In diesem Zustand lehnt der Dienst alle API-Anforderungen ab. 'error': Der Suchdienst befindet sich in einem Fehlerstatus. "stopped": Der Suchdienst befindet sich in einem Abonnement, das deaktiviert ist. Wenn sich Ihr Dienst in den Status "Herabgestuft", "deaktiviert" oder "Fehler" befindet, bedeutet dies, dass das Azure AI Search-Team das zugrunde liegende Problem aktiv untersucht. Dedizierte Dienste in diesen Zuständen können weiterhin auf der Grundlage der Anzahl der bereitgestellten Sucheinheiten berechnet werden. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
statusDetails	Die Details des Suchdienststatus. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
tags	Tags zum Kategorisieren der Ressource im Azure-Portal.
upgradeAvailable	Gibt an, ob der Suchdienst über ein Upgrade verfügt.

Geerbte Eigenschaften

id	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
name	Der Name der RessourcenHINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
type	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts": Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

Details zur Eigenschaft

authOptions

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

authOptions?: DataPlaneAuthOptions

Eigenschaftswert

DataPlaneAuthOptions

computeType

Konfigurieren Sie diese Eigenschaft, um den Suchdienst entweder mit dem Standardmäßigen Compute oder azure Confidential Compute zu unterstützen.

computeType?: string

Eigenschaftswert

string

dataExfiltrationProtections

Eine Liste der Datenexfiltrationsszenarien, die explizit für den Suchdienst unzulässig sind. Derzeit ist der einzige unterstützte Wert "Alle", um alle möglichen Datenexportszenarien mit feineren Steuerelementen zu deaktivieren, die für die Zukunft geplant sind.

dataExfiltrationProtections?: string[]

Eigenschaftswert

string[]

disableLocalAuth

Wenn dieser Wert 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 eine Richtlinie zur Verschlüsselung von Ressourcen (z. B. Indizes) mithilfe von Kunden-Manager-Schlüsseln innerhalb eines Suchdiensts an.

encryptionWithCmk?: EncryptionWithCmk

Eigenschaftswert

EncryptionWithCmk

endpoint

Der Endpunkt des Azure AI Search-Diensts.

endpoint?: string

Eigenschaftswert

string

eTag

Eine vom System generierte Eigenschaft, die das Etag des Diensts darstellt, das für eine optimistische Parallelitätssteuerung bei Updates sein kann. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

eTag?: string

Eigenschaftswert

string

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.

hostingMode?: HostingMode

Eigenschaftswert

HostingMode

identity

Details zur Suchdienstidentität. Ein Nullwert gibt an, dass dem Suchdienst keine Identität zugewiesen ist.

identity?: Identity

Eigenschaftswert

Identity

location

Der geografische Standort der Ressource. Dies muss eine der unterstützten und registrierten Azure-Geo-Regionen sein (z. B. West-USA, Ost-USA, Südostasien usw.). Diese Eigenschaft ist beim Erstellen einer neuen Ressource erforderlich.

location?: string

Eigenschaftswert

string

networkRuleSet

Netzwerkspezifische Regeln, die bestimmen, wie der Azure AI 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. Für "Standard3"-Dienste mit hostingMode-Wert auf "highDensity" festgelegt, liegen die zulässigen Werte zwischen 1 und 3.

partitionCount?: number

Eigenschaftswert

number

privateEndpointConnections

Die Liste der privaten Endpunktverbindungen mit dem Azure AI Search-Dienst. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er 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 Zwischenzustand, der auftritt, während die Dienstkapazität eingerichtet wird. Nachdem die Kapazität eingerichtet wurde, ändert sich "provisioningState" entweder in "Erfolgreich" oder "Fehlgeschlagen". Clientanwendungen können den Bereitstellungsstatus abfragen (das empfohlene Abrufintervall liegt zwischen 30 Sekunden und einer Minute) mithilfe des Suchdienstvorgangs abrufen, um festzustellen, wann ein Vorgang abgeschlossen ist. Wenn Sie den kostenlosen Dienst verwenden, wird dieser Wert in der Regel als "Erfolgreich" direkt im Aufruf des Create-Suchdiensts zurückgegeben. Dies liegt daran, dass der kostenlose Dienst bereits eingerichtete Kapazität verwendet. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

provisioningState?: ProvisioningState

Eigenschaftswert

ProvisioningState

publicNetworkAccess

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

publicNetworkAccess?: string

Eigenschaftswert

string

replicaCount

Die Anzahl der Replikate im Suchdienst. Wenn angegeben, muss es sich um einen Wert zwischen 1 und 12 einschließlich für Standard-SKUs oder zwischen 1 und 3 einschließlich für einfache SKU handeln.

replicaCount?: number

Eigenschaftswert

number

semanticSearch

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

semanticSearch?: string

Eigenschaftswert

string

serviceUpgradedAt

Das Datum und die Uhrzeit, zu dem der Suchdienst zuletzt aktualisiert wurde. Dieses Feld ist null, bis der Dienst zum ersten Mal aktualisiert wird. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

serviceUpgradedAt?: Date

Eigenschaftswert

Date

sharedPrivateLinkResources

Die Liste der freigegebenen privaten Linkressourcen, die vom Azure AI Search-Dienst verwaltet werden. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

Eigenschaftswert

SharedPrivateLinkResource[]

sku

Die SKU des Suchdiensts, die Preisniveau- und Kapazitätsgrenzen bestimmt. Diese Eigenschaft ist beim Erstellen eines neuen Suchdiensts erforderlich.

sku?: Sku

Eigenschaftswert

Sku

status

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 nach oben oder unten skaliert. 'delete': Der Suchdienst wird gelöscht. "degradiert": Der Suchdienst wird herabgestuft. Dies kann auftreten, wenn die zugrunde liegenden Sucheinheiten nicht fehlerfrei sind. Der Suchdienst ist wahrscheinlich betriebsbereit, die Leistung kann jedoch langsam sein, und einige Anforderungen werden möglicherweise verworfen. 'disabled': Der Suchdienst ist deaktiviert. In diesem Zustand lehnt der Dienst alle API-Anforderungen ab. 'error': Der Suchdienst befindet sich in einem Fehlerstatus. "stopped": Der Suchdienst befindet sich in einem Abonnement, das deaktiviert ist. Wenn sich Ihr Dienst in den Status "Herabgestuft", "deaktiviert" oder "Fehler" befindet, bedeutet dies, dass das Azure AI Search-Team das zugrunde liegende Problem aktiv untersucht. Dedizierte Dienste in diesen Zuständen können weiterhin auf der Grundlage der Anzahl der bereitgestellten Sucheinheiten berechnet werden. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

status?: SearchServiceStatus

Eigenschaftswert

SearchServiceStatus

statusDetails

Die Details des Suchdienststatus. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

statusDetails?: string

Eigenschaftswert

string

tags

Tags zum Kategorisieren der Ressource im Azure-Portal.

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

Eigenschaftswert

{[propertyName: string]: string}

upgradeAvailable

Gibt an, ob der Suchdienst über ein Upgrade verfügt.

upgradeAvailable?: string

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

id

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

id?: string

Eigenschaftswert

string

geerbt vonResource.id

name

Der Name der RessourcenHINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

name?: string

Eigenschaftswert

string

geerbt vonResource.name

systemData

Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

systemData?: SystemData

Eigenschaftswert

SystemData

Geerbt vonResource.systemData-

type

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

type?: string

Eigenschaftswert

string

vonResource.type geerbt