Freigeben über


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=2023-11-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
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.

searchServiceName
path True

string

Der Name des Suchdiensts, der der angegebenen Ressourcengruppe zugeordnet ist.

subscriptionId
path True

string

Der eindeutige Bezeichner für ein Microsoft Azure-Abonnement. Sie können diesen Wert über die Azure Resource Manager-API, Befehlszeilentools oder das Portal abrufen.

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

SearchService

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

CloudError

HTTP 404 (Nicht gefunden): Der Name des Abonnements, der Ressourcengruppe oder des Suchdiensts konnte nicht gefunden werden.

Sicherheit

azure_auth

Microsoft Entra ID OAuth2-Autorisierungsflow.

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=2023-11-01

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": []
    },
    "privateEndpointConnections": []
  }
}

Definitionen

Name Beschreibung
AadAuthFailureMode

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

ApiKeyOnly

Gibt an, dass nur der API-Schlüssel für die Authentifizierung verwendet werden kann.

CloudError

Enthält Informationen zu einem API-Fehler.

CloudErrorBody

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

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.

DataPlaneAuthOptions

Definiert die Optionen, wie der Suchdienst eine Datenebenenanforderung 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.

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

Identität für die Ressource.

IdentityType

Der Identitätstyp.

IpRule

Die IP-Einschränkungsregel des Suchdiensts.

NetworkRuleSet

Netzwerkspezifische Regeln, die bestimmen, wie der Suchdienst erreicht werden kann.

PrivateEndpoint

Die private Endpunktressource des Microsoft.Network-Anbieters.

PrivateEndpointConnection

Beschreibt eine vorhandene private Endpunktverbindung mit dem Suchdienst.

PrivateEndpointConnectionProperties

Beschreibt die Eigenschaften einer vorhandenen Privaten Endpunktverbindung mit dem Suchdienst.

PrivateLinkServiceConnectionProvisioningState

Der Bereitstellungsstatus der Private Link-Dienstverbindung. Gültige Werte sind Aktualisieren, Löschen, Fehler, Erfolgreich oder Unvollständig.

PrivateLinkServiceConnectionState

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

PrivateLinkServiceConnectionStatus

Status der Private Link-Dienstverbindung. Gültige Werte sind Ausstehend, Genehmigt, Abgelehnt oder Getrennt.

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.

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 kompatibel ist oder nicht. Wenn ein Dienst über mehr als eine nicht kundenseitig verschlüsselte Ressource 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.

SearchSemanticSearch

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

SearchService

Beschreibt einen Suchdienst und seinen aktuellen Zustand.

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. Wenn sich Ihr Dienst im Status "Heruntergestuft", "Deaktiviert" oder "Fehler" befindet, untersucht Microsoft das zugrunde liegende Problem aktiv. Dedizierte Dienste mit diesen Status sind weiterhin auf Basis der Anzahl der bereitgestellten Sucheinheiten fakturierbar.

SharedPrivateLinkResource

Beschreibt eine freigegebene Private Link-Ressource, die vom Suchdienst verwaltet wird.

SharedPrivateLinkResourceProperties

Beschreibt die Eigenschaften einer vorhandenen freigegebenen Private Link Ressource, die vom Suchdienst verwaltet wird.

SharedPrivateLinkResourceProvisioningState

Der Bereitstellungsstatus der freigegebenen privaten Linkressource. Gültige Werte sind Aktualisieren, Löschen, Fehler, Erfolgreich oder Unvollständig.

SharedPrivateLinkResourceStatus

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.

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."

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 und eine Bearer challenge darstellen soll.

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

CloudErrorBody

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

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

CloudErrorBody[]

Enthält geschachtelte Fehler, die sich auf diesen Fehler beziehen.

message

string

Eine Meldung, die den Fehler ausführlich 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

AadAuthFailureMode

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

DataPlaneAuthOptions

Definiert die Optionen, wie der Suchdienst eine Datenebenenanforderung authentifiziert. Dies kann nicht festgelegt werden, wenn "disableLocalAuth" auf "true" festgelegt ist.

Name Typ Beschreibung
aadOrApiKey

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.

apiKeyOnly

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

SearchEncryptionComplianceStatus

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

enforcement

SearchEncryptionWithCmk

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

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

Identität für die Ressource.

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

IdentityType

Der Identitätstyp.

IdentityType

Der Identitätstyp.

Name Typ Beschreibung
None

string

SystemAssigned

string

IpRule

Die IP-Einschränkungsregel des Suchdiensts.

Name Typ Beschreibung
value

string

Der 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.

NetworkRuleSet

Netzwerkspezifische Regeln, die bestimmen, wie der Suchdienst erreicht werden kann.

Name Typ Beschreibung
ipRules

IpRule[]

Eine Liste der IP-Einschränkungsregeln, die für eine IP-Firewall verwendet werden. Alle IP-Adressen, die nicht den Regeln entsprechen, werden von der Firewall blockiert. Diese Regeln werden nur angewendet, wenn "publicNetworkAccess" des Suchdiensts "aktiviert" ist.

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 private Endpunktverbindung mit dem 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

PrivateEndpointConnectionProperties

Beschreibt die Eigenschaften einer vorhandenen privaten Endpunktverbindung mit dem 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 des Ressourcenanbieters, für den die Private Link-Dienstverbindung hergestellt wird.

privateEndpoint

PrivateEndpoint

Die private Endpunktressource des Microsoft.Network-Anbieters.

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

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

provisioningState

PrivateLinkServiceConnectionProvisioningState

