Partager via

az search service

  • Référence

Gérer les service Search Azure.

Commandes

Nom Description Type Statut
az search service create

Créez un service de recherche dans le groupe de ressources donné. Si le service de recherche existe déjà, toutes les propriétés sont mises à jour avec les valeurs données.

 Core GA
az search service delete

Supprimez un service de recherche dans le groupe de ressources donné, ainsi que ses ressources associées.

 Core GA
az search service list

Obtient une liste de toutes les service Search dans le groupe de ressources donné.

 Core GA
az search service show

Obtenez le service de recherche avec le nom donné dans le groupe de ressources donné.

 Core GA
az search service update

Mettez à jour un service de recherche dans le groupe de ressources donné. Si le service de recherche existe déjà, toutes les propriétés sont mises à jour avec les valeurs données.

 Core GA
az search service wait

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition soit remplie.

 Core GA

az search service create

Modifier

Créez un service de recherche dans le groupe de ressources donné. Si le service de recherche existe déjà, toutes les propriétés sont mises à jour avec les valeurs données.

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]

Paramètres obligatoires

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

Nom du service Recherche cognitive Azure à créer ou à mettre à jour. service Search noms ne doivent contenir que des lettres minuscules, des chiffres ou des tirets, ne peuvent pas utiliser de tirets comme deux ou derniers caractères, ne peuvent pas contenir de tirets consécutifs et doivent être compris entre 2 et 60 caractères. service Search noms doivent être globalement uniques, car ils font partie de l’URI de service (https://.search.windows.net). Vous ne pouvez pas modifier le nom du service une fois le service créé.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--sku

Référence SKU du service de recherche. Les valeurs valides sont les suivantes : « gratuit » : service partagé. « de base » : service dédié avec jusqu’à 3 réplicas. « standard » : service dédié avec jusqu’à 12 partitions et 12 réplicas. « standard2 » : similaire à la norme, mais avec plus de capacité par unité de recherche. « standard3 » : la plus grande offre Standard avec jusqu’à 12 partitions et 12 réplicas (ou jusqu’à 3 partitions avec plus d’index si vous définissez également la propriété hostingMode sur « highDensity »). 'storage_optimized_l1' : prend en charge 1 To par partition, jusqu’à 12 partitions. ' storage_optimized_l2' : prend en charge 2 To par partition, jusqu’à 12 partitions.'

valeurs acceptées: basic, free, standard, standard2, standard3, storage_optimized_l1, storage_optimized_l2

Paramètres facultatifs

--aad-auth-failure-mode

Décrit la réponse à laquelle l’API de plan de données d’un service Search envoyerait des demandes ayant échoué.

valeurs acceptées: http401WithBearerChallenge, http403
--auth-options

Aide.

valeurs acceptées: aadOrApiKey, apiKeyOnly
--disable-local-auth

Lorsque la valeur est true, les appels au service de recherche ne sont pas autorisés à utiliser les clés API pour l’authentification. Cela ne peut pas être défini sur true si « dataPlaneAuthOptions » sont définis.

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--hosting-mode

Applicable uniquement pour la référence SKU standard3. Vous pouvez définir cette propriété pour activer jusqu’à 3 partitions à haute densité qui autorisent jusqu’à 1 000 index, ce qui est beaucoup plus élevé que les index maximum autorisés pour toute autre référence SKU. Pour la référence SKU standard3, la valeur est « default » ou « highDensity ». Pour toutes les autres références SKU, cette valeur doit être « par défaut ».

valeurs acceptées: default, highDensity
valeur par défaut: default
--identity-type

Type d’identité.

valeurs acceptées: None, SystemAssigned
--ip-rules

De l’aide.

--location -l

Emplacement géographique où la ressource se trouve quand elle n’est pas spécifiée, l’emplacement du groupe de ressources sera utilisé.

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--partition-count

Nombre de partitions dans le service de recherche ; si spécifié, il peut s’agir de 1, 2, 3, 4, 6 ou 12. Les valeurs supérieures à 1 sont valides uniquement pour les références SKU standard. Pour les services « standard3 » avec hostingMode défini sur « highDensity », les valeurs autorisées sont comprises entre 1 et 3.

valeur par défaut: 1
--public-access --public-network-access

Cette valeur peut être définie sur « activé » pour éviter les modifications cassants sur les ressources et les modèles clients existants. Si la valeur est « désactivée », le trafic sur l’interface publique n’est pas autorisé et les connexions de point de terminaison privé sont la méthode d’accès exclusive.

valeurs acceptées: disabled, enabled
valeur par défaut: enabled
--replica-count

Nombre de réplicas dans le service de recherche. S’il est spécifié, il doit s’agir d’une valeur comprise entre 1 et 12 inclus pour les références SKU standard ou comprises entre 1 et 3 pour la référence SKU de base.

valeur par défaut: 1
--semantic-search

Définit les options qui contrôlent la disponibilité de la recherche sémantique. Cette configuration n’est possible que pour certaines références SKU Recherche cognitive Azure dans certains emplacements.

valeurs acceptées: disabled, free, standard
--tags

Balises de ressource. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az search service delete

Modifier

Supprimez un service de recherche dans le groupe de ressources donné, ainsi que ses ressources associées.

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

Paramètres facultatifs

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

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

Nom du service Recherche cognitive Azure associé au groupe de ressources spécifié.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--yes -y

Ne pas demander de confirmation.

valeur par défaut: False
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az search service list

Modifier

Obtient une liste de toutes les service Search dans le groupe de ressources donné.

az search service list --resource-group

Paramètres obligatoires

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az search service show

Modifier

Obtenez le service de recherche avec le nom donné dans le groupe de ressources donné.

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

Paramètres facultatifs

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

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

Nom du service Recherche cognitive Azure associé au groupe de ressources spécifié.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az search service update

Modifier

Mettez à jour un service de recherche dans le groupe de ressources donné. Si le service de recherche existe déjà, toutes les propriétés sont mises à jour avec les valeurs données.

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]

