Freigeben über

az search service

  • Referenz

Azure Search-Dienste verwalten.

Befehle

Name Beschreibung Typ Status
az search service create

Erstellen Sie einen Suchdienst in der angegebenen Ressourcengruppe. Wenn der Suchdienst bereits vorhanden ist, werden alle Eigenschaften mit den angegebenen Werten aktualisiert.

 Kern GA
az search service delete

Löschen Sie einen Suchdienst in der angegebenen Ressourcengruppe zusammen mit den zugehörigen Ressourcen.

 Kern GA
az search service list

Ruft eine Liste aller Suchdienste in der angegebenen Ressourcengruppe ab.

 Kern GA
az search service show

Rufen Sie den Suchdienst mit dem angegebenen Namen in der angegebenen Ressourcengruppe ab.

 Kern GA
az search service update

Aktualisieren sie einen Suchdienst in der angegebenen Ressourcengruppe. Wenn der Suchdienst bereits vorhanden ist, werden alle Eigenschaften mit den angegebenen Werten aktualisiert.

 Kern GA
az search service wait

Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung erfüllt ist.

 Kern GA

az search service create

Bearbeiten

Erstellen Sie einen Suchdienst in der angegebenen Ressourcengruppe. Wenn der Suchdienst bereits vorhanden ist, werden alle Eigenschaften mit den angegebenen Werten aktualisiert.

az search service create --name
                         --resource-group
                         --sku {basic, free, standard, standard2, standard3, storage_optimized_l1, storage_optimized_l2}
                         [--aad-auth-failure-mode {http401WithBearerChallenge, http403}]
                         [--auth-options {aadOrApiKey, apiKeyOnly}]
                         [--disable-local-auth {0, 1, f, false, n, no, t, true, y, yes}]
                         [--hosting-mode {default, highDensity}]
                         [--identity-type {None, SystemAssigned}]
                         [--ip-rules]
                         [--location]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--partition-count]
                         [--public-access {disabled, enabled}]
                         [--replica-count]
                         [--semantic-search {disabled, free, standard}]
                         [--tags]

Erforderliche Parameter

--name --search-service-name -n

