alerts-v2 Befehlsgruppe

Note

Diese Informationen gelten für Databricks CLI-Versionen 0.205 und höher. Die Databricks CLI befindet sich in der öffentlichen Vorschau.

Die Verwendung von Databricks CLI unterliegt der Datenbricks-Lizenz - und Databricks-Datenschutzerklärung, einschließlich der Bestimmungen zu Nutzungsdaten.

Mit alerts-v2 der Befehlsgruppe in der Databricks CLI können Sie SQL-Warnungen verwalten. Eine Warnung führt regelmäßig eine Abfrage aus, wertet eine Bedingung des Ergebnisses aus und benachrichtigt einen oder mehrere Benutzer und/oder Benachrichtigungsziele, wenn die Bedingung erfüllt wurde.

databricks alerts-v2 create-alert

Eine Warnung erstellen.

databricks alerts-v2 create-alert DISPLAY_NAME QUERY_TEXT WAREHOUSE_ID EVALUATION SCHEDULE [flags]

Arguments

DISPLAY_NAME

    Der Anzeigename der Warnung.

QUERY_TEXT

    Text der auszuführenden Abfrage.

WAREHOUSE_ID

    ID des SQL-Lagers, das an die Warnung angefügt ist.

EVALUATION

    Die Auswertungsbedingung für die Warnung.

SCHEDULE

    Der Zeitplan für die Ausführung der Warnungsabfrage.

Options

--custom-description string

    Benutzerdefinierte Beschreibung für die Warnung.

--custom-summary string

    Benutzerdefinierte Zusammenfassung für die Warnung.

--json JSON

    Die Inline-JSON-Zeichenfolge oder die JSON-Datei mit dem @path Anforderungstext.

--parent-path string

    Der Arbeitsbereichspfad des Ordners, der die Warnung enthält.

--run-as-user-name string

    Die Ausführung als Benutzername oder Anwendungs-ID des Dienstprinzipals.

Globale Kennzeichnungen

Examples

Im folgenden Beispiel wird eine Warnung mithilfe einer JSON-Datei erstellt:

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

Erhalten Sie eine Benachrichtigung.

databricks alerts-v2 get-alert ID [flags]

Arguments

ID

    Die UUID der abzurufenden Warnung.

Options

Globale Kennzeichnungen

Examples

Das folgende Beispiel ruft eine Warnung nach ID ab:

databricks alerts-v2 get-alert 12345678-1234-1234-1234-123456789012

databricks alerts-v2 list-alerts

Listet Warnungen auf. Ruft eine Liste der Benachrichtigungen ab, auf die der Benutzer zugreifen kann, sortiert nach Erstellungszeit.

databricks alerts-v2 list-alerts [flags]

Arguments

Nichts

Options

--page-size int

    Die maximale Anzahl der zurückzugebenden Warnungen.

--page-token string

    Ein Seitentoken aus einem vorherigen Listenaufruf zum Abrufen der nächsten Seite.

Globale Kennzeichnungen

Examples

Im folgenden Beispiel werden alle Benachrichtigungen aufgelistet, auf die zugegriffen werden kann:

databricks alerts-v2 list-alerts

databricks alerts-v2 trash-alert

Löschen sie eine Warnung. Verschiebt eine Warnung in den Papierkorb. Papierkorbbenachrichtigungen werden sofort aus Listenansichten ausgeblendet und können nicht mehr ausgelöst werden. Sie können eine gelöschte Warnung über die Benutzeroberfläche wiederherstellen. Eine gelöschte Benachrichtigung wird nach 30 Tagen dauerhaft entfernt.

databricks alerts-v2 trash-alert ID [flags]

Arguments

ID

    Die UUID der Warnung auf Papierkorb.

Options

--purge

    Gibt an, ob die Warnung endgültig gelöscht werden soll.

Globale Kennzeichnungen

Examples

Im folgenden Beispiel wird eine Warnung gelöscht:

databricks alerts-v2 trash-alert 12345678-1234-1234-1234-123456789012

Im folgenden Beispiel wird eine Warnung endgültig gelöscht:

databricks alerts-v2 trash-alert 12345678-1234-1234-1234-123456789012 --purge

databricks alerts-v2 update-alert

Aktualisieren sie eine Warnung.

databricks alerts-v2 update-alert ID UPDATE_MASK DISPLAY_NAME QUERY_TEXT WAREHOUSE_ID EVALUATION SCHEDULE [flags]

Arguments

ID

    UUID, die die Warnung identifiziert.

UPDATE_MASK

    Das Feldformat, das angibt, welche Felder aktualisiert werden sollen. Verwenden Sie kommagetrennte Feldnamen. Wird verwendet * , um alle Felder zu aktualisieren.

DISPLAY_NAME

    Der Anzeigename der Warnung.

QUERY_TEXT

    Text der auszuführenden Abfrage.

WAREHOUSE_ID

    ID des SQL-Lagers, das an die Warnung angefügt ist.

EVALUATION

    Die Auswertungsbedingung für die Warnung.

SCHEDULE

    Der Zeitplan für die Ausführung der Warnungsabfrage.

Options

--custom-description string

    Benutzerdefinierte Beschreibung für die Warnung.

--custom-summary string

    Benutzerdefinierte Zusammenfassung für die Warnung.

--json JSON

    Die Inline-JSON-Zeichenfolge oder die JSON-Datei mit dem @path Anforderungstext.

--parent-path string

    Der Arbeitsbereichspfad des Ordners, der die Warnung enthält.

--run-as-user-name string

    Die Ausführung als Benutzername oder Anwendungs-ID des Dienstprinzipals.

Globale Kennzeichnungen

Examples

Im folgenden Beispiel wird der Anzeigename einer Warnung aktualisiert:

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

Globale Kennzeichnungen

--debug

  Gibt an, ob die Debugprotokollierung aktiviert werden soll.

-h oder --help

    Hilfe für die Databricks CLI oder die zugehörige Befehlsgruppe oder den zugehörigen Befehl anzeigen.

--log-file Schnur

    Eine Zeichenfolge, die die Datei darstellt, in die Ausgabeprotokolle geschrieben werden sollen. Wenn dieses Flag nicht angegeben ist, werden Ausgabeprotokolle standardmäßig in stderr geschrieben.

--log-format Format

    Der Protokollformattyp text oder json. Der Standardwert ist text.

--log-level Schnur

    Eine Zeichenfolge, die die Protokollformatebene darstellt. Wenn nicht angegeben, ist die Protokollformatebene deaktiviert.

-o, --output Typ

    Der Befehlsausgabetyp text oder json. Der Standardwert ist text.

-p, --profile Schnur

    Der Name des Profils in der ~/.databrickscfg Datei, das zum Ausführen des Befehls verwendet werden soll. Wenn dieses Flag nicht angegeben wird, wird, falls vorhanden, das Profil mit dem Namen DEFAULT verwendet.

--progress-format Format

    Das Format zum Anzeigen von Statusprotokollen: default, , append, inplaceoder json

-t, --target Schnur

    Falls zutreffend, das zu verwendende Bündelziel