Der Bereitstellungsstatus der Private Link-Dienstverbindung. Gültige Werte sind Aktualisieren, Löschen, Fehler, Erfolgreich oder Unvollständig.

PrivateLinkServiceConnectionProvisioningState

Der Bereitstellungsstatus der Private Link-Dienstverbindung. Gültige Werte sind Aktualisieren, Löschen, Fehler, Erfolgreich oder Unvollständig.

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 Private Link Service-Verbindung mit dem privaten Azure-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

PrivateLinkServiceConnectionStatus

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

Name Typ Beschreibung
failed

string

Der letzte Bereitstellungsvorgang ist fehlgeschlagen.

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

enabled

string

SearchEncryptionComplianceStatus

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

Name Typ Beschreibung
Compliant

string

Gibt an, dass der Suchdienst konform ist, da die Anzahl der nicht kundenseitig verschlüsselten Ressourcen null oder die Erzwingung deaktiviert ist.

NonCompliant

string

Gibt an, dass der Suchdienst über mehrere nicht kundenseitig verschlüsselte Ressourcen verfügt.

SearchEncryptionWithCmk

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

Name Typ Beschreibung
Disabled

string

Es wird keine Erzwingung durchgeführt, und der Suchdienst kann über nicht kundenseitig verschlüsselte Ressourcen verfügen.

Enabled

string

Suchdienst wird als nicht konform markiert, wenn mindestens eine nicht kundenseitig verschlüsselte Ressource vorhanden 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 Such-SKUs an bestimmten Speicherorten möglich.

Name Typ Beschreibung
disabled

string

Gibt an, dass die semantische Rangfolge für den Suchdienst deaktiviert ist.

free

string

Aktiviert die semantische Rangfolge für einen Suchdienst und gibt an, dass er innerhalb der Grenzen des free-Tarifs verwendet werden soll. Dies würde das Volumen der semantischen Rangfolgeanforderungen kappen und wird ohne zusätzliche Kosten angeboten. Dies ist die Standardeinstellung für neu bereitgestellte Suchdienste.

standard

string

Ermöglicht die semantische Rangfolge für einen Suchdienst als abrechenbares Feature mit höherem Durchsatz und höherem Volumen an semantischen Rangfolgeanforderungen.

SearchService

Beschreibt einen Suchdienst und seinen 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

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

DataPlaneAuthOptions

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.encryptionWithCmk

EncryptionWithCmk

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

properties.hostingMode

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

NetworkRuleSet

Netzwerkspezifische Regeln, die bestimmen, wie der 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

PrivateEndpointConnection[]

Die Liste der privaten Endpunktverbindungen mit dem Suchdienst.

properties.provisioningState

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

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

SearchSemanticSearch

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

properties.sharedPrivateLinkResources

SharedPrivateLinkResource[]

Die Liste der freigegebenen Private Link-Ressourcen, die vom Suchdienst verwaltet werden.

properties.status

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. Wenn sich Ihr Dienst im Status "Heruntergestuft", "Deaktiviert" oder "Fehler" befindet, untersucht Microsoft das zugrunde liegende Problem aktiv. Dedizierte Dienste mit diesen Status sind weiterhin auf Basis der Anzahl der bereitgestellten Sucheinheiten fakturierbar.

properties.statusDetails

string

Die Details des Suchdiensts status.

sku

Sku

Die SKU des Suchdiensts, die abrechnungs- 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. Wenn sich Ihr Dienst im Status "Heruntergestuft", "Deaktiviert" oder "Fehler" befindet, untersucht Microsoft das zugrunde liegende Problem aktiv. Dedizierte Dienste mit diesen Status sind weiterhin auf Basis der Anzahl der bereitgestellten Sucheinheiten fakturierbar.

Name Typ Beschreibung
degraded

string

Der Suchdienst wird heruntergestuft, 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 auf einen Fehler bei der Bereitstellung oder auf das Löschen hinweist.

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.

SharedPrivateLinkResource

Beschreibt eine freigegebene Private Link-Ressource, die vom 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

SharedPrivateLinkResourceProperties

Beschreibt die Eigenschaften einer freigegebenen Private Link Ressource, die vom 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 Private Link Ressource, die vom 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

SharedPrivateLinkResourceProvisioningState

Der Bereitstellungsstatus der freigegebenen Private Link-Ressource. Gültige Werte sind Aktualisieren, Löschen, Fehler, Erfolgreich oder Unvollständig.

requestMessage

string

Die Anforderungsnachricht zum Anfordern der Genehmigung der freigegebenen Private Link-Ressource.

resourceRegion

string

Optional. Kann verwendet werden, um den Azure Resource Manager Speicherort der Ressource anzugeben, zu der eine freigegebene private Verbindung erstellt werden soll. Dies ist nur für Ressourcen erforderlich, deren DNS-Konfiguration regional ist (z. B. Azure Kubernetes Service).

status

SharedPrivateLinkResourceStatus

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

Failed

string

Incomplete

string

Succeeded

string

Updating

string

SharedPrivateLinkResourceStatus

Status der freigegebenen Private Link-Ressource. Gültige Werte sind Ausstehend, Genehmigt, Abgelehnt oder Getrennt.

Name Typ Beschreibung
Approved

string

Disconnected

string

Pending

string

Rejected

string

Sku

Definiert die SKU eines Suchdiensts, die Die Abrechnungsrate und Kapazitätsgrenzen bestimmt.

Name Typ Beschreibung
name

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."

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

Abrechenbarer 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.