Mudar preferência de API para os Alertas de LogSwitch API preference for Log Alerts

Observação

Conteúdo declarado aplicável a usuários somente na nuvem pública do Azure e não para o Azure governamental ou para a nuvem do Azure China.Content stated applicable to users Azure public cloud only and not for Azure Government or Azure China cloud.

Até recentemente, você gerenciava regras de alerta no Portal do Microsoft Operations Management Suite.Until recently, you managed alert rules in the Microsoft Operations Management Suite portal. A nova experiência de alertas foi integrada a vários serviços no Microsoft Azure, incluindo o Log Analytics, e solicitamos estender as regras de alerta do portal do OMS para o Azure.The new alerts experience was integrated with various services in Microsoft Azure including Log Analytics and we asked to extend your alert rules from OMS portal to Azure. Mas, para assegurar o mínimo de interrupção para os clientes, o processo não alterou a interface programática do seu consumo – API de alerta do Log Analytics com base em SavedSearch.But to ensure minimal disruption for customers, the process did not alter the programmatic interface for its consumption - Log Analytics Alert API based on SavedSearch.

Mas agora você anuncia para os usuários de alerta do Log Analytics uma verdadeira alternativa programática do Azure, Azure Monitor – API ScheduledQueryRules, que também se reflete em sua Cobrança do Azure – para alertas de log.But now you announce for Log Analytics alerting users a true Azure programmatic alternative, Azure Monitor - ScheduledQueryRules API, which is also reflective in your Azure billing - for log alerts. Para saber mais sobre como gerenciar seus alertas de log usando a API, consulte Gerenciando alertas de log usando o modelo de recursos do Azure e Gerenciando alertas de log usando o PowerShell.To learn more on how to manage your log alerts using the API, see Managing log alerts using Azure Resource Template and Managing log alerts using PowerShell.

Benefícios de mudar para a nova API do AzureBenefits of switching to new Azure API

Há várias vantagens em criar e gerenciar alertas usando a API scheduledQueryRules em relação à API herdada de alerta do Log Analytics; listamos algumas das principais abaixo:There are several advantages of creating and managing alerts using scheduledQueryRules API over legacy Log Analytics Alert API; we have listed some of the major ones below:

  • Capacidade de realizar pesquisa de logs entre workspaces em regras de alerta e abranger recursos externos como workspaces do Log Analytics ou até mesmo aplicativos do Application InsightsAbility to cross workspace log search in alert rules and span up external resources like Log Analytics workspaces or even Application Insights apps
  • Quando vários campos são usados para Agrupar na consulta usando a API scheduledQueryRules, o usuário pode especificar qual campo agregar no portal do AzureWhen multiple fields used to Group in query, using scheduledQueryRules API user can specify which field to aggregate-on in Azure portal
  • Alertas de log criados usando a API scheduledQueryRules podem ter um período definido de até 48 horas e buscar dados por um período mais longo que antesLog alerts created using scheduledQueryRules API can have period defined up to 48 hours and fetch data for longer period than before
  • Criar regras de alerta de uma só vez como um único recurso sem a necessidade de criar três níveis de recursos como ocorre com a API herdada de alerta do Log AnalyticsCreate alert rules in one shot as a single resource without the need to create three levels of resources as with legacy Log Analytics Alert API
  • Interface de programação única para todas as variantes de alertas de log baseados em consulta no Azure – a nova API scheduledQueryRules pode ser usada para gerenciar regras do Log Analytics, bem como do Application InsightsSingle programmatic interface for all variants of query-based log alerts in Azure - new scheduledQueryRules API can be used to manage rules for Log Analytics as well as Application Insights
  • Gerenciar seus alertas de log usando cmdlets do PowerShellManage your log alerts using Powershell cmdlets
  • Todas as novas funcionalidades de alertas de log e de desenvolvimento futuro estarão disponíveis somente por meio da nova API scheduledQueryRulesAll new log alert functionality and future development will be available only via the new scheduledQueryRules API

Processo de mudar da API herdada de alertas de logProcess of switching from legacy Log Alerts API

