Grupo de comandos alerts-v2

Note

Esta información se aplica a las versiones 0.205 y posteriores de la CLI de Databricks. La CLI de Databricks está en versión preliminar pública.

El uso de la CLI de Databricks está sujeto a la licencia de Databricks y al aviso de privacidad de Databricks, incluidas las disposiciones de datos de uso.

El alerts-v2 grupo de comandos de la CLI de Databricks permite administrar alertas de SQL. Una alerta ejecuta periódicamente una consulta, evalúa una condición de su resultado y notifica uno o varios usuarios o destinos de notificación si se cumple la condición.

databricks alerts-v2 create-alert

Crear una alerta.

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

Argumentos

DISPLAY_NAME

    Nombre para mostrar de la alerta.

QUERY_TEXT

    Texto de la consulta que se va a ejecutar.

WAREHOUSE_ID

    Identificador de SQL Warehouse asociado a la alerta.

EVALUATION

    Condición de evaluación de la alerta.

SCHEDULE

    Programación para ejecutar la consulta de alerta.

Options

--custom-description string

    Descripción personalizada de la alerta.

--custom-summary string

    Resumen personalizado de la alerta.

--json JSON

    La cadena JSON en línea o el archivo JSON @path con el cuerpo de la solicitud.

--parent-path string

    Ruta del área de trabajo de la carpeta que contiene la alerta.

--run-as-user-name string

    La ejecución como nombre de usuario o identificador de aplicación de la entidad de servicio.

Marcas globales

Examples

En el ejemplo siguiente se crea una alerta mediante un archivo 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

Obtener una alerta.

databricks alerts-v2 get-alert ID [flags]

Argumentos

ID

    UUID de la alerta que se va a recuperar.

Options

Marcas globales

Examples

En el ejemplo siguiente se obtiene una alerta por identificador:

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

databricks alerts-v2 list-alerts

Mostrar alertas. Obtiene una lista de alertas accesibles para el usuario, ordenadas por tiempo de creación.

databricks alerts-v2 list-alerts [flags]

Argumentos

Ninguno

Options

--page-size int

    Número máximo de alertas que se van a devolver.

--page-token string

    Token de página de una llamada de lista anterior para recuperar la página siguiente.

Marcas globales

Examples

En el ejemplo siguiente se enumeran todas las alertas accesibles:

databricks alerts-v2 list-alerts

databricks alerts-v2 trash-alert

Elimine una alerta. Mueve una alerta a la papelera. Las alertas papeleras desaparecen inmediatamente de las vistas de lista y ya no se pueden desencadenar. Puede restaurar una alerta eliminada desde la interfaz de usuario. Una alerta eliminada se borra definitivamente después de 30 días.

databricks alerts-v2 trash-alert ID [flags]

Argumentos

ID

    UUID de la alerta a la papelera.

Options

--purge

    Si desea eliminar permanentemente la alerta.

Marcas globales

Examples

En el ejemplo siguiente se papelera una alerta:

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

En el ejemplo siguiente se elimina permanentemente una alerta:

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

databricks alerts-v2 update-alert

Actualizar una alerta.

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

Argumentos

ID

    UUID que identifica la alerta.

UPDATE_MASK

    Máscara de campo que especifica qué campos se van a actualizar. Use nombres de campo separados por comas. Use * para actualizar todos los campos.

DISPLAY_NAME

    Nombre para mostrar de la alerta.

QUERY_TEXT

    Texto de la consulta que se va a ejecutar.

WAREHOUSE_ID

    Identificador de SQL Warehouse asociado a la alerta.

EVALUATION

    Condición de evaluación de la alerta.

SCHEDULE

    Programación para ejecutar la consulta de alerta.

Options

--custom-description string

    Descripción personalizada de la alerta.

--custom-summary string

    Resumen personalizado de la alerta.

--json JSON

    La cadena JSON en línea o el archivo JSON @path con el cuerpo de la solicitud.

--parent-path string

    Ruta del área de trabajo de la carpeta que contiene la alerta.

--run-as-user-name string

    La ejecución como nombre de usuario o identificador de aplicación de la entidad de servicio.

Marcas globales

Examples

En el ejemplo siguiente se actualiza el nombre para mostrar de una alerta:

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

Marcas globales

--debug

  Indica si se va a habilitar el registro de depuración.

-h o --help

    Mostrar ayuda para la CLI de Databricks o el grupo de comandos relacionado o el comando relacionado.

--log-file cadena

    Cadena que representa el archivo en el que se van a escribir registros de salida. Si no se especifica esta marca, el valor predeterminado es escribir registros de salida en stderr.

--log-format formato

    Tipo de formato de registro: text o json. El valor predeterminado es text.

--log-level cadena

    Cadena que representa el nivel de formato de registro. Si no se especifica, el nivel de formato de registro está deshabilitado.

-o, --output tipo

    Tipo de salida del comando, text o json. El valor predeterminado es text.

-p, --profile cadena

    Nombre del perfil en el archivo ~/.databrickscfg que se usará para ejecutar el comando. Si no se especifica esta marca, si existe, se usa el perfil denominado DEFAULT .

--progress-format formato

    Formato para mostrar los registros de progreso: default, append, inplaceo json

-t, --target cadena

    Si procede, el destino del paquete que se va a usar