使用自动缩放操作在 Azure 监视器中发送电子邮件和 webhook 警报通知

项目
10/15/2024

本文演示如何设置通知，以便可以在 Azure 中基于自动缩放操作调用特定 Web URL 或发送电子邮件。

Webhook

使用 Webhook，可以在发生特定事件或触发器时向特定 URL 终结点（回叫 URL）发送 HTTP 请求。使用 Webhook，可以通过启用不同系统或应用程序之间的信息自动交换来自动执行和简化流程。使用 Webhook 触发自定义代码、通知或其他操作，以在发生自动缩放事件时运行。

电子邮件

发生自动缩放事件时，可以将电子邮件发送到任何有效的电子邮件地址。

注意

从 2024 年 4 月 3 日起，你将无法为 Azure 自动缩放通知添加新的共同管理员。 Azure 经典管理员将于 2024 年 8 月 31 日停用，2024 年 8 月 31 日之后你将无法使用管理员和共同管理员发送 Azure 自动缩放通知。有关详细信息，请参阅为共同管理员停用作准备

配置通知

使用 Azure 门户、CLI、PowerShell 或资源管理器模板配置通知。

使用 Azure 门户设置通知。

选择自动缩放设置页上的“通知”选项卡以配置通知。

输入要向其发送通知的电子邮件地址列表。

输入 Webhook URI 以向 Web 服务发送通知。还可以向 Webhook 请求添加自定义标头。例如，可以在标头中添加身份验证令牌、查询参数或添加自定义标头来标识请求的源。

使用 CLI 配置通知。

使用 az monitor autoscale update 或 az monitor autoscale create 命令通过 Azure CLI 配置通知。

以下参数将用于配置通知：

--add-action - 触发自动缩放规则时要执行的操作。该值必须是 email 或 webhook，后跟电子邮件地址或 Webhook URI。
--remove-action - 移除之前由 --add-action 添加的操作。值必须为 email 或 webhook。此参数仅与 az monitor autoscale update 命令相关。

例如，以下命令可将电子邮件通知和 Webhook 通知添加到现有的自动缩放设置。

 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

注意

可以通过多次使用 --add-action 参数添加多个电子邮件或 Webhook 通知。虽然支持多个 Webhook 通知，并且可以在 JSON 中看到，但门户仅显示第一个 Webhook。

有关详细信息，请参阅 az monitor autoscale。

使用 PowerShell 配置通知。

以下示例演示如何配置 Webhook 和电子邮件通知。

创建 Webhook 对象。
创建通知对象。
使用 New-AzAutoscaleSetting 或 Update-AzAutoscaleSetting cmdlet 将通知对象添加到自动缩放设置。

# 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 chinanorth2 `
-Profile $profile `
-Enabled -Notification $notification `
-PropertiesName "autoscalesetting" `
-TargetResourceUri "/subscriptions/$subscriptionId/resourceGroups/$resourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/$vmssName"

使用资源管理器模板配置通知。

如果使用 REST API 或资源管理器模板，请在notifications自动缩放设置中包括元素，例如：

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

字段	必需	说明
`operation`	是	值必须是 `Scale`。
`sendToSubscriptionAdministrator`	是	不再支持。值必须是 `false`。
`sendToSubscriptionCoAdministrators`	是	不再支持。值必须是 `false`。
`customEmails`	是	值可以为 null [] 或电子邮件的字符串数组。
`webhooks`	是	值可以为 null 或有效 URI。
`serviceUri`	是	有效的 HTTPS URI。
`properties`	是	值必须是空的 {}，也可以包含键值对。

webhook 中的身份验证

Webhook 可使用基于令牌的身份验证进行身份验证，其中将具有令牌 ID 的 Webhook URI 保存为查询参数。例如 https://mysamplealert/webcallback?tokenid=123-abc456-7890&myparameter2=value123。

自动缩放通知 webhook 负载架构

生成自动缩放通知时，以下元数据会包含在 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.cn/#resource/subscriptions/0000aaaa-11BB-cccc-dd22-eeeeee333333/resourceGroups/rg-001/providers/Microsoft.Web/serverfarms/ScaleableAppServicePlan",
        "resourceRegion": "China North",
        "oldCapacity": "1",
        "newCapacity": "2"
    },
    "properties": {
        "key1": "value1",
        "key2": "value2"
    }   
}

字段	必需	说明
状态	是	指示生成自动缩放操作的状态。
operation	是	对于实例的增加，值为“Scale Out”。对于实例的减少，值为“Scale In”。
上下文	是	自动缩放操作上下文。
timestamp	是	触发自动缩放操作时的时间戳。
id	是	自动缩放设置的资源管理器 ID。
name	是	自动缩放设置的名称。
详细信息	是	自动缩放服务执行的操作和实例计数的更改的说明。
subscriptionId	是	所缩放的目标资源的订阅 ID。
resourceGroupName	是	所缩放的目标资源的资源组名。
resourceName	是	所缩放的目标资源的名称。
resourceType	是	三个支持的值是：“microsoft.classiccompute/domainnames/slots/roles”- Azure 云服务角色、“microsoft.compute/virtualmachinescalesets”- Azure 虚拟机规模集和“Microsoft.Web/serverfarms”- Azure Monitor 的 Web 应用功能。
ResourceId	是	所缩放的目标资源的资源管理器 ID。
portalLink	是	指向目标资源摘要页的 Azure 门户链接。
oldCapacity	是	自动缩放执行缩放操作时的当前（旧）实例计数。
newCapacity	是	自动缩放将资源缩放到的新实例计数。
properties	否	可选。 <键, 值> 对集（例如字典 <String, String>）。 properties 字段是可选的。在自定义用户界面或基于逻辑应用的工作流中，可以输入可使用有效负载传递的键和值。将自定义属性传递回传出 Webhook 调用的替代方法是使用 Webhook URI 本身（作为查询参数）。

通过