alerts-v2 gruppo di comandi

Note

Queste informazioni si applicano all'interfaccia della riga di comando di Databricks versione 0.205 e successive. L'interfaccia della riga di comando di Databricks è disponibile in anteprima pubblica.

L'uso della CLI di Databricks è soggetto alla Licenza di Databricks e all'Informativa sulla privacy di Databricks, incluse eventuali disposizioni sui dati di utilizzo.

Il alerts-v2 gruppo di comandi all'interno dell'interfaccia della riga di comando di Databricks consente di gestire gli avvisi SQL. Un avviso esegue periodicamente una query, valuta una condizione del risultato e invia una notifica a uno o più utenti e/o destinazioni di notifica se la condizione è stata soddisfatta.

databricks alerts-v2 create-alert

Creare un avviso.

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

Arguments

DISPLAY_NAME

    Nome visualizzato dell'avviso.

QUERY_TEXT

    Testo della query da eseguire.

WAREHOUSE_ID

    ID del warehouse SQL collegato all'avviso.

EVALUATION

    Condizione di valutazione per l'avviso.

SCHEDULE

    Pianificazione per l'esecuzione della query di avviso.

Options

--custom-description string

    Descrizione personalizzata per l'avviso.

--custom-summary string

    Riepilogo personalizzato per l'avviso.

--json JSON

    La stringa JSON inline o il @path nel file JSON che contiene il corpo della richiesta.

--parent-path string

    Percorso dell'area di lavoro della cartella contenente l'avviso.

--run-as-user-name string

    Run come nome utente o ID applicazione dell'entità servizio.

Flag globali

Examples

L'esempio seguente crea un avviso usando un file 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

Ottenere un avviso.

databricks alerts-v2 get-alert ID [flags]

Arguments

ID

    UUID dell'avviso da recuperare.

Options

Flag globali

Examples

L'esempio seguente ottiene un avviso in base all'ID:

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

avvisi di databricks-v2 list-alerts

Elencare gli avvisi. Ottiene un elenco di avvisi accessibili all'utente, ordinati in base all'ora di creazione.

databricks alerts-v2 list-alerts [flags]

Arguments

Nessuno

Options

--page-size int

    Numero massimo di avvisi da restituire.

--page-token string

    Token di pagina da una chiamata di elenco precedente per recuperare la pagina successiva.

Flag globali

Examples

L'esempio seguente elenca tutti gli avvisi accessibili:

databricks alerts-v2 list-alerts

avviso di databricks alerts-v2 trash-alert

Eliminare un avviso. Sposta una notifica nel cestino. Gli avvisi spazzatura scompaiono immediatamente dalle visualizzazioni elenco e non possono più attivarsi. È possibile ripristinare un avviso eliminato tramite l'interfaccia utente. Un avviso cestinato viene eliminato permanentemente dopo 30 giorni.

databricks alerts-v2 trash-alert ID [flags]

Arguments

ID

    UUID dell'avviso nel cestino.

Options

--purge

    Indica se eliminare definitivamente l'avviso.

Flag globali

Examples

Nell'esempio seguente viene cestinato un avviso:

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

Nell'esempio seguente viene eliminato definitivamente un avviso:

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

databricks alerts-v2 update-alert

Aggiornare un avviso.

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

Arguments

ID

    UUID che identifica l'avviso.

UPDATE_MASK

    Maschera di campo che specifica i campi da aggiornare. Usare nomi di campo delimitati da virgole. Usare * per aggiornare tutti i campi.

DISPLAY_NAME

    Nome visualizzato dell'avviso.

QUERY_TEXT

    Testo della query da eseguire.

WAREHOUSE_ID

    ID del warehouse SQL collegato all'avviso.

EVALUATION

    Condizione di valutazione per l'avviso.

SCHEDULE

    Pianificazione per l'esecuzione della query di avviso.

Options

--custom-description string

    Descrizione personalizzata per l'avviso.

--custom-summary string

    Riepilogo personalizzato per l'avviso.

--json JSON

    La stringa JSON inline o il @path nel file JSON che contiene il corpo della richiesta.

--parent-path string

    Percorso dell'area di lavoro della cartella contenente l'avviso.

--run-as-user-name string

    Run come nome utente o ID applicazione dell'entità servizio.

Flag globali

Examples

Nell'esempio seguente viene aggiornato il nome visualizzato di un avviso:

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

Bandiere globali

--debug

  Indica se abilitare la registrazione di debug.

-h oppure --help

    Mostra la guida per il Databricks CLI, il gruppo di comandi correlato o il comando correlato.

--log-file stringa

    Stringa che rappresenta il file in cui scrivere i log di output. Se questo flag non viene specificato, l'impostazione predefinita prevede la scrittura dei log di output su stderr.

--log-format formato

    Tipo di formato del log, text o json. Il valore predefinito è text.

--log-level stringa

    Stringa che rappresenta il livello di formato del log. Se non specificato, il livello di formato del log è disabilitato.

tipo

    Tipo di output del comando, text o json. Il valore predefinito è text.

-p, --profile stringa

    Nome del profilo nel ~/.databrickscfg file da usare per eseguire il comando . Se questo flag non viene specificato, se esiste, viene usato il profilo denominato DEFAULT .

--progress-format formato

    Formato per visualizzare i log di stato: default, append, inplaceo json

-t, --target stringa

    Se applicabile, la destinazione del bundle da utilizzare