az search service

Azure Search-service s beheren.

Opdracht

Name Description Type Status
az search service create

Maak een zoekservice in de opgegeven resourcegroep. Als de zoekservice al bestaat, worden alle eigenschappen bijgewerkt met de opgegeven waarden.

Basis GA
az search service delete

Verwijder een zoekservice in de opgegeven resourcegroep, samen met de bijbehorende resources.

Basis GA
az search service list

Hiermee haalt u een lijst op met alle Search-service s in de opgegeven resourcegroep.

Basis GA
az search service show

Haal de zoekservice op met de opgegeven naam in de opgegeven resourcegroep.

Basis GA
az search service update

Een zoekservice bijwerken in de opgegeven resourcegroep. Als de zoekservice al bestaat, worden alle eigenschappen bijgewerkt met de opgegeven waarden.

Basis GA
az search service wait

Plaats de CLI in een wachtstatus totdat aan een voorwaarde is voldaan.

Basis GA

az search service create

Maak een zoekservice in de opgegeven resourcegroep. Als de zoekservice al bestaat, worden alle eigenschappen bijgewerkt met de opgegeven waarden.

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]

Vereiste parameters

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

De naam van de Azure Cognitive Search-service om te maken of bij te werken. Search-service namen mogen alleen kleine letters, cijfers of streepjes bevatten, mogen geen streepje gebruiken als de eerste twee of laatste tekens, mogen geen opeenvolgende streepjes bevatten en moeten tussen de 2 en 60 tekens lang zijn. Search-service namen wereldwijd uniek moeten zijn omdat ze deel uitmaken van de service-URI (https://.search.windows.net). U kunt de servicenaam niet wijzigen nadat de service is gemaakt.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--sku

De SKU van de zoekservice. Geldige waarden zijn: 'gratis': Gedeelde service. 'basic': toegewezen service met maximaal 3 replica's. 'standaard': toegewezen service met maximaal 12 partities en 12 replica's. 'standard2': vergelijkbaar met standaard, maar met meer capaciteit per zoekeenheid. 'standard3': de grootste Standard-aanbieding met maximaal 12 partities en 12 replica's (of maximaal 3 partities met meer indexen als u ook de eigenschap hostingMode instelt op 'highDensity'). 'storage_optimized_l1': ondersteunt 1 TB per partitie, maximaal 12 partities. 'storage_optimized_l2': ondersteunt 2 TB per partitie, maximaal 12 partities.'

geaccepteerde waarden: basic, free, standard, standard2, standard3, storage_optimized_l1, storage_optimized_l2

Optionele parameters

--aad-auth-failure-mode

Beschrijft welke reactie de gegevensvlak-API van een Search-service zou verzenden voor aanvragen die mislukte verificatie hebben uitgevoerd.

geaccepteerde waarden: http401WithBearerChallenge, http403
--auth-options

Wat hulp.

geaccepteerde waarden: aadOrApiKey, apiKeyOnly
--disable-local-auth

Als deze is ingesteld op true, kunnen aanroepen naar de zoekservice geen API-sleutels gebruiken voor verificatie. Dit kan niet worden ingesteld op true als 'dataPlaneAuthOptions' is gedefinieerd.

geaccepteerde waarden: 0, 1, f, false, n, no, t, true, y, yes
--hosting-mode

Alleen van toepassing op de standard3-SKU. U kunt deze eigenschap instellen om maximaal 3 high-densitypartities in te schakelen die maximaal 1000 indexen toestaan, wat veel hoger is dan de maximumindexen die zijn toegestaan voor elke andere SKU. Voor de standard3-SKU is de waarde 'standaard' of 'highDensity'. Voor alle andere SKU's moet deze waarde 'standaard' zijn.

geaccepteerde waarden: default, highDensity
standaardwaarde: default
--identity-type

Het identiteitstype.

geaccepteerde waarden: None, SystemAssigned
--ip-rules

Wat hulp.

--location -l

De geografische locatie waar de resource zich bevindt wanneer deze niet is opgegeven, wordt de locatie van de resourcegroep gebruikt.

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

geaccepteerde waarden: 0, 1, f, false, n, no, t, true, y, yes
--partition-count

Het aantal partities in de zoekservice; indien opgegeven, kan dit 1, 2, 3, 4, 6 of 12 zijn. Waarden die groter zijn dan 1 zijn alleen geldig voor standaard-SKU's. Voor 'standard3'-services waarbij hostingMode is ingesteld op 'highDensity', liggen de toegestane waarden tussen 1 en 3.

standaardwaarde: 1
--public-access --public-network-access

Deze waarde kan worden ingesteld op 'ingeschakeld' om te voorkomen dat bestaande klantbronnen en sjablonen fouten veroorzaken. Als deze optie is ingesteld op Uitgeschakeld, is verkeer via openbare interface niet toegestaan en zijn privé-eindpuntverbindingen de exclusieve toegangsmethode.

geaccepteerde waarden: disabled, enabled
standaardwaarde: enabled
--replica-count

Het aantal replica's in de zoekservice. Indien opgegeven, moet deze een waarde tussen 1 en 12 inclusief zijn voor standaard-SKU's of tussen 1 en 3 inclusief voor de basis-SKU.

standaardwaarde: 1
--semantic-search

Hiermee stelt u opties in waarmee de beschikbaarheid van semantische zoekopdrachten wordt ingesteld. Deze configuratie is alleen mogelijk voor bepaalde Azure Cognitive Search-SKU's op bepaalde locaties.

geaccepteerde waarden: disabled, free, standard
--tags

Resourcetags. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az search service delete

Verwijder een zoekservice in de opgegeven resourcegroep, samen met de bijbehorende resources.

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

Optionele parameters

--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. Geef de argumenten --id's of andere resource-id's op.

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

De naam van de Azure Cognitive Search-service die zijn gekoppeld aan de opgegeven resourcegroep.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--yes -y

Niet vragen om bevestiging.

standaardwaarde: False
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az search service list

Hiermee haalt u een lijst op met alle Search-service s in de opgegeven resourcegroep.

az search service list --resource-group

Vereiste parameters

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az search service show

Haal de zoekservice op met de opgegeven naam in de opgegeven resourcegroep.

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

Optionele parameters

--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. Geef de argumenten --id's of andere resource-id's op.

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

De naam van de Azure Cognitive Search-service die zijn gekoppeld aan de opgegeven resourcegroep.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az search service update

Een zoekservice bijwerken in de opgegeven resourcegroep. Als de zoekservice al bestaat, worden alle eigenschappen bijgewerkt met de opgegeven waarden.

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]

