Services - Get
Ruft den Suchdienst mit dem angegebenen Namen in der angegebenen Ressourcengruppe ab.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}?api-version=2024-03-01-preview
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
resource
|
path | True |
string |
Der Name der Ressourcengruppe innerhalb des aktuellen Abonnements. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden. |
search
|
path | True |
string |
Der Name der Azure AI-Suchdienst der angegebenen Ressourcengruppe zugeordnet. RegEx-Muster: |
subscription
|
path | True |
string |
Der eindeutige Bezeichner für ein Microsoft Azure-Abonnement. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden. |
api-version
|
query | True |
string |
Die API-Version, die für jede Anforderung verwendet werden soll. |
Anforderungsheader
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
x-ms-client-request-id |
string uuid |
Ein vom Client generierter GUID-Wert zur Identifizierung dieser Anforderung. Falls angegeben, wird dies in die Antwortinformationen aufgenommen, um die Anforderung nachzuverfolgen. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Die Suchdienstdefinition wurde erfolgreich abgerufen und befindet sich in der Antwort. Wenn Sie den Abschluss eines Bereitstellungs- oder Skalierungsvorgangs abfragen, können Sie dessen status über die provisioningState-Eigenschaft überprüfen. |
|
Other Status Codes |
HTTP 404 (Nicht gefunden): Der Name des Abonnements, der Ressourcengruppe oder des Suchdiensts konnte nicht gefunden werden. |
Sicherheit
azure_auth
Gibt einen impliziten Gewährungsflow an, der auf der Microsoft Identity Platform unterstützt wird.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
SearchGetService
Beispielanforderung
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview
Beispiel für eine Antwort
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
"name": "mysearchservice",
"location": "westus",
"type": "Microsoft.Search/searchServices",
"tags": {
"app-name": "My e-commerce app"
},
"sku": {
"name": "standard"
},
"properties": {
"replicaCount": 3,
"partitionCount": 1,
"status": "running",
"statusDetails": "",
"hostingMode": "default",
"provisioningState": "succeeded",
"publicNetworkAccess": "enabled",
"networkRuleSet": {
"ipRules": [],
"bypass": "None"
},
"privateEndpointConnections": [],
"sharedPrivateLinkResources": [],
"encryptionWithCmk": {
"enforcement": "Unspecified",
"encryptionComplianceStatus": "Compliant"
},
"disableLocalAuth": false,
"authOptions": {
"apiKeyOnly": {}
},
"disabledDataExfiltrationOptions": []
}
}
Definitionen
Name | Beschreibung |
---|---|
Aad |
Beschreibt, welche Antwort die Datenebenen-API eines Suchdiensts für Anforderungen sendet, bei denen die Authentifizierung fehlgeschlagen ist. |
Api |
Gibt an, dass nur der API-Schlüssel für die Authentifizierung verwendet werden kann. |
Cloud |
Enthält Informationen zu einem API-Fehler. |
Cloud |
Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung. |
Data |
Gibt an, dass entweder der API-Schlüssel oder ein Zugriffstoken von einem Microsoft Entra ID Mandanten für die Authentifizierung verwendet werden kann. |
Data |
Definiert die Optionen für die Authentifizierung einer Datenebenenanforderung durch den Suchdienst. Dies kann nicht festgelegt werden, wenn "disableLocalAuth" auf true festgelegt ist. |
Encryption |
Beschreibt eine Richtlinie, die bestimmt, wie Ressourcen innerhalb des Suchdiensts mit kundenseitig verwalteten Schlüsseln verschlüsselt werden sollen. |
Hosting |
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 Identität des Suchdiensts. Ein NULL-Wert gibt an, dass dem Suchdienst keine Identität zugewiesen ist. |
Identity |
Der Identitätstyp, der für die Ressource verwendet wird. Der Typ „SystemAssigned, UserAssigned“ umfasst sowohl eine vom System erstellte Identität als auch einen Satz benutzerseitig zugewiesener Identitäten. Der Typ „None“ entfernt alle Identitäten aus dem Dienst. |
Ip |
Die IP-Einschränkungsregel des Azure AI-Suchdienst. |
Network |
Netzwerkspezifische Regeln, die bestimmen, wie die Azure AI-Suchdienst erreicht werden kann. |
Private |
Die private Endpunktressource des Microsoft.Network-Anbieters. |
Private |
Beschreibt eine vorhandene Verbindung eines privaten Endpunkts mit dem Azure AI-Suchdienst. |
Private |
Beschreibt die Eigenschaften einer vorhandenen privaten Endpunktverbindung mit dem Suchdienst. |
Private |
Der Bereitstellungsstatus der Private Link-Dienstverbindung. Gültige Werte sind Aktualisieren, Löschen, Fehler, Erfolgreich, Unvollständig oder Abgebrochen. |
Private |
Beschreibt den aktuellen Zustand einer vorhandenen Azure Private Link-Dienstverbindung mit dem privaten Endpunkt. |
Private |
Status der Private Link-Dienstverbindung. Gültige Werte sind Ausstehend, Genehmigt, Abgelehnt oder Getrennt. |
Provisioning |
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. |
Public |
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. |
Search |
Mögliche Ursprünge des eingehenden Datenverkehrs, der die im Abschnitt "ipRules" definierten Regeln umgehen kann. |
Search |
Eine Liste von Datenexfiltrationsszenarien, die für den Suchdienst explizit nicht zulässig sind. Derzeit wird nur der Wert "All" unterstützt, um alle möglichen Datenexportszenarien mit differenzierteren Steuerelementen zu deaktivieren, die für die Zukunft geplant sind. |
Search |
Gibt den status der Suchdienstkonformität in Bezug auf objekte ohne CMK-Verschlüsselung zurück. Wenn ein Dienst über mehrere unverschlüsselte Objekte verfügt und die Erzwingung aktiviert ist, wird der Dienst als nicht konform markiert. |
Search |
Beschreibt, wie ein Suchdienst die Compliance erzwingen soll, wenn er Objekte findet, die nicht mit dem kundenseitig verwalteten Schlüssel verschlüsselt sind. |
Search |
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. |
Search |
Beschreibt eine Azure KI-Suchdienst und ihren aktuellen Zustand. |
Search |
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. "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. 'disabled': Der Suchdienst ist deaktiviert. Mit diesem Status lehnt der Dienst alle API-Anforderungen ab. 'error': Der Suchdienst befindet sich in einem Fehlerzustand. "beendet": Der Suchdienst befindet sich in einem abonnement, das deaktiviert ist. Wenn sich Ihr Dienst im Status "Heruntergestuft", "Deaktiviert" oder "Fehler" befindet, bedeutet dies, dass das Azure AI Search-Team das zugrunde liegende Problem aktiv untersucht. Dedizierte Dienste mit diesen Status sind weiterhin auf Basis der Anzahl der bereitgestellten Sucheinheiten fakturierbar. |
Shared |
Beschreibt eine freigegebene Private Link-Ressource, die vom Azure KI-Suchdienst verwaltet wird. |
Shared |
Beschreibt die Eigenschaften einer vorhandenen freigegebenen Privaten Link-Ressource, die vom Azure AI-Suchdienst verwaltet wird. |
Shared |
Der Bereitstellungsstatus der freigegebenen privaten Linkressource. Gültige Werte sind Aktualisieren, Löschen, Fehler, Erfolgreich oder Unvollständig. |
Shared |
Status der freigegebenen Private Link-Ressource. Gültige Werte sind Ausstehend, Genehmigt, Abgelehnt oder Getrennt. |
Sku |
Definiert die SKU eines Suchdiensts, die Die Abrechnungsrate und Kapazitätsgrenzen bestimmt. |
Sku |
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. |
User |
Die Details der benutzerseitig zugewiesenen verwalteten Identität, die dem Suchdienst zugewiesen ist. |
AadAuthFailureMode
Beschreibt, welche Antwort die Datenebenen-API eines Suchdiensts für Anforderungen sendet, bei denen die Authentifizierung fehlgeschlagen ist.
Name | Typ | Beschreibung |
---|---|---|
http401WithBearerChallenge |
string |
Gibt an, dass Anforderungen, bei denen die Authentifizierung fehlgeschlagen ist, mit dem HTTP-status Code 401 (Nicht autorisiert) angezeigt werden soll und eine Bearer Challenge darstellt. |
http403 |
string |
Gibt an, dass Anforderungen, bei denen die Authentifizierung fehlgeschlagen ist, mit dem HTTP-status Code 403 (Verboten) angezeigt werden soll. |
ApiKeyOnly
Gibt an, dass nur der API-Schlüssel für die Authentifizierung verwendet werden kann.
CloudError
Enthält Informationen zu einem API-Fehler.
Name | Typ | Beschreibung |
---|---|---|
error |
Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung. |
|
message |
string |
Eine kurze Beschreibung des Fehlers, die darauf hinweist, was falsch gelaufen ist (details/Debuginformationen finden Sie in der Eigenschaft "error.message"). |
CloudErrorBody
Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Ein Fehlercode, der die Fehlerbedingung genauer beschreibt als ein HTTP-status Code. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln. |
details |
Enthält geschachtelte Fehler, die sich auf diesen Fehler beziehen. |
|
message |
string |
Eine Meldung, die den Fehler detailliert beschreibt und Debuginformationen bereitstellt. |
target |
string |
Das Ziel des bestimmten Fehlers (z. B. der Name der Eigenschaft im Fehler). |
DataPlaneAadOrApiKeyAuthOption
Gibt an, dass entweder der API-Schlüssel oder ein Zugriffstoken von einem Microsoft Entra ID Mandanten für die Authentifizierung verwendet werden kann.
Name | Typ | Beschreibung |
---|---|---|
aadAuthFailureMode |
Beschreibt, welche Antwort die Datenebenen-API eines Suchdiensts für Anforderungen sendet, bei denen die Authentifizierung fehlgeschlagen ist. |
DataPlaneAuthOptions
Definiert die Optionen für die Authentifizierung einer Datenebenenanforderung durch den Suchdienst. Dies kann nicht festgelegt werden, wenn "disableLocalAuth" auf true festgelegt ist.
Name | Typ | Beschreibung |
---|---|---|
aadOrApiKey |
Gibt an, dass entweder der API-Schlüssel oder ein Zugriffstoken von einem Microsoft Entra ID Mandanten für die Authentifizierung verwendet werden kann. |
|
apiKeyOnly |
Gibt an, dass nur der API-Schlüssel für die Authentifizierung verwendet werden kann. |
EncryptionWithCmk
Beschreibt eine Richtlinie, die bestimmt, wie Ressourcen innerhalb des Suchdiensts mit kundenseitig verwalteten Schlüsseln verschlüsselt werden sollen.
Name | Typ | Beschreibung |
---|---|---|
encryptionComplianceStatus |
Gibt den status der Suchdienstkonformität in Bezug auf objekte ohne CMK-Verschlüsselung zurück. Wenn ein Dienst über mehrere unverschlüsselte Objekte verfügt und die Erzwingung aktiviert ist, wird der Dienst als nicht konform markiert. |
|
enforcement |
Beschreibt, wie ein Suchdienst die Compliance erzwingen soll, wenn er Objekte findet, die nicht mit dem kundenseitig verwalteten Schlüssel verschlüsselt sind. |
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.
Name | Typ | Beschreibung |
---|---|---|
default |
string |
Der Grenzwert für die Anzahl von Indizes wird durch die Standardgrenzwerte für die SKU bestimmt. |
highDensity |
string |
Nur Anwendung für die Standard3-SKU, bei der der Suchdienst bis zu 1.000 Indizes aufweisen kann. |
Identity
Details zur Identität des Suchdiensts. Ein NULL-Wert gibt an, dass dem Suchdienst keine Identität zugewiesen ist.
Name | Typ | Beschreibung |
---|---|---|
principalId |
string |
Die Prinzipal-ID der systemseitig zugewiesenen Identität des Suchdiensts. |
tenantId |
string |
Die Mandanten-ID der systemseitig zugewiesenen Identität des Suchdiensts. |
type |
Der Identitätstyp, der für die Ressource verwendet wird. Der Typ „SystemAssigned, UserAssigned“ umfasst sowohl eine vom System erstellte Identität als auch einen Satz benutzerseitig zugewiesener Identitäten. Der Typ „None“ entfernt alle Identitäten aus dem Dienst. |
|
userAssignedIdentities |
<string,
User |
Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs im Format "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". |
IdentityType
Der Identitätstyp, der für die Ressource verwendet wird. Der Typ „SystemAssigned, UserAssigned“ umfasst sowohl eine vom System erstellte Identität als auch einen Satz benutzerseitig zugewiesener Identitäten. Der Typ „None“ entfernt alle Identitäten aus dem Dienst.
Name | Typ | Beschreibung |
---|---|---|
None |
string |
Gibt an, dass jede identität, die dem Suchdienst zugeordnet ist, entfernt werden muss. |
SystemAssigned |
string |
Gibt an, dass die systemseitig zugewiesene Identität für den Suchdienst aktiviert wird. |
SystemAssigned, UserAssigned |
string |
Gibt an, dass die systemseitig zugewiesene Identität für den Suchdienst zusammen mit der Zuweisung einer oder mehrerer benutzerseitig zugewiesener Identitäten aktiviert wird. |
UserAssigned |
string |
Gibt an, dass dem Suchdienst mindestens eine benutzerseitig zugewiesene Identität zugewiesen wird. |
IpRule
Die IP-Einschränkungsregel des Azure AI-Suchdienst.
Name | Typ | Beschreibung |
---|---|---|
value |
string |
Wert, der einer einzelnen IPv4-Adresse (z. B. 123.1.2.3) oder einem IP-Bereich im CIDR-Format (z. B. 123.1.2.3/24) entspricht, darf zulässig sein. |
NetworkRuleSet
Netzwerkspezifische Regeln, die bestimmen, wie die Azure AI-Suchdienst erreicht werden kann.
Name | Typ | Beschreibung |
---|---|---|
bypass |
Mögliche Ursprünge des eingehenden Datenverkehrs, der die im Abschnitt "ipRules" definierten Regeln umgehen kann. |
|
ipRules |
Ip |
Eine Liste von IP-Einschränkungsregeln, die die eingehenden Netzwerke definieren und den Zugriff auf den Suchdienstendpunkt zulassen. In der Zwischenzeit werden alle anderen öffentlichen IP-Netzwerke durch die Firewall blockiert. Diese Einschränkungsregeln werden nur angewendet, wenn "publicNetworkAccess" des Suchdiensts "aktiviert" ist. Andernfalls ist datenverkehr über eine öffentliche Schnittstelle nicht zulässig, auch nicht mit öffentlichen IP-Regeln, und private Endpunktverbindungen wären die exklusive Zugriffsmethode. |
PrivateEndpoint
Die private Endpunktressource des Microsoft.Network-Anbieters.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Die Ressourcen-ID der privaten Endpunktressource des Microsoft.Network-Anbieters. |
PrivateEndpointConnection
Beschreibt eine vorhandene Verbindung eines privaten Endpunkts mit dem Azure AI-Suchdienst.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Der Name der Ressource |
properties |
Beschreibt die Eigenschaften einer vorhandenen privaten Endpunktverbindung mit dem Azure AI-Suchdienst. |
|
type |
string |
Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" |
PrivateEndpointConnectionProperties
Beschreibt die Eigenschaften einer vorhandenen privaten Endpunktverbindung mit dem Suchdienst.
Name | Typ | Beschreibung |
---|---|---|
groupId |
string |
Die Gruppen-ID der Azure-Ressource, für die der Private Link-Dienst verwendet wird. |
privateEndpoint |
Die private Endpunktressource des Microsoft.Network-Anbieters. |
|
privateLinkServiceConnectionState |
Beschreibt den aktuellen Zustand einer vorhandenen Azure Private Link-Dienstverbindung mit dem privaten Endpunkt. |
|
provisioningState |
Der Bereitstellungsstatus der Private Link-Dienstverbindung. Gültige Werte sind Aktualisieren, Löschen, Fehler, Erfolgreich, Unvollständig oder Abgebrochen. |
PrivateLinkServiceConnectionProvisioningState
Der Bereitstellungsstatus der Private Link-Dienstverbindung. Gültige Werte sind Aktualisieren, Löschen, Fehler, Erfolgreich, Unvollständig oder Abgebrochen.
Name | Typ | Beschreibung |
---|---|---|
Canceled |
string |
Die Bereitstellungsanforderung für die Private Link-Dienstverbindungsressource wurde abgebrochen. |
Deleting |
string |
Die Private Link-Dienstverbindung wird gerade gelöscht. |
Failed |
string |
Die Private Link-Dienstverbindung konnte nicht bereitgestellt oder gelöscht werden. |
Incomplete |
string |
Die Bereitstellungsanforderung für die Private Link-Dienstverbindungsressource wurde akzeptiert, aber der Erstellungsprozess wurde noch nicht begonnen. |
Succeeded |
string |
Die Private Link-Dienstverbindung hat die Bereitstellung abgeschlossen und kann genehmigt werden. |
Updating |
string |
Die Private Link-Dienstverbindung wird gerade zusammen mit anderen Ressourcen erstellt, damit sie voll funktionsfähig ist. |
PrivateLinkServiceConnectionState
Beschreibt den aktuellen Zustand einer vorhandenen Azure Private Link-Dienstverbindung mit dem privaten Endpunkt.
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
actionsRequired |
string |
None |
Eine Beschreibung aller zusätzlichen Aktionen, die möglicherweise erforderlich sind. |
description |
string |
Die Beschreibung für den Verbindungsstatus des Private Link-Diensts. |
|
status |
Status der Private Link-Dienstverbindung. Gültige Werte sind Ausstehend, Genehmigt, Abgelehnt oder Getrennt. |
PrivateLinkServiceConnectionStatus
Status der Private Link-Dienstverbindung. Gültige Werte sind Ausstehend, Genehmigt, Abgelehnt oder Getrennt.
Name | Typ | Beschreibung |
---|---|---|
Approved |
string |
Die Verbindung mit dem privaten Endpunkt ist genehmigt und kann verwendet werden. |
Disconnected |
string |
Die Verbindung mit dem privaten Endpunkt wurde aus dem Dienst entfernt. |
Pending |
string |
Die Verbindung zum privaten Endpunkt wurde erstellt und steht noch aus. |
Rejected |
string |
Die Verbindung mit dem privaten Endpunkt wurde abgelehnt und kann nicht verwendet 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.
Name | Typ | Beschreibung |
---|---|---|
failed |
string |
Beim letzten Bereitstellungsvorgang ist ein Fehler aufgetreten. |
provisioning |
string |
Der Suchdienst wird bereitgestellt oder hoch- oder herunterskaliert. |
succeeded |
string |
Der letzte Bereitstellungsvorgang wurde erfolgreich abgeschlossen. |
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.
Name | Typ | Beschreibung |
---|---|---|
disabled |
string |
Auf den Suchdienst kann nicht über Datenverkehr aus dem öffentlichen Internet zugegriffen werden. Der Zugriff ist nur über genehmigte private Endpunktverbindungen zulässig. |
enabled |
string |
Auf den Suchdienst kann über Datenverkehr aus dem öffentlichen Internet zugegriffen werden. |
SearchBypass
Mögliche Ursprünge des eingehenden Datenverkehrs, der die im Abschnitt "ipRules" definierten Regeln umgehen kann.
Name | Typ | Beschreibung |
---|---|---|
AzurePortal |
string |
Gibt an, dass Anforderungen, die vom Azure-Portal stammen, die im Abschnitt "ipRules" definierten Regeln umgehen können. |
None |
string |
Gibt an, dass kein Ursprung die im Abschnitt "ipRules" definierten Regeln umgehen kann. Dies ist die Standardoption. |
SearchDisabledDataExfiltrationOption
Eine Liste von Datenexfiltrationsszenarien, die für den Suchdienst explizit nicht zulässig sind. Derzeit wird nur der Wert "All" unterstützt, um alle möglichen Datenexportszenarien mit differenzierteren Steuerelementen zu deaktivieren, die für die Zukunft geplant sind.
Name | Typ | Beschreibung |
---|---|---|
All |
string |
Gibt an, dass alle Datenexfiltrationsszenarien deaktiviert sind. |
SearchEncryptionComplianceStatus
Gibt den status der Suchdienstkonformität in Bezug auf objekte ohne CMK-Verschlüsselung zurück. Wenn ein Dienst über mehrere unverschlüsselte Objekte verfügt und die Erzwingung aktiviert ist, wird der Dienst als nicht konform markiert.
Name | Typ | Beschreibung |
---|---|---|
Compliant |
string |
Gibt an, dass der Suchdienst kompatibel ist, da die Anzahl der nicht CMK-verschlüsselten Objekte 0 ist oder die Erzwingung deaktiviert ist. |
NonCompliant |
string |
Gibt an, dass der Suchdienst über mehrere nicht CMK-verschlüsselte Objekte verfügt. |
SearchEncryptionWithCmk
Beschreibt, wie ein Suchdienst die Compliance erzwingen soll, wenn er Objekte findet, die nicht mit dem kundenseitig verwalteten Schlüssel verschlüsselt sind.
Name | Typ | Beschreibung |
---|---|---|
Disabled |
string |
Es wird keine Erzwingung der kundenseitig verwalteten Schlüsselverschlüsselung vorgenommen. Es wird nur die integrierte vom Dienst verwaltete Verschlüsselung verwendet. |
Enabled |
string |
Suchdienst werden als nicht konform gekennzeichnet, wenn mindestens ein Objekt nicht mit einem kundenseitig verwalteten Schlüssel verschlüsselt ist. |
Unspecified |
string |
Die Erzwingungsrichtlinie wird nicht explizit angegeben, wobei das Verhalten dasselbe ist, als wäre sie auf "Deaktiviert" festgelegt. |
SearchSemanticSearch
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.
Name | Typ | Beschreibung |
---|---|---|
disabled |
string |
Gibt an, dass der semantische Reranker für den Suchdienst deaktiviert ist. Dies ist die Standardoption. |
free |
string |
Aktiviert semantisches Reranker für einen Suchdienst und gibt an, dass er innerhalb der Grenzen des kostenlosen Plans verwendet werden soll. Der kostenlose Plan würde das Volumen der semantischen Rangfolgeanforderungen begrenzt und wird ohne zusätzliche Kosten angeboten. Dies ist die Standardeinstellung für neu bereitgestellte Suchdienste. |
standard |
string |
Ermöglicht semantisches Reranker für einen Suchdienst als abrechenbares Feature mit höherem Durchsatz und höherem Volumen semantisch neu sortierter Abfragen. |
SearchService
Beschreibt eine Azure KI-Suchdienst und ihren aktuellen Zustand.
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
identity |
Die Identität der Ressource. |
||
location |
string |
Der geografische Standort, an dem sich die Ressource befindet |
|
name |
string |
Der Name der Ressource |
|
properties.authOptions |
Definiert die Optionen, wie die Datenebenen-API eines Suchdiensts Anforderungen authentifiziert. Dies kann nicht festgelegt werden, wenn "disableLocalAuth" auf "true" festgelegt ist. |
||
properties.disableLocalAuth |
boolean |
Wenn diese Einstellung 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. |
|
properties.disabledDataExfiltrationOptions |
Eine Liste von Datenexfiltrationsszenarien, die für den Suchdienst explizit nicht zulässig sind. Derzeit wird nur der Wert "All" unterstützt, um alle möglichen Datenexportszenarien zu deaktivieren, wobei für die Zukunft differenziertere Kontrollen geplant sind. |
||
properties.eTag |
string |
Eine vom System generierte Eigenschaft, die das etag des Diensts darstellt, das für die Steuerung der optimistischen Parallelität während Updates dienen kann. |
|
properties.encryptionWithCmk |
Gibt jede Richtlinie zur Verschlüsselung von Ressourcen (z. B. Indizes) mithilfe von Kunden-Manager-Schlüsseln innerhalb eines Suchdiensts an. |
||
properties.hostingMode | default |
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. |
|
properties.networkRuleSet |
Netzwerkspezifische Regeln, die bestimmen, wie die Azure KI-Suchdienst erreicht werden kann. |
||
properties.partitionCount |
integer |
1 |
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. |
properties.privateEndpointConnections |
Die Liste der privaten Endpunktverbindungen mit dem Azure KI-Suchdienst. |
||
properties.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 die Bereitstellung status abfragen (das empfohlene Abrufintervall liegt zwischen 30 Sekunden und einer Minute), indem sie den Vorgang Suchdienst abrufen 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. |
||
properties.publicNetworkAccess | enabled |
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. |
|
properties.replicaCount |
integer |
1 |
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 einschließlich für die Basis-SKU sein. |
properties.semanticSearch |
Legt Optionen fest, die die Verfügbarkeit der semantischen Suche steuern. Diese Konfiguration ist nur für bestimmte Azure KI Search-SKUs an bestimmten Standorten möglich. |
||
properties.sharedPrivateLinkResources |
Die Liste der freigegebenen Private Link-Ressourcen, die vom Azure KI-Suchdienst verwaltet werden. |
||
properties.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. "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. 'disabled': Der Suchdienst ist deaktiviert. Mit diesem Status lehnt der Dienst alle API-Anforderungen ab. 'error': Der Suchdienst befindet sich in einem Fehlerzustand. "beendet": Der Suchdienst befindet sich in einem abonnement, das deaktiviert ist. Wenn sich Ihr Dienst im Status "Heruntergestuft", "Deaktiviert" oder "Fehler" befindet, bedeutet dies, dass das Azure AI Search-Team das zugrunde liegende Problem aktiv untersucht. Dedizierte Dienste mit diesen Status sind weiterhin auf Basis der Anzahl der bereitgestellten Sucheinheiten fakturierbar. |
||
properties.statusDetails |
string |
Die Details des Suchdiensts status. |
|
sku |
Die SKU des Suchdiensts, die preis- und kapazitätslimits bestimmt. Diese Eigenschaft ist beim Erstellen eines neuen Suchdiensts erforderlich. |
||
tags |
object |
Ressourcentags. |
|
type |
string |
Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" |
SearchServiceStatus
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. "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. 'disabled': Der Suchdienst ist deaktiviert. Mit diesem Status lehnt der Dienst alle API-Anforderungen ab. 'error': Der Suchdienst befindet sich in einem Fehlerzustand. "beendet": Der Suchdienst befindet sich in einem abonnement, das deaktiviert ist. Wenn sich Ihr Dienst im Status "Heruntergestuft", "Deaktiviert" oder "Fehler" befindet, bedeutet dies, dass das Azure AI Search-Team das zugrunde liegende Problem aktiv untersucht. Dedizierte Dienste mit diesen Status sind weiterhin auf Basis der Anzahl der bereitgestellten Sucheinheiten fakturierbar.
Name | Typ | Beschreibung |
---|---|---|
degraded |
string |
Der Suchdienst wird beeinträchtigt, da zugrunde liegende Sucheinheiten nicht fehlerfrei sind. |
deleting |
string |
Der Suchdienst wird gelöscht. |
disabled |
string |
Der Suchdienst ist deaktiviert, und alle API-Anforderungen werden abgelehnt. |
error |
string |
Der Suchdienst befindet sich im Fehlerzustand, der entweder einen Fehler bei der Bereitstellung angibt oder gelöscht werden soll. |
provisioning |
string |
Der Suchdienst wird bereitgestellt oder hoch- oder herunterskaliert. |
running |
string |
Der Suchdienst wird ausgeführt, und es werden keine Bereitstellungsvorgänge ausgeführt. |
stopped |
string |
Der Suchdienst befindet sich in einem abonnement, das deaktiviert ist. |
SharedPrivateLinkResource
Beschreibt eine freigegebene Private Link-Ressource, die vom Azure KI-Suchdienst verwaltet wird.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Der Name der Ressource |
properties |
Beschreibt die Eigenschaften einer freigegebenen privaten Linkressource, die vom Azure KI-Suchdienst verwaltet wird. |
|
type |
string |
Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" |
SharedPrivateLinkResourceProperties
Beschreibt die Eigenschaften einer vorhandenen freigegebenen Privaten Link-Ressource, die vom Azure AI-Suchdienst verwaltet wird.
Name | Typ | Beschreibung |
---|---|---|
groupId |
string |
Die Gruppen-ID des Ressourcenanbieters, für den die freigegebene Private Link-Ressource verwendet wird. |
privateLinkResourceId |
string |
Die Ressourcen-ID der Ressource, für die die freigegebene Private Link-Ressource verwendet wird. |
provisioningState |
Der Bereitstellungsstatus der freigegebenen privaten Linkressource. Gültige Werte sind Aktualisieren, Löschen, Fehler, Erfolgreich oder Unvollständig. |
|
requestMessage |
string |
Die Meldung zum Anfordern der Genehmigung der freigegebenen Privaten Linkressource. |
resourceRegion |
string |
Optional. Kann verwendet werden, um den Azure Resource Manager Speicherort der Ressource anzugeben, für die ein freigegebener privater Link erstellt wird. Dies ist nur für ressourcen erforderlich, deren DNS-Konfiguration regional ist (z. B. Azure Kubernetes Service). |
status |
Status der freigegebenen Private Link-Ressource. Gültige Werte sind Ausstehend, Genehmigt, Abgelehnt oder Getrennt. |
SharedPrivateLinkResourceProvisioningState
Der Bereitstellungsstatus der freigegebenen privaten Linkressource. Gültige Werte sind Aktualisieren, Löschen, Fehler, Erfolgreich oder Unvollständig.
Name | Typ | Beschreibung |
---|---|---|
Deleting |
string |
Die freigegebene Private Link-Ressource wird gerade gelöscht. |
Failed |
string |
Die freigegebene Private Link-Ressource konnte nicht bereitgestellt oder gelöscht werden. |
Incomplete |
string |
Die Bereitstellungsanforderung für die freigegebene Private Link-Ressource wurde akzeptiert, aber der Erstellungsprozess wurde noch nicht begonnen. |
Succeeded |
string |
Die freigegebene Private Link-Ressource hat die Bereitstellung abgeschlossen und kann genehmigt werden. |
Updating |
string |
Die freigegebene Private Link-Ressource wird derzeit zusammen mit anderen Ressourcen erstellt, damit sie voll funktionsfähig ist. |
SharedPrivateLinkResourceStatus
Status der freigegebenen Private Link-Ressource. Gültige Werte sind Ausstehend, Genehmigt, Abgelehnt oder Getrennt.
Name | Typ | Beschreibung |
---|---|---|
Approved |
string |
Die freigegebene Private Link-Ressource ist genehmigt und einsatzbereit. |
Disconnected |
string |
Die freigegebene Private Link-Ressource wurde aus dem Dienst entfernt. |
Pending |
string |
Die freigegebene Private Link-Ressource wurde erstellt und steht noch aus. |
Rejected |
string |
Die freigegebene Private Link-Ressource wurde abgelehnt und kann nicht verwendet werden. |
Sku
Definiert die SKU eines Suchdiensts, die Die Abrechnungsrate und Kapazitätsgrenzen bestimmt.
Name | Typ | Beschreibung |
---|---|---|
name |
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." |
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.
Name | Typ | Beschreibung |
---|---|---|
basic |
string |
Abrechnungsfähiger Tarif für einen dedizierten Dienst mit bis zu 3 Replikaten. |
free |
string |
Free-Tarif ohne SLA-Garantien und eine Teilmenge der Features, die auf abrechenbaren Tarifen angeboten werden. |
standard |
string |
Abrechenbarer Tarif für einen dedizierten Dienst mit bis zu 12 Partitionen und 12 Replikaten. |
standard2 |
string |
Ähnlich wie "Standard", aber mit mehr Kapazität pro Sucheinheit. |
standard3 |
string |
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 |
string |
Abrechenbarer Tarif für einen dedizierten Dienst, der 1 TB pro Partition unterstützt, bis zu 12 Partitionen. |
storage_optimized_l2 |
string |
Abrechenbarer Tarif für einen dedizierten Dienst, der 2 TB pro Partition unterstützt, bis zu 12 Partitionen. |
UserAssignedManagedIdentity
Die Details der benutzerseitig zugewiesenen verwalteten Identität, die dem Suchdienst zugewiesen ist.
Name | Typ | Beschreibung |
---|---|---|
clientId |
string |
Die Client-ID der benutzerseitig zugewiesenen Identität. |
principalId |
string |
Die Prinzipal-ID der benutzerseitig zugewiesenen Identität. |