Paramètres facultatifs

--aad-auth-failure-mode

Décrit la réponse à laquelle l’API de plan de données d’un service Search envoyerait des demandes ayant échoué.

valeurs acceptées: http401WithBearerChallenge, http403
--add

Ajoutez un objet à une liste d’objets en spécifiant un chemin d’accès et des paires clé-valeur. Exemple : --add property.listProperty <key=value, string ou JSON string>.

--auth-options

Aide.

valeurs acceptées: aadOrApiKey, apiKeyOnly
--disable-local-auth

Lorsque la valeur est true, les appels au service de recherche ne sont pas autorisés à utiliser les clés API pour l’authentification. Cela ne peut pas être défini sur true si « dataPlaneAuthOptions » sont définis.

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--force-string

Lorsque vous utilisez « set » ou « add », conservez les littéraux de chaîne au lieu de tenter de convertir en JSON.

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--identity-type

Type d’identité.

valeurs acceptées: None, SystemAssigned
--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--ip-rules

De l’aide.

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

Nom du service Recherche cognitive Azure associé au groupe de ressources spécifié.

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--partition-count

Nombre de partitions dans le service de recherche ; si spécifié, il peut s’agir de 1, 2, 3, 4, 6 ou 12. Les valeurs supérieures à 1 sont valides uniquement pour les références SKU standard. Pour les services « standard3 » avec hostingMode défini sur « highDensity », les valeurs autorisées sont comprises entre 1 et 3.

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

Cette valeur peut être définie sur « activé » pour éviter les modifications cassants sur les ressources et les modèles clients existants. Si la valeur est « désactivée », le trafic sur l’interface publique n’est pas autorisé et les connexions de point de terminaison privé sont la méthode d’accès exclusive.

valeurs acceptées: disabled, enabled
--remove

Supprimez une propriété ou un élément d’une liste. Exemple : --remove property.list OR --remove propertyToRemove.

--replica-count

Nombre de réplicas dans le service de recherche. S’il est spécifié, il doit s’agir d’une valeur comprise entre 1 et 12 inclus pour les références SKU standard ou comprises entre 1 et 3 pour la référence SKU de base.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--semantic-search

Définit les options qui contrôlent la disponibilité de la recherche sémantique. Cette configuration n’est possible que pour certaines références SKU Recherche cognitive Azure dans certains emplacements.

valeurs acceptées: disabled, free, standard
--set

Mettez à jour un objet en spécifiant un chemin d’accès et une valeur de propriété à définir. Exemple : --set property1.property2=.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--tags

Balises de ressource. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az search service wait

Modifier

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition soit remplie.

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

Paramètres facultatifs

--created

Attendez la création avec « provisioningState » sur « Succeeded ».

valeur par défaut: False
--custom

Attendez que la condition réponde à une requête JMESPath personnalisée. Par exemple, provisioningState !='InProgress', instanceView.statuses[ ?code=='PowerState/running'].

--deleted

Attendez la suppression.

valeur par défaut: False
--exists

Attendez que la ressource existe.

valeur par défaut: False
--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--interval

Intervalle d’interrogation en secondes.

valeur par défaut: 30
--name --search-service-name -n

Nom du service Recherche cognitive Azure associé au groupe de ressources spécifié.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--timeout

Délai maximal d’attente en secondes.

valeur par défaut: 3600
--updated

Attendez la mise à jour avec provisioningState sur « Réussi ».

valeur par défaut: False
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.