Optionele parameters

--aad-auth-failure-mode

Beschrijft welke reactie de gegevensvlak-API van een Search-service zou verzenden voor aanvragen die mislukte verificatie hebben uitgevoerd.

geaccepteerde waarden: http401WithBearerChallenge, http403
--add

Voeg een object toe aan een lijst met objecten door een pad- en sleutelwaardeparen op te geven. Voorbeeld: --add property.listProperty <key=value, string of JSON string>.

--auth-options

Wat hulp.

geaccepteerde waarden: aadOrApiKey, apiKeyOnly
--disable-local-auth

Als deze is ingesteld op true, kunnen aanroepen naar de zoekservice geen API-sleutels gebruiken voor verificatie. Dit kan niet worden ingesteld op true als 'dataPlaneAuthOptions' is gedefinieerd.

geaccepteerde waarden: 0, 1, f, false, n, no, t, true, y, yes
--force-string

Wanneer u 'set' of 'toevoegen' gebruikt, behoudt u letterlijke tekenreeksen in plaats van te converteren naar JSON.

geaccepteerde waarden: 0, 1, f, false, n, no, t, true, y, yes
--identity-type

Het identiteitstype.

geaccepteerde waarden: None, SystemAssigned
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. Geef de argumenten --id's of andere resource-id's op.

--ip-rules

Wat hulp.

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

De naam van de Azure Cognitive Search-service die zijn gekoppeld aan de opgegeven resourcegroep.

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

geaccepteerde waarden: 0, 1, f, false, n, no, t, true, y, yes
--partition-count

Het aantal partities in de zoekservice; indien opgegeven, kan dit 1, 2, 3, 4, 6 of 12 zijn. Waarden die groter zijn dan 1 zijn alleen geldig voor standaard-SKU's. Voor 'standard3'-services waarbij hostingMode is ingesteld op 'highDensity', liggen de toegestane waarden tussen 1 en 3.

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

Deze waarde kan worden ingesteld op 'ingeschakeld' om te voorkomen dat bestaande klantbronnen en sjablonen fouten veroorzaken. Als deze optie is ingesteld op Uitgeschakeld, is verkeer via openbare interface niet toegestaan en zijn privé-eindpuntverbindingen de exclusieve toegangsmethode.

geaccepteerde waarden: disabled, enabled
--remove

Een eigenschap of element uit een lijst verwijderen. Voorbeeld: --remove property.list OR --remove propertyToRemove.

--replica-count

Het aantal replica's in de zoekservice. Indien opgegeven, moet deze een waarde tussen 1 en 12 inclusief zijn voor standaard-SKU's of tussen 1 en 3 inclusief voor de basis-SKU.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--semantic-search

Hiermee stelt u opties in waarmee de beschikbaarheid van semantische zoekopdrachten wordt ingesteld. Deze configuratie is alleen mogelijk voor bepaalde Azure Cognitive Search-SKU's op bepaalde locaties.

geaccepteerde waarden: disabled, free, standard
--set

Werk een object bij door een eigenschapspad en waarde op te geven die u wilt instellen. Voorbeeld: --set property1.property2=.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--tags

Resourcetags. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az search service wait

Plaats de CLI in een wachtstatus totdat aan een voorwaarde is voldaan.

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

Optionele parameters

--created

Wacht totdat u 'provisioningState' hebt gemaakt bij 'Succeeded'.

standaardwaarde: False
--custom

Wacht tot de voorwaarde voldoet aan een aangepaste JMESPath-query. Bijvoorbeeld provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wacht totdat deze is verwijderd.

standaardwaarde: False
--exists

Wacht tot de resource bestaat.

standaardwaarde: False
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. Geef de argumenten --id's of andere resource-id's op.

--interval

Polling-interval in seconden.

standaardwaarde: 30
--name --search-service-name -n

De naam van de Azure Cognitive Search-service die zijn gekoppeld aan de opgegeven resourcegroep.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--timeout

Maximale wachttijd in seconden.

standaardwaarde: 3600
--updated

Wacht totdat deze is bijgewerkt met provisioningState op 'Succeeded'.

standaardwaarde: False
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.