az monitor app-insights api-key

  • Référence

Remarque

Cette référence fait partie de l’extension Application-Insights pour Azure CLI (version 2.55.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande api-insights app-insights. En savoir plus sur les extensions.

Opérations sur les clés API associées à un composant Application Recommandations.

Commandes

Nom Description Type Statut
az monitor app-insights api-key create

Créez une clé API d’un composant application Recommandations.

 Extension GA
az monitor app-insights api-key delete

Supprimez une clé API d’une ressource application Recommandations.

 Extension GA
az monitor app-insights api-key show

Obtenez toutes les clés ou une clé API spécifique associée à une ressource application Recommandations.

 Extension GA

az monitor app-insights api-key create

Créez une clé API d’un composant application Recommandations.

az monitor app-insights api-key create --api-key
                                       --app
                                       --resource-group
                                       [--read-properties]
                                       [--write-properties]

Exemples

Créez un composant avec un type web et un emplacement.

az monitor app-insights api-key create --api-key cli-demo --read-properties ReadTelemetry --write-properties WriteAnnotations -g demoRg --app testApp

Créer un composant avec un type web et un emplacement sans autorisation

az monitor app-insights api-key create --api-key cli-demo --read-properties '""' --write-properties '""' -g demoRg --app testApp

Paramètres obligatoires

--api-key

Nom de la clé API à créer.

--app -a

GUID, nom de l’application ou nom de ressource Azure complet du composant Application Recommandations. Le GUID de l’application peut être acquis à partir de l’élément de menu Accès à l’API sur n’importe quelle ressource d’application Recommandations dans le Portail Azure. Si vous utilisez un nom d’application, spécifiez le groupe de ressources.

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

--read-properties

Liste séparée par un espace des noms de rôles de lecture pour cette clé API à hériter. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--write-properties

Liste séparée par l’espace des noms des rôles d’écriture pour cette clé API à hériter. 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 monitor app-insights api-key delete

Supprimez une clé API d’une ressource application Recommandations.

az monitor app-insights api-key delete [--api-key]
                                       [--app]
                                       [--ids]
                                       [--resource-group]
                                       [--subscription]
                                       [--yes]

Exemples

Supprimer la clé API.

az monitor app-insights api-key delete --app demoApp -g demoRg --api-key demo-key

Paramètres facultatifs

--api-key

Nom de la clé API à supprimer. Vous pouvez le trouver à l’aide api-key showde .

--app -a

GUID, nom de l’application ou nom de ressource Azure complet du composant Application Recommandations. Le GUID de l’application peut être acquis à partir de l’élément de menu Accès à l’API sur n’importe quelle ressource d’application Recommandations dans le Portail Azure. Si vous utilisez un nom d’application, spécifiez le groupe de ressources.

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

--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 monitor app-insights api-key show

Obtenez toutes les clés ou une clé API spécifique associée à une ressource application Recommandations.

az monitor app-insights api-key show --app
                                     --resource-group
                                     [--api-key]

Exemples

Récupérer la clé API.

az monitor app-insights api-key show --app demoApp -g demoRg --api-key demo-key

Récupérer les clés d’API.

az monitor app-insights api-key show --app demoApp -g demoRg

Paramètres obligatoires

--app -a

Nom de la ressource de composant Application Recommandations.

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

--api-key

Nom de la clé API à extraire. Vous pouvez le trouver à l’aide api-key showde .

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.