Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
Note
Ces informations s’appliquent à Databricks CLI versions 0.205 et ultérieures. L’interface CLI Databricks est en préversion publique.
L’utilisation de l’interface CLI Databricks est soumise à la licence Databricks et à la notification de confidentialité Databricks, y compris les dispositions relatives aux données d’utilisation.
Le alerts-v2 groupe de commandes dans l’interface CLI Databricks vous permet de gérer les alertes SQL. Une alerte exécute régulièrement une requête, évalue une condition de son résultat et avertit un ou plusieurs utilisateurs et/ou destinations de notification si la condition a été remplie.
databricks alerts-v2 create-alert
Créez une alerte.
databricks alerts-v2 create-alert DISPLAY_NAME QUERY_TEXT WAREHOUSE_ID EVALUATION SCHEDULE [flags]
Arguments
DISPLAY_NAME
Nom complet de l’alerte.
QUERY_TEXT
Texte de la requête à exécuter.
WAREHOUSE_ID
ID de l’entrepôt SQL attaché à l’alerte.
EVALUATION
Condition d’évaluation de l’alerte.
SCHEDULE
Planification de l’exécution de la requête d’alerte.
Options
--custom-description string
Description personnalisée de l’alerte.
--custom-summary string
Résumé personnalisé de l’alerte.
--json JSON
Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.
--parent-path string
Chemin d’accès de l’espace de travail du dossier contenant l’alerte.
--run-as-user-name string
Exécuter en tant que nom d’utilisateur ou ID d’application du principal de service.
Examples
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
Obtenez une alerte.
databricks alerts-v2 get-alert ID [flags]
Arguments
ID
UUID de l’alerte à récupérer.
Options
Examples
L’exemple suivant obtient une alerte par ID :
databricks alerts-v2 get-alert 12345678-1234-1234-1234-123456789012
alertes databricks-v2 list-alerts
Répertorier les alertes. Obtient une liste d’alertes accessibles à l’utilisateur, classées par heure de création.
databricks alerts-v2 list-alerts [flags]
Arguments
None
Options
--page-size int
Nombre maximal d’alertes à retourner.
--page-token string
Jeton de page d’un appel de liste précédent pour récupérer la page suivante.
Examples
L’exemple suivant répertorie toutes les alertes accessibles :
databricks alerts-v2 list-alerts
databricks alerts-v2 trash-alert
Supprimez une alerte. Déplace une alerte vers la corbeille. Les alertes corbeilles disparaissent immédiatement des affichages de liste et ne peuvent plus se déclencher. Vous pouvez restaurer une alerte mise à la corbeille via l'interface utilisateur (UI). Les alertes dans la corbeille sont définitivement supprimées après 30 jours.
databricks alerts-v2 trash-alert ID [flags]
Arguments
ID
UUID de l’alerte à corbeille.
Options
--purge
Indique s’il faut supprimer définitivement l’alerte.
Examples
L’exemple suivant corbeille une alerte :
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
Mettez à 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
Masque de champ spécifiant les champs à mettre à jour. Utilisez des noms de champs séparés par des virgules. Permet * de mettre à jour tous les champs.
DISPLAY_NAME
Nom complet de l’alerte.
QUERY_TEXT
Texte de la requête à exécuter.
WAREHOUSE_ID
ID de l’entrepôt SQL attaché à l’alerte.
EVALUATION
Condition d’évaluation de l’alerte.
SCHEDULE
Planification de l’exécution de la requête d’alerte.
Options
--custom-description string
Description personnalisée de l’alerte.
--custom-summary string
Résumé personnalisé de l’alerte.
--json JSON
Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.
--parent-path string
Chemin d’accès de l’espace de travail du dossier contenant l’alerte.
--run-as-user-name string
Exécuter en tant que nom d’utilisateur ou ID d’application du principal de service.
Examples
L’exemple suivant met à jour le nom complet 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
Indicateurs globaux
--debug
Faut-il activer la journalisation du débogage ?
-h ou --help
Affiche l’aide pour l’interface CLI de Databricks, le groupe de commandes associé ou la commande concernée.
--log-file chaîne de caractères
Chaîne représentant le fichier utilisé pour écrire les logs de sortie. Si cet indicateur n’est pas spécifié, la valeur par défaut consiste à écrire les journaux de sortie dans stderr.
--log-format Format
Type de format de journal : text ou json. La valeur par défaut est text.
--log-level chaîne de caractères
Chaîne représentant le niveau de format du journal. Si cet indicateur n’est pas défini, le niveau de format de journal est désactivé.
Type -o, --output
Type de sortie de commande, text ou json. La valeur par défaut est text.
-p, --profile chaîne de caractères
Nom du profil dans le ~/.databrickscfg fichier à utiliser pour exécuter la commande. Si cet indicateur n’est pas spécifié, s’il existe, le profil nommé DEFAULT est utilisé.
--progress-format Format
Format permettant d’afficher les journaux de progression : default, append, inplace ou json
-t, --target chaîne de caractères
Le cas échéant, la cible d'ensemble à utiliser