Actualización a la API de alertas de registro actual desde la API de alertas heredada de Log AnalyticsUpgrade to the current Log Alerts API from legacy Log Analytics Alert API

Nota

Este artículo solo es pertinente para la nube pública de Azure (no para la nube de Azure Government ni de Azure China).This article is only relevant to Azure public (not to Azure Government or Azure China cloud).

Nota

Cuando un usuario opta por cambiar la preferencia a la versión scheduledQueryRules API actual, no puede revertir la elección para usar la versión anterior Alert API de Log Analytics heredada.Once a user chooses to switch preference to the current scheduledQueryRules API it is not possible to revert back to the older legacy Log Analytics Alert API.

En el pasado, los usuarios usaban Alert API de Log Analytics heredada para administrar las reglas de alertas de registro.In the past, users used the legacy Log Analytics Alert API to manage log alert rules. Las áreas de trabajo actuales usan ScheduledQueryRules API.Current workspaces use ScheduledQueryRules API. En este artículo se describen las ventajas y el proceso de cambio de la API heredada a la API actual.This article describes the benefits and the process of switching from the legacy API to the current API.

VentajasBenefits

  • Una sola plantilla para la creación de reglas de alertas (antes se necesitaban tres plantillas independientes).Single template for creation of alert rules (previously needed three separate templates).
  • API única para las áreas de trabajo de Log Analytics y los recursos de Application Insights.Single API for both Log Analytics workspaces or Application Insights resources.
  • Compatibilidad con cmdlets de PowerShell.PowerShell cmdlets support.
  • Correspondencia de la gravedad con los demás tipos de alerta.Alignment of severities with all other alert types.
  • Capacidad para crear alertas de registro entre áreas de trabajo que abarcan varios recursos externos, como áreas de trabajo de Log Analytics o recursos de Application Insights.Ability to create cross workspace log alert that span several external resources like Log Analytics workspaces or Application Insights resources.
  • Los usuarios pueden especificar dimensiones para dividir las alertas mediante el parámetro "Agregado en".Users can specify dimensions to split the alerts by using the 'Aggregate On' parameter.
  • Las alertas de registro tienen un período de hasta dos días de datos (antes estaba limitado a un día).Log alerts have extended period of up to two days of data (previously limited to one day).

ImpactoImpact

  • Todas las nuevas reglas deben crearse o editarse con la API actual.All new rules must be created/edited with the current API. Consulte el ejemplo de uso mediante la plantilla de Azure Resource y el ejemplo de uso mediante PowerShell.See sample use via Azure Resource Template and sample use via PowerShell.
  • A medida que las reglas se convierten en recursos con seguimiento de Azure Resource Manager en la API actual y deben pasar a ser recursos únicos, el identificador de recurso de las reglas cambiará a esta estructura: <WorkspaceName>|<savedSearchId>|<scheduleId>|<ActionId>.As rules become Azure Resource Manager tracked resources in the current API and must be unique, rules resource ID will change to this structure: <WorkspaceName>|<savedSearchId>|<scheduleId>|<ActionId>. El nombre para mostrar de la regla de alertas se mantendrá sin cambios.Display names of the alert rule will remain unchanged.

ProcesoProcess

El proceso de cambio no es interactivo y no precisa pasos manuales, en la mayoría de los casos.The process of switching isn't interactive and doesn't require manual steps, in most cases. Las reglas de alertas no se detienen durante el cambio ni después de él.Your alert rules aren't stopped or stalled, during or after the switch. Realice esta llamada para cambiar todas las reglas de alertas asociadas con el área de trabajo de Log Analytics específica:Do this call 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

El cuerpo de la solicitud debe contener el siguiente código JSON:With request body containing the below JSON:

{
    "scheduledQueryRulesEnabled" : true
}

Este es un ejemplo del uso de ARMClient, una herramienta de línea de comandos de código abierto que simplifica la invocación de la llamada API anterior:Here is an example of using ARMClient, an open-source command-line tool, that simplifies invoking the above API call:

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

Si el cambio se realiza correctamente, se muestra la siguiente respuesta:If the switch is successful, the response is:

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

Comprobación del estado del cambio del área de trabajoCheck switching status of workspace

También puede usar esta llamada API para comprobar el estado del cambio:You can also use this API call to check the switch status:

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

Puede usar también la herramienta ARMClient:You can also use ARMClient tool:

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

Si el área de trabajo de Log Analytics cambió a scheduledQueryRules API, se muestra la siguiente respuesta:If the Log Analytics workspace was switched to scheduledQueryRules API, the response is:

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

Si no se efectuó el cambio en el área de trabajo Log Analytics, se muestra la siguiente respuesta:If the Log Analytics workspace wasn't switched, the response is:

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

Pasos siguientesNext steps