groupe de commandesalerts-v2
L'utilisation de Databricks CLI est soumise à la licence Databricks et à la politique de confidentialité Databricks, y compris toutes les dispositions relatives aux données d'utilisation.
Le groupe de commandes alerts-v2 au sein de la CLI Databricks vous permet de gérer les alertes SQL. Une alerte exécute périodiquement une query, évalue une condition de son résultat et avertit un ou plusieurs utilisateurs et/ou destinations de notification si la condition est remplie.
databricks alertes-v2 créer-alerte
Créer une alerte.
databricks alerts-v2 create-alert DISPLAY_NAME QUERY_TEXT WAREHOUSE_ID EVALUATION SCHEDULE [flags]
Arguments
DISPLAY_NAME
Nom d'affichage de l'alerte.
QUERY_TEXT
Texte de la requête à exécuter.
WAREHOUSE_ID
ID du SQL Warehouse associé à l'alerte.
EVALUATION
La condition d'évaluation de l'alerte.
SCHEDULE
Le planning pour l'exécution de la query d'alerte.
Options
--custom-description string
Description personnalisée pour l'alerte.
--custom-summary string
Résumé personnalisé pour l'alerte.
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--parent-path string
Le chemin du Workspace du dossier contenant l'alerte.
--run-as-user-name string
Le nom d'utilisateur d'exécution ou l'ID d'application du Service Principal.
Exemples
L'exemple suivant crée une alerte à l'aide d'un fichier JSON :
databricks alerts-v2 create-alert "High CPU Alert" "SELECT cpu_usage FROM metrics" "abc123" @evaluation.json @schedule.json --json @alert.json
databricks alerts-v2 get-alert
Recevez une alerte.
databricks alerts-v2 get-alert ID [flags]
Arguments
ID
L'UUID de l'alerte à récupérer.
Options
Exemples
L'exemple suivant récupère une alerte par ID :
databricks alerts-v2 get-alert 12345678-1234-1234-1234-123456789012
databricks alerts-v2 list-alerts
Lister les alertes. Obtient une liste des alertes accessibles à l'utilisateur, classées par heure de création.
databricks alerts-v2 list-alerts [flags]
Arguments
Aucun
Options
--page-size int
Le nombre maximal d'alertes à renvoyer.
--page-token string
Un jeton de page issu d'un appel de liste précédent pour récupérer la page suivante.
Exemples
L'exemple suivant répertorie toutes les alertes accessibles :
databricks alerts-v2 list-alerts
databricks alertes-v2 alerte-corbeille
Supprimer une alerte. Déplace une alerte vers la corbeille. Les alertes mises à la corbeille disparaissent immédiatement des vues de liste et ne peuvent plus Trigger. Vous pouvez restaurer une alerte supprimée via l'interface utilisateur. Une alerte mise à la corbeille est définitivement supprimée après 30 jours.
databricks alerts-v2 trash-alert ID [flags]
Arguments
ID
L'UUID de l'alerte à mettre à la corbeille.
Options
--purge
Indique s'il faut supprimer définitivement l'alerte.
Exemples
L'exemple suivant met une alerte à la corbeille :
databricks alerts-v2 trash-alert 12345678-1234-1234-1234-123456789012
L'exemple suivant supprime définitivement une alerte :
databricks alerts-v2 trash-alert 12345678-1234-1234-1234-123456789012 --purge
databricks alerts-v2 update-alert
Mettre à jour une alerte.
databricks alerts-v2 update-alert ID UPDATE_MASK DISPLAY_NAME QUERY_TEXT WAREHOUSE_ID EVALUATION SCHEDULE [flags]
Arguments
ID
UUID identifiant l'alerte.
UPDATE_MASK
Le masque de champ spécifiant les champs à mettre à jour. Utilisez des noms de champs séparés par des virgules. Utilisez * pour mettre à jour tous les champs.
DISPLAY_NAME
Nom d'affichage de l'alerte.
QUERY_TEXT
Texte de la requête à exécuter.
WAREHOUSE_ID
ID du SQL Warehouse associé à l'alerte.
EVALUATION
La condition d'évaluation de l'alerte.
SCHEDULE
Le planning pour l'exécution de la query d'alerte.
Options
--custom-description string
Description personnalisée pour l'alerte.
--custom-summary string
Résumé personnalisé pour l'alerte.
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--parent-path string
Le chemin du Workspace du dossier contenant l'alerte.
--run-as-user-name string
Le nom d'utilisateur d'exécution ou l'ID d'application du Service Principal.
Exemples
L'exemple suivant met à jour le nom d'affichage d'une alerte :
databricks alerts-v2 update-alert 12345678-1234-1234-1234-123456789012 display_name "Updated Alert Name" "SELECT cpu_usage FROM metrics" "abc123" @evaluation.json @schedule.json
Drapeaux globaux
--debug
Activer ou non la journalisation de débogage.
-h OU --help
Afficher l'aide de Databricks CLI ou du groupe de commandes associé ou de la commande associée.
--log-file chaîne
Une chaîne représentant le fichier dans lequel écrire les logs de sortie. Si cet indicateur n'est pas spécifié, la default est d'écrire les logs de sortie dans stderr.
--log-format Format
Le type de format de log, text ou json. La valeur par default est text.
--log-level chaîne
Une chaîne représentant le niveau de format du log. S'il n'est pas spécifié, le niveau de format du log est désactivé.
-o, --output Type
Le type de sortie de la commande, text ou json. La valeur par default est text.
-p, --profile chaîne
Nom du profil dans le fichier ~/.databrickscfg à utiliser pour exécuter la commande. Si cet indicateur n'est pas spécifié, alors s'il existe, le profil nommé DEFAULT est utilisé.
--progress-format Format
Le format pour afficher les logs de progression : default, append, inplace ou json
-t, --target chaîne
Le cas échéant, la cible de bundle à utiliser