Uso de acciones de escalado automático para enviar notificaciones de alerta por correo electrónico y Webhook en Azure Monitor

En este artículo se muestra cómo configurar notificaciones para que pueda llamar a direcciones URL web específicas o enviar mensajes de correo electrónico en función de las acciones de escalabilidad automática de Azure.

webhooks

Los webhooks permiten enviar solicitudes HTTP a un punto de conexión de dirección URL específico (dirección URL de devolución de llamada) cuando se produce un determinado evento o desencadenante. Mediante webhooks, puede automatizar y simplificar los procesos habilitando el intercambio automático de información entre diferentes sistemas o aplicaciones. Use webhooks para desencadenar código personalizado, notificaciones u otras acciones que se ejecutarán cuando se produzca un evento de escalado automático.

Correo electrónico

Puede enviar un correo electrónico a cualquier dirección de correo electrónico válida cuando se produzca un evento de escalado automático. También se enviará una notificación a los administradores y los coadministradores de la suscripción en la que se ejecuta la regla.

Configuración de notificaciones

Use las plantillas de Azure Portal, CLI, PowerShell o Resource Manager para configurar las notificaciones.

Portal

Configurar las notificaciones mediante Azure Portal.

Seleccione la pestaña Notificar en la página de configuración de escalabilidad automática para configurar las notificaciones.

Active las casillas para enviar un correo electrónico al administrador de la suscripción o a los coadministradores. También puede escribir una lista de direcciones de correo electrónico a las que enviar notificaciones.

Escriba un URI de webhook para enviar una notificación a un servicio web. También puede agregar encabezados personalizados a la solicitud de webhook. Por ejemplo, puede agregar un token de autenticación en el encabezado, los parámetros de consulta o agregar un encabezado personalizado para identificar el origen de la solicitud.

CLI

Use la CLI para configurar las notificaciones.

Use el comando az monitor autoscale update o az monitor autoscale create para configurar las notificaciones mediante la CLI de Azure.

Los parámetros siguientes se usan para configurar las notificaciones:

• --add-action: la acción que se realizará cuando se active la regla de escalabilidad automática. El valor debe ser email o webhook.
• --email-administrator {false, true}: enviar correo electrónico al administrador de la suscripción.
• --email-coadministrators {false, true}: enviar correo electrónico a los coadministradores de la suscripción.
• --remove-action: se ha quitado una acción agregada anteriormente por --add-action. El valor debe ser email o webhook. El parámetro solo es relevante para el comando az monitor autoscale update.

Por ejemplo, el siguiente comando añade una notificación por correo electrónico y una notificación de webhook a una configuración de escalabilidad automática existente. El comando también envía un correo electrónico al administrador de la suscripción.

 az monitor autoscale update \
--resource-group <resource group name> \
--name <autoscale setting name> \
--email-administrator true \
--add-action email pdavis@contoso.com \
--add-action webhook http://myservice.com/webhook-listerner-123

Nota

Puede añadir más de una notificación por correo electrónico o webhook utilizando el parámetro --add-action varias veces. Aunque se admiten varias notificaciones de webhook y se pueden ver en JSON, el portal solo muestra el primer webhook.

Para obtener más información, vea Escalabilidad automática de Azure Monitor.

PowerShell

Use PowerShell para configurar las notificaciones.

En el ejemplo siguiente se muestra cómo configurar un webhook y una notificación por correo electrónico.

1. Cree el objeto de webhook.

2. Cree el objeto de notificación.

3. Agregue el objeto de notificación a la configuración de escalabilidad automática mediante cmdlets New-AzAutoscaleSetting o Update-AzAutoscaleSetting.

# Assumining you have already created a profile object and have a vmssName, resourceGroup, and subscriptionId

 $webhook=New-AzAutoscaleWebhookNotificationObject  `
-Property @{"method"='GET'; "headers"= '"Authorization", "tokenvalue-12345678abcdef"'} `
-ServiceUri "http://myservice.com/webhook-listerner-123"

$notification=New-AzAutoscaleNotificationObject `
-EmailCustomEmail "pdavis@contoso.com" `
-EmailSendToSubscriptionAdministrator $true ` -EmailSendToSubscriptionCoAdministrator $true `
-Webhook $webhook


New-AzAutoscaleSetting -Name autoscalesetting2 `
-ResourceGroupName $resourceGroup `
-Location eastus `
-Profile $profile `
-Enabled -Notification $notification `
-PropertiesName "autoscalesetting" `
-TargetResourceUri "/subscriptions/$subscriptionId/resourceGroups/$resourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/$vmssName"

Resource Manager

Use plantillas de Resource Manager para configurar las notificaciones.

Al usar las plantillas de Resource Manager o la API de REST, incluya el elemento de notifications en la configuración de escalabilidad automática, por ejemplo:

