Partager via

az monitor scheduled-query

Note

Cette référence fait partie de l’extension de requête planifiée pour Azure CLI (version 2.54.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une az monitor scheduled-query command. Apprenez-en davantage sur les extensions.

Commandes pour gérer les requêtes planifiées.

Commandes

Nom Description Type État
az monitor scheduled-query create

Créez une requête planifiée.

 Extension GA
az monitor scheduled-query delete

Supprimez une requête planifiée.

 Extension GA
az monitor scheduled-query list

Répertorier toutes les requêtes planifiées.

 Extension GA
az monitor scheduled-query show

Afficher les détails d’une requête planifiée.

 Extension GA
az monitor scheduled-query update

Mettez à jour une requête planifiée.

 Extension GA

az monitor scheduled-query create

Créez une requête planifiée.

az monitor scheduled-query create --condition
                                  --name
                                  --resource-group
                                  --scopes
                                  [--action-groups]
                                  [--auto-mitigate {false, true}]
                                  [--check-ws-alerts-storage --cwas {false, true}]
                                  [--condition-query]
                                  [--custom-properties]
                                  [--description]
                                  [--disabled {false, true}]
                                  [--evaluation-frequency]
                                  [--location]
                                  [--mad --mute-actions-duration]
                                  [--severity]
                                  [--skip-query-validation {false, true}]
                                  [--tags]
                                  [--target-resource-type --type]
                                  [--window-size]

Exemples

Créez une requête planifiée pour une machine virtuelle.

az monitor scheduled-query create -g {rg} -n {name1} --scopes {vm_id} --condition "count 'Placeholder_1' > 360 resource id _ResourceId at least 1 violations out of 5 aggregated points" --condition-query Placeholder_1="union Event, Syslog | where TimeGenerated > ago(1h) | where EventLevelName=='Error' or SeverityLevel=='err'" --description "Test rule"

Créez une requête planifiée pour les machines virtuelles dans un groupe de ressources.

az monitor scheduled-query create -g {rg} -n {name1} --scopes {rg_id} --condition "count 'Placeholder_1' > 360 resource id _ResourceId at least 1 violations out of 5 aggregated points" --condition-query Placeholder_1="union Event, Syslog | where TimeGenerated > ago(1h) | where EventLevelName=='Error' or SeverityLevel=='err'" --description "Test rule"

Paramètres obligatoires

--condition

Condition qui déclenche la règle.

Utilisation : --condition {avg,min,max,total,count} ["METRIC COLUMN » from] « QUERY_PLACEHOLDER » {=, !=,>,>=,<,<=} THRESHOLD [resource id RESOURCEID] [where DIMENSION {includes,excludes} VALUE [or VALUE ...] [et DIMENSION {includes,excludes} VALUE [ou VALUE ...] ...]] [au moins MinTimeToFail violations hors des points agrégés EvaluationPeriod]' Les espaces réservés de requête peuvent être définis dans les dimensions de l’argument --condition-query peuvent être interrogées en ajoutant le mot clé 'where' et plusieurs dimensions peuvent être interrogées en les combinant avec le mot clé 'and'.

--name -n

Nom de la règle de requête planifiée.

--resource-group -g

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

--scopes

Liste séparée par l’espace des étendues à l’application de la règle. Les ressources spécifiées dans ce paramètre doivent être du même type et exister dans le même emplacement.

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.

--action-groups

ID de ressource du groupe d’actions à appeler lorsque l’alerte se déclenche.

Utilisation : --action-groups ACTION_GROUP_NAME_OR_ID [NAME_OR_ID,...].

--auto-mitigate

Indicateur qui indique si l’alerte doit être résolue automatiquement ou non. La valeur par défaut est true.

Propriété Valeur
Valeur par défaut: True
Valeurs acceptées: false, true
--check-ws-alerts-storage --cwas

Indicateur qui indique si cette règle de requête planifiée doit être stockée dans le stockage du client.

Propriété Valeur
Valeur par défaut: False
Valeurs acceptées: false, true
--condition-query

Interroge les déteils pour remplacer les espaces réservés dans --condition argument.

--custom-properties

Propriétés d’une charge utile d’alerte.

Utilisation : --custom-properties ALERT_PAYLOAD_PROPERTIES [KEY=VAL,KEY=VAL ...].

--description

Description de texte libre de la règle.

--disabled

Désactivez la requête planifiée.

Propriété Valeur
Valeur par défaut: False
Valeurs acceptées: false, true
--evaluation-frequency

Fréquence avec laquelle évaluer la règle au format « ##h##m##s ».

Propriété Valeur
Valeur par défaut: 5m
--location -l

Location. Valeurs provenant de : az account list-locations. Vous pouvez configurer l’emplacement par défaut à l’aide de az configure --defaults location=<location>.

--mad --mute-actions-duration

Désactiver les actions pour la période choisie (au format de durée ISO 8601) après le déclenchement de l’alerte.

--severity

Gravité de l’alerte de 0 (critique) à 4 (détaillé).

Propriété Valeur
Valeur par défaut: 2
--skip-query-validation

Indicateur qui indique si la requête fournie doit être validée ou non.

Propriété Valeur
Valeur par défaut: False
Valeurs acceptées: false, true
--tags

Balises séparées par l’espace : key[=value] [key[=value] ...]. Utilisez « » pour effacer les balises existantes.

--target-resource-type --type

Type de ressource des ressources cibles dans les étendues. Cela doit être fourni lorsque les étendues sont un groupe de ressources ou un abonnement.

--window-size

Durée pendant laquelle agréger les métriques au format « ##h##m##s ».

Propriété Valeur
Valeur par défaut: 5m
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 scheduled-query delete

Supprimez une requête planifiée.

az monitor scheduled-query delete [--ids]
                                  [--name]
                                  [--resource-group]
                                  [--subscription]
                                  [--yes]

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.

--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
--name -n

Nom de la règle de requête planifiée.

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 scheduled-query list

Répertorier toutes les requêtes planifiées.

az monitor scheduled-query list [--resource-group]

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.

--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 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 scheduled-query show

Afficher les détails d’une requête planifiée.

az monitor scheduled-query show [--ids]
                                [--name]
                                [--resource-group]
                                [--subscription]

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.

--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
--name -n

Nom de la règle de requête planifiée.

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
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 scheduled-query update

Mettez à jour une requête planifiée.

az monitor scheduled-query update [--action-groups]
                                  [--add]
                                  [--auto-mitigate {false, true}]
                                  [--check-ws-alerts-storage --cwas {false, true}]
                                  [--condition]
                                  [--condition-query]
                                  [--custom-properties]
                                  [--description]
                                  [--disabled {false, true}]
                                  [--evaluation-frequency]
                                  [--force-string]
                                  [--ids]
                                  [--mad --mute-actions-duration]
                                  [--name]
                                  [--remove]
                                  [--resource-group]
                                  [--set]
                                  [--severity]
                                  [--skip-query-validation {false, true}]
                                  [--subscription]
                                  [--tags]
                                  [--target-resource-type --type]
                                  [--window-size]

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.

--action-groups

ID de ressource du groupe d’actions à appeler lorsque l’alerte se déclenche.

--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 or JSON string>.

Propriété Valeur
Groupe de paramètres: Generic Update Arguments
Valeur par défaut: []
--auto-mitigate

Indicateur qui indique si l’alerte doit être résolue automatiquement ou non. La valeur par défaut est true.

Propriété Valeur
Valeurs acceptées: false, true
--check-ws-alerts-storage --cwas

Indicateur qui indique si cette règle de requête planifiée doit être stockée dans le stockage du client.

Propriété Valeur
Valeurs acceptées: false, true
--condition

Condition qui déclenche la règle.

Utilisation : --condition {avg,min,max,total,count} ["METRIC COLUMN » from] « QUERY_PLACEHOLDER » {=, !=,>,>=,<,<=} THRESHOLD [resource id RESOURCEID] [where DIMENSION {includes,excludes} VALUE [or VALUE ...] [et DIMENSION {includes,excludes} VALUE [ou VALUE ...] ...]] [au moins les violations MinTimeToFail hors des points agrégés EvaluationPeriod]'

Les espaces réservés de requête peuvent être définis dans les dimensions de l’argument --condition-query peuvent être interrogés en ajoutant le mot clé 'where' et plusieurs dimensions peuvent être interrogés en les combinant avec le mot clé 'and'.

--condition-query

Interroge les déteils pour remplacer les espaces réservés dans --condition argument.

--custom-properties

Propriétés d’une charge utile d’alerte.

Utilisation : --custom-properties ALERT_PAYLOAD_PROPERTIES [KEY=VAL,KEY=VAL ...].

--description

Description de texte libre de la règle.

--disabled

Désactivez la requête planifiée.

Propriété Valeur
Valeurs acceptées: false, true
--evaluation-frequency

Fréquence avec laquelle évaluer la règle au format « ##h##m##s ».

--force-string

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

Propriété Valeur
Groupe de paramètres: Generic Update Arguments
Valeur par défaut: False
--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
--mad --mute-actions-duration

Désactiver les actions pour la période choisie (au format de durée ISO 8601) après le déclenchement de l’alerte.

--name -n

Nom de la règle de requête planifiée.

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

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

Propriété Valeur
Groupe de paramètres: Generic Update Arguments
Valeur par défaut: []
--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
--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=<value>.

Propriété Valeur
Groupe de paramètres: Generic Update Arguments
Valeur par défaut: []
--severity

Gravité de l’alerte de 0 (critique) à 4 (détaillé).

--skip-query-validation

Indicateur qui indique si la requête fournie doit être validée ou non.

Propriété Valeur
Valeurs acceptées: false, true
--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
--tags

Balises séparées par l’espace : key[=value] [key[=value] ...]. Utilisez « » pour effacer les balises existantes.

--target-resource-type --type

Type de ressource des ressources cibles dans les étendues. Cela doit être fourni lorsque les étendues sont un groupe de ressources ou un abonnement.

--window-size

Durée pendant laquelle agréger les métriques au format « ##h##m##s ».

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