Dela via

az search service

  • Referens

Hantera Azure Search-tjänster.

Kommandon

Name Description Typ Status
az search service create

Skapa en söktjänst i den angivna resursgruppen. Om söktjänsten redan finns uppdateras alla egenskaper med angivna värden.

 Kärna GA
az search service delete

Ta bort en söktjänst i den angivna resursgruppen tillsammans med dess associerade resurser.

 Kärna GA
az search service list

Hämtar en lista över alla söktjänster i den angivna resursgruppen.

 Kärna GA
az search service show

Hämta söktjänsten med det angivna namnet i den angivna resursgruppen.

 Kärna GA
az search service update

Uppdatera en söktjänst i den angivna resursgruppen. Om söktjänsten redan finns uppdateras alla egenskaper med angivna värden.

 Kärna GA
az search service wait

Placera CLI i vänteläge tills ett villkor uppfylls.

 Kärna GA

az search service create

Redigera

Skapa en söktjänst i den angivna resursgruppen. Om söktjänsten redan finns uppdateras alla egenskaper med angivna värden.

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]

Obligatoriska parametrar

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

Namnet på Azure Cognitive Search-tjänsten som ska skapas eller uppdateras. Söktjänstnamn får endast innehålla gemener, siffror eller bindestreck, kan inte använda bindestreck som de två första eller sista tecknen, får inte innehålla på varandra följande bindestreck och måste vara mellan 2 och 60 tecken långa. Söktjänstnamn måste vara globalt unika eftersom de ingår i tjänstens URI (https://<name>.search.windows.net). Du kan inte ändra tjänstnamnet när tjänsten har skapats.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--sku

SKU:n för söktjänsten. Giltiga värden är: "kostnadsfri": Delad tjänst. "basic": Dedikerad tjänst med upp till 3 repliker. Standard: Dedikerad tjänst med upp till 12 partitioner och 12 repliker. "standard2": Liknar standard, men med mer kapacitet per sökenhet. "standard3": Det största standarderbjudandet med upp till 12 partitioner och 12 repliker (eller upp till 3 partitioner med fler index om du också ställer in egenskapen hostingMode till "highDensity"). "storage_optimized_l1": Stöder 1 TB per partition, upp till 12 partitioner. "storage_optimized_l2": Stöder 2 TB per partition, upp till 12 partitioner.

Godkända värden: basic, free, standard, standard2, standard3, storage_optimized_l1, storage_optimized_l2

Valfria parametrar

--aad-auth-failure-mode

Beskriver vilket svar dataplanets API för en söktjänst skulle skicka för begäranden som misslyckades med autentiseringen.

Godkända värden: http401WithBearerChallenge, http403
--auth-options

Lite hjälp.

Godkända värden: aadOrApiKey, apiKeyOnly
--disable-local-auth

När värdet är true tillåts inte anrop till söktjänsten att använda API-nycklar för autentisering. Detta kan inte anges till sant om "dataPlaneAuthOptions" har definierats.

Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--hosting-mode

Gäller endast för standard3 SKU. Du kan ställa in den här egenskapen för att aktivera upp till 3 partitioner med hög densitet som tillåter upp till 1 000 index, vilket är mycket högre än de högsta index som tillåts för andra SKU:er. För SKU:n standard3 är värdet antingen "default" eller "highDensity". För alla andra SKU:er måste det här värdet vara "standard".

Godkända värden: default, highDensity
Standardvärde: default
--identity-type

Identitetstypen.

Godkända värden: None, SystemAssigned
--ip-rules

Lite hjälp.

--location -l

Den geo-plats där resursen finns När den inte anges används platsen för resursgruppen.

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--partition-count

Antalet partitioner i söktjänsten. Om det anges kan det vara 1, 2, 3, 4, 6 eller 12. Värden som är större än 1 är endast giltiga för standard-SKU:er. För "standard3"-tjänster med hostingMode inställt på "highDensity" är de tillåtna värdena mellan 1 och 3.

Standardvärde: 1
--public-access --public-network-access

Det här värdet kan anges till "aktiverat" för att undvika icke-bakåtkompatibla ändringar av befintliga kundresurser och mallar. Om inställningen är "inaktiverad" tillåts inte trafik via det offentliga gränssnittet och privata slutpunktsanslutningar är den exklusiva åtkomstmetoden.

Godkända värden: disabled, enabled
Standardvärde: enabled
--replica-count

Antalet repliker i söktjänsten. Om det anges måste det vara ett värde mellan 1 och 12 inklusive för standard-SKU:er eller mellan 1 och 3 inklusive för grundläggande SKU.

Standardvärde: 1
--semantic-search

Anger alternativ som styr tillgängligheten för semantisk sökning. Den här konfigurationen är endast möjlig för vissa Azure Cognitive Search-SKU:er på vissa platser.

Godkända värden: disabled, free, standard
--tags

Resurstaggar. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer information och exempel finns i http://jmespath.org/.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az search service delete

Redigera

Ta bort en söktjänst i den angivna resursgruppen tillsammans med dess associerade resurser.

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

Valfria parametrar

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

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

Namnet på azure cognitive search-tjänsten som är associerad med den angivna resursgruppen.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--yes -y

Fråga inte efter bekräftelse.

Standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer information och exempel finns i http://jmespath.org/.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az search service list

Redigera

Hämtar en lista över alla söktjänster i den angivna resursgruppen.

az search service list --resource-group

Obligatoriska parametrar

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer information och exempel finns i http://jmespath.org/.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az search service show

Redigera

Hämta söktjänsten med det angivna namnet i den angivna resursgruppen.

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

Valfria parametrar

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

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

Namnet på azure cognitive search-tjänsten som är associerad med den angivna resursgruppen.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer information och exempel finns i http://jmespath.org/.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az search service update

Redigera

Uppdatera en söktjänst i den angivna resursgruppen. Om söktjänsten redan finns uppdateras alla egenskaper med angivna värden.

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]

