Atualizar para a API de Regras de Consulta Agendada a partir da API de Alerta do Log Analytics herdada

  • Artigo

Importante

Conforme anunciado, a API de alerta do Log Analytics será desativada em 1º de outubro de 2025. Você deve fazer a transição para usar a API de Regras de Consulta Agendada para alertas de pesquisa de log até essa data. Os espaços de trabalho do Log Analytics criados após 1º de junho de 2019 usam a API scheduledQueryRules para gerenciar regras de alerta de pesquisa de log. Mude para a API atual em espaços de trabalho mais antigos para aproveitar os benefícios scheduledQueryRules do Azure Monitor. Depois de migrar regras para a API scheduledQueryRules, não é possível reverter para a API de alerta do Log Analytics herdada mais antiga.

No passado, os usuários usavam a API de alerta do Log Analytics herdada para gerenciar as regras de alerta de pesquisa de log. Atualmente, os espaços de trabalho usam a API de Regras de Consulta Agendada para novas regras. Este artigo descreve os benefícios e o processo de alternar o gerenciamento de regras de alerta de pesquisa de log herdado da API herdada para a API atual.

Benefícios

  • Gerencie todas as regras de alerta de pesquisa de log em uma API.
  • Modelo único para a criação de regras de alerta (anteriormente eram necessários três modelos separados).
  • API única para todos os alertas de log de recursos do Azure.
  • Suporte para alertas stateful (visualização) e de pesquisa de log de 1 minuto.
  • Cmdlets do PowerShell e suporte à CLI do Azure para regras comutadas.
  • Alinhamento das gravidades com todos os outros tipos de alerta e regras mais recentes.
  • Capacidade de criar um alerta de log entre espaços de trabalho que abrange vários recursos externos, como espaços de trabalho do Log Analytics ou recursos do Application Insights para regras comutadas.
  • Os usuários podem especificar dimensões para dividir os alertas para regras comutadas.
  • Os alertas de pesquisa de log têm um período estendido de até dois dias de dados (anteriormente limitado a um dia) para regras comutadas.

Impacto

  • Todas as regras comutadas devem ser criadas/editadas com a API atual. Veja o uso de exemplo por meio do Modelo de Recursos do Azure e o uso de exemplo por meio do PowerShell.
  • À medida que as regras se tornam recursos rastreados do Azure Resource Manager na API atual e devem ser exclusivas, as IDs de recursos para as regras mudam para esta estrutura: <WorkspaceName>|<savedSearchId>|<scheduleId>|<ActionId>. Os nomes de exibição das regras de alerta permanecem inalterados.

Processo

Exiba espaços de trabalho para atualizar usando esta consulta do Azure Resource Graph Explorer. Abra o link, selecione todas as assinaturas disponíveis e execute a consulta.

O processo de mudança não é interativo e não requer etapas manuais, na maioria dos casos. Suas regras de alerta não são interrompidas ou paralisadas, durante ou após a mudança. Faça esta chamada para alternar todas as regras de alerta associadas a cada um dos espaços de trabalho do Log Analytics:

PUT /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.OperationalInsights/workspaces/<workspaceName>/alertsversion?api-version=2017-04-26-preview

Com corpo de solicitação contendo o JSON abaixo:

{
    "scheduledQueryRulesEnabled" : true
}

Aqui está um exemplo de uso do ARMClient, uma ferramenta de linha de comando de código aberto, que simplifica a invocação da chamada de API acima:

$switchJSON = '{"scheduledQueryRulesEnabled": true}'
armclient PUT /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.OperationalInsights/workspaces/<workspaceName>/alertsversion?api-version=2017-04-26-preview $switchJSON

Você também pode usar a ferramenta CLI do Azure:

az rest --method put --url /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.OperationalInsights/workspaces/<workspaceName>/alertsversion?api-version=2017-04-26-preview --body "{\"scheduledQueryRulesEnabled\" : true}"

Se a mudança for bem-sucedida, a resposta é:

{
    "version": 2,
    "scheduledQueryRulesEnabled" : true
}

Verificar o estado de comutação da área de trabalho

Você também pode usar esta chamada de API para verificar o status do switch:

GET /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.OperationalInsights/workspaces/<workspaceName>/alertsversion?api-version=2017-04-26-preview

Você também pode usar a ferramenta ARMClient :

armclient GET /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.OperationalInsights/workspaces/<workspaceName>/alertsversion?api-version=2017-04-26-preview

Você também pode usar a ferramenta CLI do Azure:

az rest --method get --url /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.OperationalInsights/workspaces/<workspaceName>/alertsversion?api-version=2017-04-26-preview

Se o espaço de trabalho do Log Analytics tiver sido alternado para a API scheduledQueryRules, a resposta será:

{
    "version": 2,
    "scheduledQueryRulesEnabled" : true
}

Se o espaço de trabalho do Log Analytics não tiver sido trocado, a resposta será:

{
    "version": 2,
    "scheduledQueryRulesEnabled" : false
}

Próximos passos