Llamada a un webhook con una alerta de métrica clásica en Azure MonitorCall a webhook with a classic metric alert in Azure Monitor

Advertencia

En este artículo se describe cómo usar las alertas de métrica clásicas más antiguas.This article describes how to use older classic metric alerts. Azure Monitor ahora es compatible con una nueva experiencia de alertas y las más recientes alertas de métrica casi en tiempo real.Azure Monitor now supports newer near-real time metric alerts and a new alerts experience. Las alertas clásicas se han retirado para los usuarios de la nube pública, aunque siguen estando disponibles con uso limitado hasta el 31 de mayo de 2021.Classic alerts are retired for public cloud users, though still in limited use until 31 May 2021. Las alertas clásicas para la nube de Azure Government y Azure China 21Vianet se retirarán el 29 de febrero de 2024.Classic alerts for Azure Government cloud and Azure China 21Vianet will retire on 29 February 2024.

Puede usar los webhooks para redirigir una notificación de alerta de Azure a otros sistemas para su procesamiento posterior o acciones personalizadas.You can use webhooks to route an Azure alert notification to other systems for post-processing or custom actions. Puede usar un webhook en una alerta para redirigirla a servicios que envían mensajes SMS, para registrar errores, para notificar a un equipo mediante servicios de chat y mensajería o llevar a cabo otras acciones.You can use a webhook on an alert to route it to services that send SMS messages, to log bugs, to notify a team via chat or messaging services, or for various other actions.

En este artículo se describe cómo establecer un webhook en una alerta de métrica de Azure.This article describes how to set a webhook on an Azure metric alert. También muestra el aspecto de la carga útil para HTTP POST a un webhook.It also shows you what the payload for the HTTP POST to a webhook looks like. Para obtener información sobre la configuración y el esquema de una alerta de registro de actividad de Azure (alerta de eventos), consulte Llamada a un webhook cuando se activan alertas del registro de actividades de Azure.For information about the setup and schema for an Azure activity log alert (alert on events), see Call a webhook on an Azure activity log alert.

Las alertas de Azure usan HTTP POST para enviar el contenido de la alerta en formato JSON a un URI de webhook que se proporciona al crear la alerta.Azure alerts use HTTP POST to send the alert contents in JSON format to a webhook URI that you provide when you create the alert. El esquema se define más adelante en este artículo.The schema is defined later in this article. Este URI debe ser un punto de conexión HTTP o HTTPS válido.The URI must be a valid HTTP or HTTPS endpoint. Azure envía una entrada por cada solicitud cuando se activa una alerta.Azure posts one entry per request when an alert is activated.

Configuración de webhooks mediante Azure PortalConfigure webhooks via the Azure portal

Puede agregar o actualizar el URI de webhook, en Azure Portal, vaya a Create/Update Alerts (Crear/Actualizar alertas).To add or update the webhook URI, in the Azure portal, go to Create/Update Alerts.

Adición de un panel de regla de alerta

También puede configurar una alerta para enviarla a un URI de webhook mediante los cmdlets de Azure PowerShell, la CLI multiplataforma o la API de REST de Azure Monitor.You can also configure an alert to post to a webhook URI by using Azure PowerShell cmdlets, a cross-platform CLI, or Azure Monitor REST APIs.

Autenticación del webhookAuthenticate the webhook

El webhook puede autenticarse mediante una autorización basada en token.The webhook can authenticate by using token-based authorization. El URI del webhook se guarda con un identificador de token.The webhook URI is saved with a token ID. Por ejemplo: https://mysamplealert/webcallback?tokenid=sometokenid&someparameter=somevalueFor example: https://mysamplealert/webcallback?tokenid=sometokenid&someparameter=somevalue

Esquema de cargaPayload schema

La operación POST contiene el siguiente esquema y carga útil de JSON para todas las alertas basadas en métricas:The POST operation contains the following JSON payload and schema for all metric-based alerts:

{
    "status": "Activated",
    "context": {
        "timestamp": "2015-08-14T22:26:41.9975398Z",
        "id": "/subscriptions/s1/resourceGroups/useast/providers/microsoft.insights/alertrules/ruleName1",
        "name": "ruleName1",
        "description": "some description",
        "conditionType": "Metric",
        "condition": {
            "metricName": "Requests",
            "metricUnit": "Count",
            "metricValue": "10",
            "threshold": "10",
            "windowSize": "15",
            "timeAggregation": "Average",
            "operator": "GreaterThanOrEqual"
        },
        "subscriptionId": "s1",
        "resourceGroupName": "useast",
        "resourceName": "mysite1",
        "resourceType": "microsoft.foo/sites",
        "resourceId": "/subscriptions/s1/resourceGroups/useast/providers/microsoft.foo/sites/mysite1",
        "resourceRegion": "centralus",
        "portalLink": "https://portal.azure.com/#resource/subscriptions/s1/resourceGroups/useast/providers/microsoft.foo/sites/mysite1"
    },
    "properties": {
        "key1": "value1",
        "key2": "value2"
    }
}
CampoField MandatoryMandatory Conjunto fijo de valoresFixed set of values NotasNotes
statusstatus YY Activado, ResueltoActivated, Resolved Estado de la alerta en función de las condiciones que haya establecido.The status for the alert based on the conditions you set.
contextcontext YY Contexto de la alertaThe alert context.
timestamptimestamp YY La hora en la que se desencadenó la alerta.The time at which the alert was triggered.
idid YY Cada regla de alerta tiene un identificador único.Every alert rule has a unique ID.
namename YY Nombre de la alertaThe alert name.
descriptiondescription YY Descripción de la alerta.A description of the alert.
conditionTypeconditionType YY Métrica, EventoMetric, Event Se admiten dos tipos de alertas: métrica y evento.Two types of alerts are supported: metric and event. Las alertas de métrica se basan en una condición de métrica.Metric alerts are based on a metric condition. Las alertas de evento se basan en un evento del registro de actividad.Event alerts are based on an event in the activity log. Use este valor para comprobar si la alerta está basada en una métrica o en un evento.Use this value to check whether the alert is based on a metric or on an event.
condicióncondition YY Los campos específicos que buscar en función del campo conditionType.The specific fields to check based on the conditionType value.
metricNamemetricName Para alertas de métricasFor metric alerts El nombre de la métrica que define qué supervisa la regla.The name of the metric that defines what the rule monitors.
metricUnitmetricUnit Para alertas de métricasFor metric alerts Bytes, BytesPerSecond, Count, CountPerSecond, Percent, SecondsBytes, BytesPerSecond, Count, CountPerSecond, Percent, Seconds La unidad permitida en la métrica.The unit allowed in the metric. Consulte Valores permitidos.See allowed values.
metricValuemetricValue Para alertas de métricasFor metric alerts Valor real de la métrica que causó la alertaThe actual value of the metric that caused the alert.
thresholdthreshold Para alertas de métricasFor metric alerts Valor de umbral en el que se activa la alertaThe threshold value at which the alert is activated.
windowSizewindowSize Para alertas de métricasFor metric alerts El período de tiempo que se usa para supervisar la actividad de la alerta según el umbral.The period of time that's used to monitor alert activity based on the threshold. El valor debe estar comprendido entre 5 minutos y 1 día.The value must be between 5 minutes and 1 day. El valor debe tener el formato de duración ISO 8601.The value must be in ISO 8601 duration format.
timeAggregationtimeAggregation Para alertas de métricasFor metric alerts Average, Last, Maximum, Minimum, None, TotalAverage, Last, Maximum, Minimum, None, Total La manera en que se recopilan los datos se debería combinar con el tiempo.How the data that's collected should be combined over time. El valor predeterminado es Average.The default value is Average. Consulte Valores permitidos.See allowed values.
operatoroperator Para alertas de métricasFor metric alerts Operador usado para comparar los datos de métrica actuales con el umbral establecido.The operator that's used to compare the current metric data to the set threshold.
subscriptionIdsubscriptionId YY El identificador de la suscripción de Azure.The Azure subscription ID.
resourceGroupNameresourceGroupName YY Nombre del grupo de recursos del recurso afectado.The name of the resource group for the affected resource.
resourceNameresourceName YY Nombre del recurso afectado.The resource name of the affected resource.
resourceTyperesourceType YY Tipo del recurso afectado.The resource type of the affected resource.
resourceIdresourceId YY Identificador de recurso del recurso afectado.The resource ID of the affected resource.
resourceRegionresourceRegion YY Región o ubicación del recurso afectado.The region or location of the affected resource.
portalLinkportalLink YY Vínculo directo a la página de resumen de recursos del portal.A direct link to the portal resource summary page.
propertiesproperties NN OpcionalOptional Conjunto de pares clave/valor que incluye detalles sobre el evento.A set of key/value pairs that has details about the event. Por ejemplo, Dictionary<String, String>.For example, Dictionary<String, String>. El campo de propiedades es opcional.The properties field is optional. En un flujo de trabajo basado en una aplicación lógica o una interfaz de usuario personalizada, los usuarios pueden especificar pares clave/valores que se pueden pasar con la carga útil.In a custom UI or logic app-based workflow, users can enter key/value pairs that can be passed via the payload. Una forma alternativa para pasar propiedades personalizadas a la webhook es mediante el propio URI de webhook (como parámetros de consulta).An alternate way to pass custom properties back to the webhook is via the webhook URI itself (as query parameters).

Nota

Solo se puede establecer el campo de propiedades mediante la API de REST de Azure Monitor.You can set the properties field only by using Azure Monitor REST APIs.

Pasos siguientesNext steps