Usar ações de dimensionamento automático para enviar notificações de alerta de 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

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 agilizar processos, permitindo a troca automática de informações entre diferentes sistemas ou aplicativos. Use webhooks para acionar código personalizado, notificações ou outras ações a serem executadas quando ocorrer um evento de dimensionamento automático.

E-mail

Você pode enviar e-mails para qualquer endereço de e-mail válido quando ocorrer um evento de dimensionamento automático.

Nota

A partir de 3 de abril de 2024, você não poderá adicionar novos Coadministradores para Notificações de Dimensionamento Automático do Azure. Os administradores do Azure Classic serão desativados em 31 de agosto de 2024 e você não poderá enviar notificações de dimensionamento automático do Azure usando administradores e coadministradores após 31 de agosto de 2024. Para obter informações sobre o moe, consulte Preparar para a desativação de coadministradores

Configurar notificações

Use os modelos do portal do Azure, CLI, PowerShell ou Gerenciador de Recursos para configurar notificações.

Portal

Configure 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.

Insira uma lista de endereços de e-mail 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, parâmetros de consulta ou adicionar um cabeçalho personalizado para identificar a origem da solicitação.

CLI

Use a CLI para configurar notificações.

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

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

• --add-action - A ação a ser tomada quando a regra de escala automática é acionada. O valor deve ser email ou webhook, e seguido pelo endereço de e-mail ou URI webhook.
• --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 az monitor autoscale update comando.

Por exemplo, o comando a seguir adiciona uma notificação por e-mail e uma notificação de webhook à configuração de dimensionamento automático existente.

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

Nota

Você pode adicionar mote do que uma notificação de e-mail ou webhook usando o --add-action parâmetro várias vezes. Embora várias notificações de webhook sejam suportadas e possam ser vistas no JSON, o portal mostra apenas o primeiro webhook.

Para obter mais informações, consulte az monitor autoscale.

PowerShell

Use o PowerShell para configurar notificações.

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

1. Crie o objeto webhook.

2. Crie o objeto de notificação.

3. Adicione o objeto de notificação à configuração de dimensionamento automático usando New-AzAutoscaleSetting ou Update-AzAutoscaleSetting cmdlets.

# 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" `
-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 modelos do Gerenciador de Recursos para configurar notificações.

Ao usar os modelos do Gerenciador de Recursos ou a API REST, inclua o elemento nas configurações de notifications 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	Description
operation	Sim	O valor deve ser Scale.
sendToSubscriptionAdministrator	Sim	Não há mais suporte. O valor deve ser false.
sendToSubscriptionCoAdministrators	Sim	Não há mais suporte. O valor deve ser false.
customEmails	Sim	O valor pode ser null [] ou uma matriz de cadeia de caracteres de e-mails.
webhooks	Sim	O valor pode ser nulo ou URI válido.
serviceUri	Sim	URI HTTPS válido.
properties	Sim	O valor deve estar vazio {} ou pode conter pares chave-valor.

Autenticação em webhooks

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

Esquema de carga útil do webhook de notificação de dimensionamento automático

Quando a notificação de dimensionamento automático é gerada, os seguintes metadados 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/0000aaaa-11BB-cccc-dd22-eeeeee333333/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": "0000aaaa-11BB-cccc-dd22-eeeeee333333",
        "resourceGroupName": "rg-001",
        "resourceName": "ScaleableAppServicePlan",
        "resourceType": "microsoft.web/serverfarms",
        "resourceId": "/subscriptions/0000aaaa-11BB-cccc-dd22-eeeeee333333/resourceGroups/rg-001/providers/Microsoft.Web/serverfarms/ScaleableAppServicePlan",
        "portalLink": "https://portal.azure.com/#resource/subscriptions/0000aaaa-11BB-cccc-dd22-eeeeee333333/resourceGroups/rg-001/providers/Microsoft.Web/serverfarms/ScaleableAppServicePlan",
        "resourceRegion": "West Central US",
        "oldCapacity": "1",
        "newCapacity": "2"
    },
    "properties": {
        "key1": "value1",
        "key2": "value2"
    }   
}

Campo	Obrigatório	Description
status	Sim	Status que indica que uma ação de dimensionamento automático foi gerada.
operation	Sim	Para um aumento de casos, é o "Scale out". Para uma diminuição nos casos, é o "Scale In".
Contexto	Sim	Dimensionar automaticamente o contexto da ação.
carimbo de data/hora	Sim	Carimbo de data/hora quando a ação de dimensionamento automático foi acionada.
id	Sim	ID do Gerenciador de Recursos da configuração de dimensionamento automático.
nome	Sim	Nome da configuração de dimensionamento automático.
detalhes	Sim	Explicação da ação executada pelo serviço de dimensionamento automático e da alteração na contagem de instâncias.
subscriptionId	Sim	ID de 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 suportados: "microsoft.classiccompute/domainnames/slots/roles" - funções dos Serviços de Nuvem do Azure, "microsoft.compute/virtualmachinescalesets" - Conjuntos de Escala de Máquina Virtual do Azure e "Microsoft.Web/serverfarms" - recurso de Aplicativo Web do Azure Monitor.
resourceId	Sim	ID do Gerenciador de Recursos 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 atual (antiga) quando o dimensionamento automático executava uma ação de escala.
newCapacidade	Sim	Nova contagem de instâncias para a qual o dimensionamento automático dimensionou o recurso.
propriedades	Não	Opcional. Conjunto de pares de <chave, valor> (por exemplo, Dictionary <String, String>). O campo de propriedades é opcional. Em uma interface de usuário personalizada ou fluxo de trabalho baseado em aplicativo lógico, você pode inserir chaves e valores que podem ser passados usando a carga útil. Uma maneira alternativa de passar propriedades personalizadas de volta para a chamada de webhook de saída é usar o próprio URI do webhook (como parâmetros de consulta).