Wysyłanie powiadomień o alertach wiadomości e-mail i elementów webhook w usłudze Azure Monitor za pomocą akcji autoskalowania

Artykuł
09/07/2023

W tym artykule pokazano, jak skonfigurować powiadomienia, aby można było wywoływać określone adresy URL sieci Web lub wysyłać wiadomości e-mail na podstawie akcji autoskalowania na platformie Azure.

Elementy webhook

Elementy webhook umożliwiają wysyłanie żądań HTTP do określonego punktu końcowego adresu URL (adresu URL wywołania zwrotnego) po wystąpieniu określonego zdarzenia lub wyzwalacza. Za pomocą elementów webhook można zautomatyzować i usprawnić procesy, umożliwiając automatyczną wymianę informacji między różnymi systemami lub aplikacjami. Użyj elementów webhook, aby wyzwolić niestandardowy kod, powiadomienia lub inne akcje do uruchomienia po wystąpieniu zdarzenia autoskalowania.

E-mail

Możesz wysłać wiadomość e-mail na dowolny prawidłowy adres e-mail po wystąpieniu zdarzenia autoskalowania. Administratorzy i współadministratorzy subskrypcji, w której jest uruchomiona reguła, są również powiadamiani.

Konfigurowanie powiadomień

Aby skonfigurować powiadomienia, użyj szablonów Azure Portal, interfejsu wiersza polecenia, programu PowerShell lub Resource Manager.

Skonfiguruj powiadomienia przy użyciu Azure Portal.

Wybierz kartę Powiadamianie na stronie ustawień autoskalowania, aby skonfigurować powiadomienia.

Zaznacz pola wyboru, aby wysłać wiadomość e-mail do administratora subskrypcji lub współadministratorów. Możesz również wprowadzić listę adresów e-mail, do których mają być wysyłane powiadomienia.

Wprowadź identyfikator URI elementu webhook, aby wysłać powiadomienie do usługi internetowej. Możesz również dodać nagłówki niestandardowe do żądania elementu webhook. Możesz na przykład dodać token uwierzytelniania w nagłówku, parametrach zapytania lub dodać nagłówek niestandardowy, aby zidentyfikować źródło żądania.

Konfigurowanie powiadomień za pomocą interfejsu wiersza polecenia.

az monitor autoscale update Użyj polecenia lub , aby skonfigurować powiadomienia przy użyciu interfejsu az monitor autoscale create wiersza polecenia platformy Azure.

Następujące parametry służą do konfigurowania powiadomień:

--add-action - Akcja do wykonania po wyzwoleniu reguły autoskalowania. Wartość musi być email lub webhook.
--email-administrator {false, true} — Wyślij wiadomość e-mail do administratora subskrypcji.
--email-coadministrators {false, true} - Wyślij wiadomość e-mail do współadministratorów subskrypcji.
--remove-action — Usuń akcję wcześniej dodaną przez --add-actionelement . Wartość musi być email lub webhook. Parametr jest odpowiedni tylko dla az monitor autoscale update polecenia .

Na przykład następujące polecenie dodaje powiadomienie e-mail i powiadomienie elementu webhook do i istniejące ustawienie autoskalowania. Polecenie wysyła również wiadomość e-mail do administratora subskrypcji.

 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

Uwaga

Możesz dodać jedną wiadomość e-mail lub powiadomienie elementu webhook przy użyciu parametru --add-action wiele razy. Chociaż wiele powiadomień elementu webhook jest obsługiwanych i można je zobaczyć w formacie JSON, w portalu jest wyświetlany tylko pierwszy element webhook.

Aby uzyskać więcej informacji, zobacz az monitor autoscale.

Konfigurowanie powiadomień za pomocą programu PowerShell.

W poniższym przykładzie pokazano, jak skonfigurować element webhook i powiadomienie e-mail.

Utwórz obiekt elementu webhook.
Utwórz obiekt powiadomienia.
Dodaj obiekt powiadomienia do ustawienia autoskalowania przy użyciu New-AzAutoscaleSetting poleceń cmdlet lub .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"