Der Name des Azure Cognitive Search-Diensts, der erstellt oder aktualisiert werden soll. Suchdienstnamen dürfen nur Kleinbuchstaben, Ziffern oder Striche enthalten, dürfen nicht als die ersten beiden oder letzten Zeichen Striche verwenden, dürfen keine aufeinander folgenden Striche enthalten und müssen zwischen 2 und 60 Zeichen lang sein. Suchdienstnamen müssen global eindeutig sein, da sie Teil des Dienst-URI (https://<name>.search.windows.net) sind. Sie können den Dienstnamen nicht ändern, nachdem der Dienst erstellt wurde.

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--sku

Die SKU des Suchdiensts. Gültige Werte sind: 'free': Gemeinsamer Dienst. "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.'

Zulässige Werte: basic, free, standard, standard2, standard3, storage_optimized_l1, storage_optimized_l2

Optionale Parameter

--aad-auth-failure-mode

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

Zulässige Werte: http401WithBearerChallenge, http403
--auth-options

Einige Hilfe.

Zulässige Werte: aadOrApiKey, apiKeyOnly
--disable-local-auth

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.

Zulässige Werte: 0, 1, f, false, n, no, t, true, y, yes
--hosting-mode

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.

Zulässige Werte: default, highDensity
Standardwert: default
--identity-type

Der Identitätstyp.

Zulässige Werte: None, SystemAssigned
--ip-rules

Einige Hilfe.

--location -l

Der geografische Standort, an dem sich die Ressource befindet, wenn nicht angegeben, wird der Standort der Ressourcengruppe verwendet.

--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

Zulässige Werte: 0, 1, f, false, n, no, t, true, y, yes
--partition-count

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.

Standardwert: 1
--public-access --public-network-access

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.

Zulässige Werte: disabled, enabled
Standardwert: enabled
--replica-count

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.

Standardwert: 1
--semantic-search

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

Zulässige Werte: disabled, free, standard
--tags

Ressourcentags. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

--help -h

Diese Hilfenachricht anzeigen und beenden.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

az search service delete

Bearbeiten

Löschen Sie einen Suchdienst in der angegebenen Ressourcengruppe zusammen mit den zugehörigen Ressourcen.

az search service delete [--ids]
                         [--name]
                         [--resource-group]
                         [--subscription]
                         [--yes]

Optionale Parameter

--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

--name --search-service-name -n

Der Name des Azure Cognitive Search-Diensts, der der angegebenen Ressourcengruppe zugeordnet ist.

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--yes -y

Zur Bestätigung nicht auffordern.

Standardwert: False
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

--help -h

Diese Hilfenachricht anzeigen und beenden.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

az search service list

Bearbeiten

Ruft eine Liste aller Suchdienste in der angegebenen Ressourcengruppe ab.

az search service list --resource-group

Erforderliche Parameter

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

--help -h

Diese Hilfenachricht anzeigen und beenden.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

az search service show

Bearbeiten

Rufen Sie den Suchdienst mit dem angegebenen Namen in der angegebenen Ressourcengruppe ab.

az search service show [--ids]
                       [--name]
                       [--resource-group]
                       [--subscription]

Optionale Parameter

--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

--name --search-service-name -n

Der Name des Azure Cognitive Search-Diensts, der der angegebenen Ressourcengruppe zugeordnet ist.

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

--help -h

Diese Hilfenachricht anzeigen und beenden.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

az search service update

Bearbeiten

Aktualisieren sie einen Suchdienst in der angegebenen Ressourcengruppe. Wenn der Suchdienst bereits vorhanden ist, werden alle Eigenschaften mit den angegebenen Werten aktualisiert.

az search service update [--aad-auth-failure-mode {http401WithBearerChallenge, http403}]
                         [--add]
                         [--auth-options {aadOrApiKey, apiKeyOnly}]
                         [--disable-local-auth {0, 1, f, false, n, no, t, true, y, yes}]
                         [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                         [--identity-type {None, SystemAssigned}]
                         [--ids]
                         [--ip-rules]
                         [--name]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--partition-count]
                         [--public-access {disabled, enabled}]
                         [--remove]
                         [--replica-count]
                         [--resource-group]
                         [--semantic-search {disabled, free, standard}]
                         [--set]
                         [--subscription]
                         [--tags]

Optionale Parameter

--aad-auth-failure-mode

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

Zulässige Werte: http401WithBearerChallenge, http403
--add

Fügen Sie einer Liste von Objekten ein Objekt hinzu, indem Sie ein Pfad- und Schlüsselwertpaar angeben. Beispiel: --add property.listProperty <key=value, string or JSON string>.

--auth-options

Einige Hilfe.

Zulässige Werte: aadOrApiKey, apiKeyOnly
--disable-local-auth

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.

Zulässige Werte: 0, 1, f, false, n, no, t, true, y, yes
--force-string

Wenn Sie "set" oder "add" verwenden, behalten Sie Zeichenfolgenliterale bei, anstatt zu versuchen, in JSON zu konvertieren.

Zulässige Werte: 0, 1, f, false, n, no, t, true, y, yes
--identity-type

Der Identitätstyp.

Zulässige Werte: None, SystemAssigned
--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

--ip-rules

Einige Hilfe.

--name --search-service-name -n

Der Name des Azure Cognitive Search-Diensts, der der angegebenen Ressourcengruppe zugeordnet ist.

--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

Zulässige Werte: 0, 1, f, false, n, no, t, true, y, yes
--partition-count

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.

--public-access --public-network-access

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.

Zulässige Werte: disabled, enabled
--remove

Entfernen sie eine Eigenschaft oder ein Element aus einer Liste. Beispiel: --remove property.list <indexToRemove> ODER --remove propertyToRemove.

--replica-count

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.

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--semantic-search

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

Zulässige Werte: disabled, free, standard
--set

Aktualisieren Sie ein Objekt, indem Sie einen festzulegenden Eigenschaftspfad und -wert angeben. Beispiel: --set property1.property2=<value>.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--tags

Ressourcentags. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

--help -h

Diese Hilfenachricht anzeigen und beenden.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

az search service wait

Bearbeiten

Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung erfüllt ist.

az search service wait [--created]
                       [--custom]
                       [--deleted]
                       [--exists]
                       [--ids]
                       [--interval]
                       [--name]
                       [--resource-group]
                       [--subscription]
                       [--timeout]
                       [--updated]

Optionale Parameter

--created

Warten Sie, bis sie mit 'provisioningState' unter 'Succeeded' erstellt wurde.

Standardwert: False
--custom

Warten Sie, bis die Bedingung eine benutzerdefinierte JMESPath-Abfrage erfüllt. Beispiel: provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Warten Sie, bis sie gelöscht wurde.

Standardwert: False
--exists

Warten Sie, bis die Ressource vorhanden ist.

Standardwert: False
--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

--interval

Abrufintervall in Sekunden.

Standardwert: 30
--name --search-service-name -n

Der Name des Azure Cognitive Search-Diensts, der der angegebenen Ressourcengruppe zugeordnet ist.

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--timeout

Maximale Wartezeit in Sekunden.

Standardwert: 3600
--updated

Warten Sie, bis sie mit provisioningState unter 'Succeeded' aktualisiert wurde.

Standardwert: False
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

--help -h

Diese Hilfenachricht anzeigen und beenden.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.