alerts-v2 kommandogrupp

Note

Den här informationen gäller för Databricks CLI-versionerna 0.205 och senare. Databricks CLI finns i offentlig förhandsversion.

Databricks CLI-användning omfattas av Databricks-licensen och Databricks sekretessmeddelande, inklusive eventuella användningsdatabestämmelser.

Med alerts-v2 kommandogruppen i Databricks CLI kan du hantera SQL-aviseringar. En avisering kör regelbundet en fråga, utvärderar ett villkor för resultatet och meddelar en eller flera användare och/eller meddelandemål om villkoret uppfylldes.

databricks alerts-v2 create-alert

Skapa en avisering.

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

Arguments

DISPLAY_NAME

    Aviseringens visningsnamn.

QUERY_TEXT

    Text för den fråga som ska köras.

WAREHOUSE_ID

    ID för DET SQL-lager som är kopplat till aviseringen.

EVALUATION

    Utvärderingsvillkoret för aviseringen.

SCHEDULE

    Schemat för att köra aviseringsfrågan.

Options

--custom-description string

    Anpassad beskrivning för aviseringen.

--custom-summary string

    Anpassad sammanfattning för aviseringen.

--json JSON

    Den inbäddade JSON-strängen eller @path till JSON-filen med begärandekroppen.

--parent-path string

    Sökvägen till arbetsytan för mappen som innehåller aviseringen.

--run-as-user-name string

    Kör som användarnamn eller program-ID för tjänstens huvudnamn.

Globala flaggor

Examples

I följande exempel skapas en avisering med hjälp av en JSON-fil:

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

Få en avisering.

databricks alerts-v2 get-alert ID [flags]

Arguments

ID

    UUID för aviseringen som ska hämtas.

Options

Globala flaggor

Examples

I följande exempel hämtas en avisering efter ID:

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

databricks alerts-v2 list-alerts

Lista aviseringar. Hämtar en lista över aviseringar som är tillgängliga för användaren, ordnade efter skapandetid.

databricks alerts-v2 list-alerts [flags]

Arguments

Ingen

Options

--page-size int

    Det maximala antalet aviseringar som ska returneras.

--page-token string

    En sidtoken från ett tidigare listanrop för att hämta nästa sida.

Globala flaggor

Examples

I följande exempel visas alla tillgängliga aviseringar:

databricks alerts-v2 list-alerts

databricks alerts-v2 trash-alert

Ta bort en avisering. Flyttar en avisering till papperskorgen. Aviseringar i papperskorgen försvinner omedelbart från listvyer och kan inte längre utlösas. Du kan återställa en borttagen avisering via användargränssnittet. En borttagen varning tas bort permanent efter 30 dagar.

databricks alerts-v2 trash-alert ID [flags]

Arguments

ID

    UUID för aviseringen till papperskorgen.

Options

--purge

    Om aviseringen ska tas bort permanent.

Globala flaggor

Examples

I följande exempel förstörs en avisering:

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

I följande exempel tas en avisering bort permanent:

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

databricks alerts-v2 update-alert

Uppdatera en avisering.

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

Arguments

ID

    UUID som identifierar aviseringen.

UPDATE_MASK

    Fältmasken som anger vilka fält som ska uppdateras. Använd kommaavgränsade fältnamn. Använd * för att uppdatera alla fält.

DISPLAY_NAME

    Aviseringens visningsnamn.

QUERY_TEXT

    Text för den fråga som ska köras.

WAREHOUSE_ID

    ID för DET SQL-lager som är kopplat till aviseringen.

EVALUATION

    Utvärderingsvillkoret för aviseringen.

SCHEDULE

    Schemat för att köra aviseringsfrågan.

Options

--custom-description string

    Anpassad beskrivning för aviseringen.

--custom-summary string

    Anpassad sammanfattning för aviseringen.

--json JSON

    Den inbäddade JSON-strängen eller @path till JSON-filen med begärandekroppen.

--parent-path string

    Sökvägen till arbetsytan för mappen som innehåller aviseringen.

--run-as-user-name string

    Kör som användarnamn eller program-ID för tjänstens huvudnamn.

Globala flaggor

Examples

I följande exempel uppdateras en aviserings visningsnamn:

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

Globala flaggor

--debug

  Om felsökningsloggning ska aktiveras.

-h eller --help

    Visa hjälp för Databricks CLI eller den relaterade kommandogruppen eller det relaterade kommandot.

--log-file sträng

    En sträng som representerar filen som utdataloggarna ska skrivas till. Om den här flaggan inte anges är standardvärdet att skriva utdataloggar till stderr.

--log-format Format

    Loggformattypen, text eller json. Standardvärdet är text.

--log-level sträng

    En sträng som representerar loggformatnivån. Om det inte anges inaktiveras loggformatnivån.

-o, --output typ

    Kommandots utdatatyp, text eller json. Standardvärdet är text.

-p, --profile sträng

    Namnet på profilen i ~/.databrickscfg-filen som ska användas för att köra kommandot. Om den här flaggan inte anges används den namngivna DEFAULT profilen om den finns.

--progress-format Format

    Formatet för att visa förloppsloggar: default, append, inplaceeller json

-t, --target sträng

    Om tillämpligt, paketmålet som ska användas