Pular para o conteúdo principal

alerts-v2 grupo de comandos

nota

Esta informação aplica-se às versões 0.205 e acima Databricks CLI . A CLI do Databricks está em versão prévia pública.

O uso CLI Databricks está sujeito à LicençaDatabricks e ao Aviso de PrivacidadeDatabricks, incluindo qualquer fornecimento de Dados de Uso.

O grupo de comandos alerts-v2 dentro da CLIDatabricks permite gerenciar alertas SQL . Um alerta executa periodicamente uma consulta, avalia uma condição do resultado e notifica um ou mais usuários e/ou destinos de notificação se a condição for atendida.

alerta-v2 do databricks criar-alerta

Criar um alerta.

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

Argumentos

DISPLAY_NAME

O nome de exibição do alerta.

QUERY_TEXT

Texto da consulta a ser executada.

WAREHOUSE_ID

ID do SQL warehouse associado ao alerta.

EVALUATION

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

SCHEDULE

O programa para executar a consulta de alerta.

Opções

--custom-description string

Descrição personalizada para o alerta.

--custom-summary string

Resumo personalizado para o alerta.

--json JSON

As strings JSON embutidas ou o @caminho para o arquivo JSON com o corpo da requisição.

--parent-path string

O caminho do workspace 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.

Bandeiras globais

Exemplos

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

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

databricks alerta-v2 get-alerta

Receba um alerta.

databricks alerts-v2 get-alert ID [flags]

Argumentos

ID

O UUID do alerta a ser recuperado.

Opções

Bandeiras globais

Exemplos

O exemplo a seguir gera um alerta por ID:

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

alerta-v2 do databricks lista-alerta

Alerta de lista. Obtém uma lista de alertas acessíveis ao usuário, ordenados por data de criação.

databricks alerts-v2 list-alerts [flags]

Argumentos

Nenhuma

Opções

--page-size int

Número máximo de alertas a serem retornados.

--page-token string

Os tokens de página de uma lista anterior são usados para recuperar a próxima página.

Bandeiras globais

Exemplos

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

Bash
databricks alerts-v2 list-alerts

alerta-v2 do databricks alerta-lixo

Apagar um alerta. Move um alerta para a lixeira. Os alertas excluídos desaparecem imediatamente da lista e não podem mais ser acionados. Você pode restaurar um alerta excluído através da interface do usuário. Um alerta marcado como lixo é excluído permanentemente após 30 dias.

databricks alerts-v2 trash-alert ID [flags]

Argumentos

ID

O UUID do alerta para a lixeira.

Opções

--purge

Se deseja excluir o alerta permanentemente.

Bandeiras globais

Exemplos

O exemplo a seguir descarta um alerta:

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

O exemplo a seguir exclui permanentemente um alerta:

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

alerta-v2 do databricks atualização-alerta

Atualizar um alerta.

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

Argumentos

ID

UUID que identifica o alerta.

UPDATE_MASK

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

DISPLAY_NAME

O nome de exibição do alerta.

QUERY_TEXT

Texto da consulta a ser executada.

WAREHOUSE_ID

ID do SQL warehouse associado ao alerta.

EVALUATION

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

SCHEDULE

O programa para executar a consulta de alerta.

Opções

--custom-description string

Descrição personalizada para o alerta.

--custom-summary string

Resumo personalizado para o alerta.

--json JSON

As strings JSON embutidas ou o @caminho para o arquivo JSON com o corpo da requisição.

--parent-path string

O caminho do workspace 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.

Bandeiras globais

Exemplos

O exemplo a seguir atualiza o nome de exibição de um alerta:

Bash
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

Bandeiras globais

--debug

Ativar ou não o registro de depuração.

-h ou --help

Exibir ajuda para a CLI Databricks , o grupo de comandos relacionado ou o comando específico.

--log-file string

Uma sequência de caracteres representando o arquivo no qual logs de saída serão gravados. Se essa opção não for especificada, o default é gravar logs de saída em stderr.

--log-format Formato

O tipo de formato de log, text ou json. O valor default é text.

--log-level string

Uma sequência de caracteres representando o nível de formato log . Caso não seja especificado, o nível de formato log será desativado.

-o, --output Tipo

O tipo de saída do comando, text ou json. O valor default é text.

-p, --profile string

O nome do perfil no arquivo ~/.databrickscfg a ser usado para executar o comando. Se este sinalizador não for especificado, então, se existir, o perfil denominado DEFAULT será usado.

--progress-format Formato

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

-t, --target string

Se aplicável, o pacote de destino a ser usado.