SearchService interface

Beschreibt einen Azure KI-Suche-Dienst und seinen aktuellen Zustand.

Extends

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 KI-Suche-Diensts.

eTag

Eine vom System generierte Eigenschaft, die das Etag des Diensts darstellt, das für eine optimistische Parallelitätssteuerung bei Updates sein kann.

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 SKU standard3 lautet der Wert entweder "Default" oder "HighDensity". Für alle anderen SKUs muss dieser Wert "Standard" sein.

identity

Die Identität der Ressource.

knowledgeRetrieval

Spezifiziert den Abrechnungsplan für den agentischen Abruf im Azure KI-Suche-Dienst. Diese Konfiguration ist nur für bestimmte Preisstufen in bestimmten Regionen verfügbar.

networkRuleSet

Netzwerkspezifische Regeln, die bestimmen, wie der Azure KI-Suche-Dienst erreicht werden kann.

partitionCount

Die Anzahl der Partitionen im dedizierten 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 KI-Suche-Dienst.

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.

publicNetworkAccess

Dieser Wert kann auf "Aktiviert" festgelegt werden, um Breaking Changes an vorhandenen Kundenressourcen und -vorlagen zu vermeiden. Wenn diese Option 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 Repliken im dedizierten 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

Spezifiziert die Verfügbarkeit und den Abrechnungsplan für die semantische Suche im Azure KI-Suche-Service. Diese Konfiguration ist nur für bestimmte Preisstufen in bestimmten Regionen verfügbar.

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.

sharedPrivateLinkResources

Die Liste der freigegebenen privaten Linkressourcen, die vom Azure KI-Suche-Dienst verwaltet 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 KI-Suche-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.

statusDetails

Die Details des Suchdienststatus.

upgradeAvailable

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

Geerbte Eigenschaften

id

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

Der geografische Standort, an dem sich die Ressource befindet

name

Der Name der Ressource

systemData

Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.

tags

Ressourcentags.

type

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

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

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

endpoint

Der Endpunkt des Azure KI-Suche-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.

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 SKU standard3 lautet der Wert entweder "Default" oder "HighDensity". Für alle anderen SKUs muss dieser Wert "Standard" sein.

hostingMode?: HostingMode

Eigenschaftswert

identity

Die Identität der Ressource.

identity?: Identity

Eigenschaftswert

knowledgeRetrieval

Spezifiziert den Abrechnungsplan für den agentischen Abruf im Azure KI-Suche-Dienst. Diese Konfiguration ist nur für bestimmte Preisstufen in bestimmten Regionen verfügbar.

knowledgeRetrieval?: string

Eigenschaftswert

string

networkRuleSet

Netzwerkspezifische Regeln, die bestimmen, wie der Azure KI-Suche-Dienst erreicht werden kann.

networkRuleSet?: NetworkRuleSet

Eigenschaftswert

partitionCount

Die Anzahl der Partitionen im dedizierten 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 KI-Suche-Dienst.

privateEndpointConnections?: PrivateEndpointConnection[]

Eigenschaftswert

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.

provisioningState?: ProvisioningState

Eigenschaftswert

publicNetworkAccess

Dieser Wert kann auf "Aktiviert" festgelegt werden, um Breaking Changes an vorhandenen Kundenressourcen und -vorlagen zu vermeiden. Wenn diese Option 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 Repliken im dedizierten 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

Spezifiziert die Verfügbarkeit und den Abrechnungsplan für die semantische Suche im Azure KI-Suche-Service. Diese Konfiguration ist nur für bestimmte Preisstufen in bestimmten Regionen verfügbar.

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.

serviceUpgradedAt?: Date

Eigenschaftswert

Date

sharedPrivateLinkResources

Die Liste der freigegebenen privaten Linkressourcen, die vom Azure KI-Suche-Dienst verwaltet werden.

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

Eigenschaftswert

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 KI-Suche-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.

status?: SearchServiceStatus

Eigenschaftswert

statusDetails

Die Details des Suchdienststatus.

statusDetails?: string

Eigenschaftswert

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. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

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

name?: string

Eigenschaftswert

string

geerbt vonTrackedResource.name

systemData

Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.

systemData?: SystemData

Eigenschaftswert

geerbt vonTrackedResource.systemData-

tags

Ressourcentags.

tags?: Record<string, string>

Eigenschaftswert

Record<string, string>

vonTrackedResource.tags geerbt

type

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

type?: string

Eigenschaftswert

string

geerbt vonTrackedResource.type