Partager via

az monitor app-insights api-key

Note

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

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

Commandes

Nom Description Type État
az monitor app-insights api-key create

Créez une clé API d’un composant Application Insights.

 Extension GA
az monitor app-insights api-key delete

Supprimez une clé API d’une ressource Application Insights.

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

 Extension GA

az monitor app-insights api-key create

Créez une clé API d’un composant Application Insights.

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 Insights. Le GUID de l’application peut être acquis à partir de l’élément de menu Accès à l’API sur n’importe quelle ressource Application Insights 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 à l’aide de az configure --defaults group=<name>.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--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 la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az monitor app-insights api-key delete

Supprimez une clé API d’une ressource Application Insights.

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

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--api-key

Nom de la clé API à supprimer. Se trouve à l’aide de api-key show.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--app -a

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

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). 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 ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--subscription

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

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--yes -y

N’invitez pas à confirmer.

Propriété Valeur
Valeur par défaut: False
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Propriété Valeur
Valeur par défaut: False

az monitor app-insights api-key show

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

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 du composant Application Insights.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--api-key

Nom de la clé API à extraire. Se trouve à l’aide de api-key show.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False