Konfigurowanie powiadomień za pomocą szablonów Resource Manager.

Jeśli używasz szablonów Resource Manager lub interfejsu API REST, uwzględnij notifications element w ustawieniach autoskalu, na przykład:

"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"
            }
          }
        ]
      }
    ]

Pole	Obowiązkowy	Opis
operation	Tak	Wartość musi być "Skaluj".
sendToSubscriptionAdministrator	Tak	Wartość musi być "true" lub "false".
sendToSubscriptionCoAdministrators	Tak	Wartość musi być "true" lub "false".
customEmails	Tak	Wartość może mieć wartość null [] lub tablicę ciągów wiadomości e-mail.
elementy webhook	Tak	Wartość może mieć wartość null lub prawidłowy identyfikator URI.
identyfikator URI usługi	Tak	Prawidłowy identyfikator URI HTTPS.
properties	Tak	Wartość musi być pusta {} lub może zawierać pary klucz-wartość.

Uwierzytelnianie w elementach webhook

Element webhook może uwierzytelniać się przy użyciu uwierzytelniania opartego na tokenach, w którym można zapisać identyfikator URI elementu webhook przy użyciu identyfikatora tokenu jako parametru zapytania. Na przykład https://mysamplealert/webcallback?tokenid=123-abc456-7890&myparameter2=value123.

Schemat ładunku elementu webhook powiadomienia automatycznego skalowania

Po wygenerowaniu powiadomienia automatycznego skalowania następujące metadane są uwzględniane w ładunku elementu 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"
    }   
}

Pole	Obowiązkowy	Opis
status	Tak	Stan wskazujący, że została wygenerowana akcja automatycznego skalowania.
operation	Tak	W przypadku zwiększenia liczby wystąpień jest to "Skalowanie w poziomie". W przypadku spadku liczby wystąpień jest to "Skaluj w".
kontekst	Tak	Kontekst akcji Autoskaluj.
sygnatura czasowa	Tak	Sygnatura czasowa wyzwolenia akcji autoskalowania.
identyfikator	Tak	Resource Manager identyfikator ustawienia autoskalowania.
name	Tak	Nazwa ustawienia autoskalowania.
szczegóły	Tak	Wyjaśnienie akcji, którą podjęła usługa autoskalowania, oraz zmianę liczby wystąpień.
subscriptionId	Tak	Identyfikator subskrypcji zasobu docelowego, który jest skalowany.
resourceGroupName	Tak	Nazwa grupy zasobów zasobu docelowego, który jest skalowany.
resourceName	Tak	Nazwa zasobu docelowego, który jest skalowany.
resourceType	Tak	Trzy obsługiwane wartości: "microsoft.classiccompute/domainnames/slots/roles" — Role Cloud Services platformy Azure, "microsoft.compute/virtualmachinescalesets" — Azure Virtual Machine Scale Sets i "Microsoft.Web/serverfarms" — funkcja aplikacji internetowej usługi Azure Monitor.
resourceId	Tak	Resource Manager identyfikator zasobu docelowego, który jest skalowany.
portalLink	Tak	Azure Portal link do strony podsumowania zasobu docelowego.
oldCapacity	Tak	Bieżąca (stara) liczba wystąpień, gdy autoskaluj podjęła akcję skalowania.
newCapacity	Tak	Nowa liczba wystąpień, do której skalowanie automatyczne skalowało zasób.
properties	Nie	Opcjonalny. <Zestaw par Klucz, Wartość> (na przykład Ciąg słownika<, Ciąg>). Pole właściwości jest opcjonalne. W niestandardowym interfejsie użytkownika lub przepływie pracy opartym na aplikacji logiki można wprowadzić klucze i wartości, które można przekazać przy użyciu ładunku. Alternatywnym sposobem przekazywania właściwości niestandardowych z powrotem do wychodzącego wywołania elementu webhook jest użycie samego identyfikatora URI elementu webhook (jako parametrów zapytania).