"notifications": [
      {
        "operation": "Scale",
        "email": {
          "sendToSubscriptionAdministrator": false,
          "sendToSubscriptionCoAdministrators": false,
          "customEmails": [
              "user1@mycompany.com",
              "user2@mycompany.com"
              ]
        },
        "webhooks": [
          {
            "serviceUri": "https://my.webhook.example.com?token=abcd1234",
            "properties": {
              "optional_key1": "optional_value1",
              "optional_key2": "optional_value2"
            }
          }
        ]
      }
    ]

Campo	Mandatory	Descripción
operation	Sí	El valor debe ser "Scale".
sendToSubscriptionAdministrator	Sí	El valor debe ser "true" o "false".
sendToSubscriptionCoAdministrators	Sí	El valor debe ser "true" o "false".
customEmails	Sí	El valor puede ser null [] o una cadena de matriz de mensajes de correo electrónico.
webhooks	Sí	El valor puede ser null o un identificador URI válido.
serviceUri	Sí	URI HTTPS válido.
properties	Sí	El valor debe estar vacío {} o puede contener pares clave-valor.

Autenticación en Webhook

El webhook puede autenticarse automáticamente mediante un token, donde el URI del webhook se guarda con un identificador de token como un parámetro de consulta. Por ejemplo, https://mysamplealert/webcallback?tokenid=123-abc456-7890&myparameter2=value123.

Esquema de carga de Webhook de notificación de escalado automático

Cuando se genera la notificación de escalado automático, los metadatos siguientes se incluyen en la carga de Webhook:

{
    "version": "1.0",
    "status": "Activated",
    "operation": "Scale Out",
    "context": {
        "timestamp": "2023-06-22T07:01:47.8926726Z",
        "id": "/subscriptions/123456ab-9876-a1b2-a2b1-123a567b9f8767/resourceGroups/rg-001/providers/microsoft.insights/autoscalesettings/AutoscaleSettings-002",
        "name": "AutoscaleSettings-002",
        "details": "Autoscale successfully started scale operation for resource 'ScaleableAppServicePlan' from capacity '1' to capacity '2'",
        "subscriptionId": "123456ab-9876-a1b2-a2b1-123a567b9f8767",
        "resourceGroupName": "rg-001",
        "resourceName": "ScaleableAppServicePlan",
        "resourceType": "microsoft.web/serverfarms",
        "resourceId": "/subscriptions/123456ab-9876-a1b2-a2b1-123a567b9f8767/resourceGroups/rg-001/providers/Microsoft.Web/serverfarms/ScaleableAppServicePlan",
        "portalLink": "https://portal.azure.com/#resource/subscriptions/123456ab-9876-a1b2-a2b1-123a567b9f8767/resourceGroups/rg-001/providers/Microsoft.Web/serverfarms/ScaleableAppServicePlan",
        "resourceRegion": "West Central US",
        "oldCapacity": "1",
        "newCapacity": "2"
    },
    "properties": {
        "key1": "value1",
        "key2": "value2"
    }   
}

Campo	Mandatory	Descripción
status	Sí	Estado que indica que se ha generado una acción de escalabilidad automática.
operation	Sí	Para aumentar las instancias es "Escalabilidad horizontal" y para reducirlas es "Reducción horizontal".
context	Sí	Contexto de la acción de escalabilidad automática.
timestamp	Sí	Marca de tiempo de cuando se desencadenó la acción de escalabilidad automática.
id	Sí	Identificador de Resource Manager de la configuración de escalabilidad automática.
name	Sí	Nombre de la configuración de escalabilidad automática.
detalles	Sí	Explicación de la acción que realizó el servicio de escalabilidad automática y el cambio en el recuento de instancias.
subscriptionId	Sí	Identificador de suscripción del recurso de destino que se va a escalar.
resourceGroupName	Sí	Nombre del grupo de recursos del recurso de destino que se va a escalar.
resourceName	Sí	Nombre del recurso de destino que se va a escalar.
resourceType	Sí	Tres valores admitidos: "microsoft.classiccompute/domainnames/slots/roles" - Roles de Azure Cloud Services, "microsoft.compute/virtualmachinescalesets" - Azure Virtual Machine Scale Sets y "Microsoft.Web/serverfarms" - Característica Web App de Azure Monitor.
resourceId	Sí	Identificador de Resource Manager del recurso de destino que se va a escalar.
portalLink	Sí	Vínculo de Azure Portal a la página de resumen del recurso de destino.
oldCapacity	Sí	Recuento de instancias (antiguo) actual cuando la escalabilidad automática realizó una acción de escalado.
newCapacity	Sí	Nuevo recuento de instancias al que la escalabilidad automática escaló el recurso.
properties	No	Opcional. Conjunto de pares <Clave, Valor> (por ejemplo, Diccionario <Cadena, Cadena>). El campo de propiedades es opcional. En una interfaz de usuario personalizada o un flujo de trabajo basado en una aplicación lógica, puede especificar claves y valores que se pueden pasar utilizando la carga. Una forma alternativa de pasar propiedades personalizadas de vuelta a la llamada de webhook saliente es usar el propio URI de webhook (como parámetros de consulta).