Os usuários são livres para usar a API herdada de alertas do Log Analytics ou a nova API scheduledQueryRules.Users are free to use either legacy Log Analytics Alert API or the new scheduledQueryRules API. As regras de alerta criadas por qualquer API serão gerenciáveis somente pela mesma API – bem como do portal do Azure.Alert rules created by either API, will be manageable by the same API only - as well as from Azure portal. Por padrão, Azure Monitor continuará a usar a API de alerta log Analytics herdada para criar qualquer nova regra de alerta de portal do Azure para os espaços de trabalho existentes do log Analytics.By default, Azure Monitor will continue to use legacy Log Analytics Alert API for creating any new alert rule from Azure portal for existing workspaces of Log Analytics. Conforme anunciado novo espaço de trabalho de log criado em ou após 1º de junho de 2019, o usará automaticamente a nova API scheduledQueryRules por padrão, incluindo em portal do Azure.As announced new Log workspace created on or after June 1, 2019 - will automatically use new scheduledQueryRules API by default including in Azure portal.

Os impactos da mudança de preferência para a API scheduledQueryRules são compilados abaixo:The impacts of the switch of preference to scheduledQueryRules API are compiled below:

O processo de mudar as regras de alerta da API herdada de alertas do Log Analytics não envolve a mudança da definição, consulta ou configuração do alerta de nenhuma maneira.The process of moving alert rules from legacy Log Analytics Alert API does not involve changing your alert definition, query, or configuration in any way. Suas regras de alerta e o monitoramento não são afetados e os alertas não serão interrompidos ou não serão interrompidos durante ou após o comutador.Your alert rules and monitoring are unaffected and the alerts will not stop or be stalled, during or after the switch. A única alteração é uma alteração na preferência da API e o acesso às suas regras por meio de uma nova API.The only change is a change in API preference and access to your rules via a new API.

Observação

Depois que um usuário opta por alternar a preferência para a nova API scheduledQueryRules, não é possível optar por voltar ou reverter para usar a API de alerta herdadamais antiga do log Analytics.Once a user opts to switch preference to the new scheduledQueryRules API, the you cannot opt back or revert to using of the older legacy Log Analytics Alert API.

Qualquer cliente que desejar mudar voluntariamente para a nova scheduledQueryRules e bloquear o uso da API herdada de alertas do Log Analytics poderá fazer isso executando uma chamada PUT na API abaixo para mudar todas as regras de alerta associadas ao espaço de trabalho do Log Analytics específico.Any customer who wishes to switch voluntarily to the new scheduledQueryRules and block usage from the legacy Log Analytics Alert API; can do so by performing a PUT call on the below API to switch all alert rules associated with the specific Log Analytics workspace.

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

Com o corpo da solicitação contendo o JSON abaixo.With request body containing the below JSON.

{
    "scheduledQueryRulesEnabled" : true
}

A API também pode ser acessada por meio de uma linha de comando do PowerShell usando o ARMClient, uma ferramenta de linha de comando de software livre que simplifica a invocação da API do Azure Resource Manager.The API can also be accessed from a PowerShell command line using ARMClient, an open-source command-line tool that simplifies invoking the Azure Resource Manager API. Conforme ilustrado abaixo, na chamada PUT de exemplo, a ferramenta ARMclient é usada para alternar todas as regras de alerta associadas ao espaço de trabalho do Log Analytics específico.As illustrated below, in sample PUT call using ARMclient tool to switch all alert rules associated with the specific Log Analytics workspace.

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

Se a mudança de todas as regras de alerta no espaço de trabalho do Log Analytics para usar a nova scheduledQueryRules for bem-sucedida, a seguinte resposta será fornecida.If switch of all alert rules in the Log Analytics workspace to use new scheduledQueryRules is successful, the following response will be provided.

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

Os usuários também podem verificar o status atual do espaço de trabalho do Log Analytics e ver se a mudança foi realizada ou não para ele usar somente a scheduledQueryRules.Users can also check the current status of your Log Analytics workspace and see if it has or has not been switched to use scheduledQueryRules only. Para verificar, os usuários podem realizar uma chamada GET na API abaixo.To check, users can perform a GET call on the below API.

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

Para executar os itens acima usando a linha de comando do PowerShell com a ferramenta ARMClient, confira o exemplo a seguir.To execute the above in using PowerShell command line using ARMClient tool, see the sample below.

armclient GET /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 especificado tiver mudado para usar somente a scheduledQueryRules, o JSON de resposta será conforme listado abaixo.If the specified Log Analytics workspace has been switched to use scheduledQueryRules only; then the response JSON will be as listed below.

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

Além do mais, se o workspace do Log Analytics especificado ainda não tiver sido mudado para usar somente a scheduledQueryRules, o JSON de resposta será conforme listado abaixo.Else, if the specified Log Analytic workspace has not yet been switched to use scheduledQueryRules only; then the response JSON will be as listed below.

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

Próximas etapasNext steps