Valfria parametrar

--aad-auth-failure-mode

Beskriver vilket svar dataplanets API för en söktjänst skulle skicka för begäranden som misslyckades med autentiseringen.

Godkända värden: http401WithBearerChallenge, http403
--add

Lägg till ett objekt i en lista över objekt genom att ange en sökväg och nyckelvärdepar. Exempel: --add property.listProperty <key=value, string or JSON string>.

--auth-options

Lite hjälp.

Godkända värden: aadOrApiKey, apiKeyOnly
--disable-local-auth

När värdet är true tillåts inte anrop till söktjänsten att använda API-nycklar för autentisering. Detta kan inte anges till sant om "dataPlaneAuthOptions" har definierats.

Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--force-string

När du använder "set" eller "add" bevarar du strängliteraler i stället för att försöka konvertera till JSON.

Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--identity-type

Identitetstypen.

Godkända värden: None, SystemAssigned
--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--ip-rules

Lite hjälp.

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

Namnet på azure cognitive search-tjänsten som är associerad med den angivna resursgruppen.

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--partition-count

Antalet partitioner i söktjänsten. Om det anges kan det vara 1, 2, 3, 4, 6 eller 12. Värden som är större än 1 är endast giltiga för standard-SKU:er. För "standard3"-tjänster med hostingMode inställt på "highDensity" är de tillåtna värdena mellan 1 och 3.

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

Det här värdet kan anges till "aktiverat" för att undvika icke-bakåtkompatibla ändringar av befintliga kundresurser och mallar. Om inställningen är "inaktiverad" tillåts inte trafik via det offentliga gränssnittet och privata slutpunktsanslutningar är den exklusiva åtkomstmetoden.

Godkända värden: disabled, enabled
--remove

Ta bort en egenskap eller ett element från en lista. Exempel: --remove property.list <indexToRemove> ELLER --remove propertyToRemove.

--replica-count

Antalet repliker i söktjänsten. Om det anges måste det vara ett värde mellan 1 och 12 inklusive för standard-SKU:er eller mellan 1 och 3 inklusive för grundläggande SKU.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--semantic-search

Anger alternativ som styr tillgängligheten för semantisk sökning. Den här konfigurationen är endast möjlig för vissa Azure Cognitive Search-SKU:er på vissa platser.

Godkända värden: disabled, free, standard
--set

Uppdatera ett objekt genom att ange en egenskapssökväg och ett värde som ska anges. Exempel: --set property1.property2=<value>.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--tags

Resurstaggar. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer information och exempel finns i http://jmespath.org/.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az search service wait

Redigera

Placera CLI i vänteläge tills ett villkor uppfylls.

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

Valfria parametrar

--created

Vänta tills du har skapat med "provisioningState" på "Lyckades".

Standardvärde: False
--custom

Vänta tills villkoret uppfyller en anpassad JMESPath-fråga. T.ex. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Vänta tills den har tagits bort.

Standardvärde: False
--exists

Vänta tills resursen finns.

Standardvärde: False
--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--interval

Avsökningsintervall i sekunder.

Standardvärde: 30
--name --search-service-name -n

Namnet på azure cognitive search-tjänsten som är associerad med den angivna resursgruppen.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--timeout

Maximal väntetid i sekunder.

Standardvärde: 3600
--updated

Vänta tills det har uppdaterats med provisioningState på Lyckades.

Standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer information och exempel finns i http://jmespath.org/.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.