Grupo de comandos alerts-v2

Note

Essas informações se aplicam às versões 0.205 e superiores da CLI do Databricks. A CLI do Databricks está em Visualização Pública.

O uso da CLI do Databricks está sujeito à Licença do Databricks e ao Aviso de Privacidade do Databricks, incluindo quaisquer provisionamentos de Dados de Uso.

O alerts-v2 grupo de comandos dentro da CLI do Databricks permite que você gerencie alertas sql. Um alerta executa periodicamente uma consulta, avalia uma condição de seu resultado e notifica um ou mais usuários e/ou destinos de notificação se a condição foi atendida.

alertas do databricks-v2 create-alert

Criar um alerta.

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

Argumentos

DISPLAY_NAME

    O nome a apresentar do alerta.

QUERY_TEXT

    Texto da consulta a ser executada.

WAREHOUSE_ID

    ID do sql warehouse anexado ao alerta.

EVALUATION

    A condição de avaliação do alerta.

SCHEDULE

    O agendamento para executar a consulta de alerta.

Opções

--custom-description string

    Descrição personalizada do alerta.

--custom-summary string

    Resumo personalizado do alerta.

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

--parent-path string

    O caminho do espaço de trabalho da pasta que contém o alerta.

--run-as-user-name string

    A execução como nome de usuário ou ID do aplicativo da entidade de serviço.

Sinalizadores globais

Exemplos

O exemplo a seguir cria um alerta usando um arquivo JSON:

databricks alerts-v2 create-alert "High CPU Alert" "SELECT cpu_usage FROM metrics" "abc123" @evaluation.json @schedule.json --json @alert.json

alertas do databricks-v2 get-alert

Obtenha um alerta.

databricks alerts-v2 get-alert ID [flags]

Argumentos

ID

    A UUID do alerta a ser recuperado.

Opções

Sinalizadores globais

Exemplos

O exemplo a seguir obtém um alerta por ID:

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

alertas de lista do databricks-v2

Listar alertas. Obtém uma lista de alertas acessíveis ao usuário, ordenados pelo tempo de criação.

databricks alerts-v2 list-alerts [flags]

Argumentos

None

Opções

--page-size int

    O número máximo de alertas a serem retornados.

--page-token string

    Um token de página de uma chamada de lista anterior para recuperar a próxima página.

Sinalizadores globais

Exemplos

O exemplo a seguir lista todos os alertas acessíveis:

databricks alerts-v2 list-alerts

alertas de lixo do databricks-v2

Excluir um alerta. Mova um alerta para a lixeira. Os alertas destruídos desaparecem imediatamente das exibições da lista e não podem mais ser disparados. Você pode restaurar um alerta destruído por meio da interface do usuário. Um alerta destruído é excluído permanentemente após 30 dias.

databricks alerts-v2 trash-alert ID [flags]

Argumentos

ID

    A UUID do alerta para lixo.

Opções

--purge

    Se deseja excluir permanentemente o alerta.

Sinalizadores globais

Exemplos

O exemplo a seguir descarta um alerta:

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

O exemplo a seguir exclui permanentemente um alerta:

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

alertas do databricks-v2 update-alert

Atualize um alerta.

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

Argumentos

ID

    UUID identificando o alerta.

UPDATE_MASK

    A máscara de campo que especifica quais campos atualizar. Use nomes de campo separados por vírgulas. Use * para atualizar todos os campos.

DISPLAY_NAME

    O nome a apresentar do alerta.

QUERY_TEXT

    Texto da consulta a ser executada.

WAREHOUSE_ID

    ID do sql warehouse anexado ao alerta.

EVALUATION

    A condição de avaliação do alerta.

SCHEDULE

    O agendamento para executar a consulta de alerta.

Opções

--custom-description string

    Descrição personalizada do alerta.

--custom-summary string

    Resumo personalizado do alerta.

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

--parent-path string

    O caminho do espaço de trabalho da pasta que contém o alerta.

--run-as-user-name string

    A execução como nome de usuário ou ID do aplicativo da entidade de serviço.

Sinalizadores globais

Exemplos

O exemplo a seguir atualiza o nome de exibição de um 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

Sinalizadores globais

--debug

  Indica se deve habilitar o registro em log de depuração.

-h ou --help

    Exiba ajuda para a CLI do Databricks ou o grupo de comandos relacionado ou o comando relacionado.

--log-file corda

    Uma cadeia de caracteres que representa o arquivo onde serão gravados os logs de saída. Se esse sinalizador não for especificado, o padrão será gravar logs de saída no stderr.

--log-format formato

    O tipo de formato de log, text ou json. O valor padrão é text.

--log-level corda

    Uma cadeia de caracteres que representa o nível de formato de log. Se não for especificado, o nível de formato de log será desabilitado.

-o, --output tipo

    O tipo de saída do comando, text ou json. O valor padrão é text.

-p, --profile corda

    O nome do perfil no arquivo ~/.databrickscfg, que deverá ser usado para executar o comando. Se esse sinalizador não for especificado, se existir, o perfil nomeado DEFAULT será usado.

--progress-format formato

    O formato para exibir logs de progresso: default, append, inplace ou json

-t, --target corda

    Se aplicável, o destino do pacote a ser usado