Use ações de dimensionamento automático para enviar notificações de alerta por email e webhook no Azure Monitor

Este artigo mostra como configurar notificações para que você possa chamar URLs da Web específicas ou enviar emails com base em ações de dimensionamento automático no Azure.

Webhooks

Os webhooks permitem que você envie solicitações HTTP para um ponto de extremidade de URL específico (URL de retorno de chamada) quando ocorre um determinado evento ou gatilho. Usando webhooks, você pode automatizar e simplificar processos habilitando a troca automática de informações entre diferentes sistemas ou aplicativos. Use webhooks para disparar código personalizado, notificações ou outras ações a serem executadas quando ocorrer um evento de dimensionamento automático.

Email

Você pode enviar email para qualquer endereço de email válido quando ocorrer um evento de dimensionamento automático. Os administradores e coadministradores da assinatura em que a regra está em execução também são notificados.

Configurar notificações

Use os modelos portal do Azure, CLI, PowerShell ou Resource Manager para configurar notificações.

Portal

Configure as notificações usando o portal do Azure.

Selecione a guia Notificar na página de configurações de dimensionamento automático para configurar as notificações.

Selecione as caixas de seleção para enviar um email para o administrador da assinatura ou coadministradores. Você também pode inserir uma lista de endereços de email para os quais enviar notificações.

Insira um URI de webhook para enviar uma notificação a um serviço Web. Você também pode adicionar cabeçalhos personalizados à solicitação de webhook. Por exemplo, você pode adicionar um token de autenticação no cabeçalho, consultar parâmetros ou adicionar um cabeçalho personalizado para identificar a origem da solicitação.

CLI

Use a CLI para configurar notificações.

Use o comando az monitor autoscale update ou az monitor autoscale create para configurar notificações usando a CLI do Azure.

Os seguintes parâmetros são usados para configurar notificações:

• --add-action - A ação a ser executada quando a regra de dimensionamento automático for acionada. O valor deve ser email ou webhook.
• --email-administrator {false, true} – Enviar email para o administrador da assinatura.
• --email-coadministrators {false, true} – Enviar email para os coadministradores da assinatura.
• --remove-action – Remover uma ação adicionada anteriormente por --add-action. O valor deve ser email ou webhook. O parâmetro só é relevante para o comando az monitor autoscale update.

Por exemplo, o comando a seguir adiciona uma notificação por e-mail e uma notificação por webhook a uma configuração de dimensionamento automático existente. O comando também envia um email para o administrador da assinatura.

 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

Observação

Você pode adicionar mais de um email ou notificação de webhook usando o parâmetro --add-action várias vezes. Embora várias notificações de webhook sejam compatíveis e possam ser vistas no JSON, o portal mostra apenas o primeiro webhook.

Para obter mais informações, confira Dimensionamento automático do Azure.

PowerShell

Use o PowerShell para configurar notificações.

O exemplo a seguir mostra como configurar um webhook e uma notificação por email.

1. Criar o objeto webhook.

2. Criar o objeto de notificação.

3. Adicionar o objeto de notificação à configuração de dimensionamento automático usando os cdmlets New-AzAutoscaleSettingou 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

Usar modelos do Resource Manager para configurar notificações.

Ao usar a API REST ou os modelos do Resource Manager, inclua o elemento notifications nas configurações de dimensionamento automático, por exemplo:

"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	Obrigatório	Descrição
operation	Sim	O valor precisa ser "Scale".
sendToSubscriptionAdministrator	Sim	O valor precisa ser "true" ou "false".
sendToSubscriptionCoAdministrators	Sim	O valor precisa ser "true" ou "false".
customEmails	Yes	O valor pode ser null [] ou uma matriz da cadeia de caracteres de emails.
Webhooks	Sim	O valor pode ser um Uri válido ou nulo.
serviceUri	Yes	URI HTTPS válido.
properties	Sim	O valor precisa ser vazio {} ou pode conter pares chave-valor.

Autenticação em webhooks

O webhook pode se autenticar usando a autenticação baseada em token, em que você salva o URI do webhook com uma ID de token como um parâmetro de consulta. Por exemplo, https://mysamplealert/webcallback?tokenid=123-abc456-7890&myparameter2=value123.

Escala automática do esquema de carga útil do webhook de notificação

Quando a notificação de escala automática é gerada, os metadados a seguir são incluídos na carga útil do 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	Obrigatório	Descrição
status	Sim	O status que indica que uma ação de dimensionamento automático foi gerada.
operação	Sim	Para um aumento de instâncias, é "Escalar horizontalmente". Para uma redução de instâncias, é "Reduzir horizontalmente".
contexto	Sim	Contexto de ação de dimensionamento automático.
timestamp	Sim	Carimbo de data/hora de quando a ação de dimensionamento automático foi disparada.
id	Sim	ID do Resource Manager da configuração de dimensionamento automático.
name	Sim	O nome da configuração de dimensionamento automático.
detalhes	Sim	Explicação da ação que o serviço de dimensionamento automático realizou a alteração na contagem da instâncias.
subscriptionId	Sim	ID da assinatura do recurso de destino que está sendo dimensionado.
resourceGroupName	Sim	Nome do grupo de recursos do recurso de destino que está sendo dimensionado.
resourceName	Sim	Nome do recurso de destino que está sendo dimensionado.
resourceType	Sim	Três valores com suporte: "microsoft.classiccompute/domainnames/slots/roles" – Funções dos Serviços de Nuvem do Azure, "microsoft.compute/virtualmachinescalesets" – Conjuntos de Dimensionamento de Máquinas Virtuais do Azure e "Microsoft.Web/serverfarms" – Recurso de aplicativo Web do Azure Monitor.
resourceId	Sim	ID do Resource Manager do recurso de destino que está sendo dimensionado.
portalLink	Sim	Link do portal do Azure para a página de resumo do recurso de destino.
oldCapacity	Sim	Contagem de instâncias atuais (antigas) quando o dimensionamento automático realizou uma ação de dimensionamento.
newCapacity	Sim	Nova contagem de instâncias para a qual o dimensionamento automático dimensionou o recurso.
properties	Não	Opcional. Conjunto de <pares de Chave, Valor> (por exemplo, Dicionário <Cadeia de caracteres, Cadeia de caracteres>). O campo de propriedades é opcional. Em uma interface do usuário personalizada ou em um fluxo de trabalho baseado em aplicativo lógico, você pode inserir as chaves e os valores que podem ser passados usando o conteúdo. Uma forma alternativa de retornar as propriedades personalizadas para a chamada de saída do webhook é usar o próprio URI do webhook (como parâmetros de consulta).