你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Metric Alerts - Update

服务:: Monitor

API 版本:: 2018-03-01

更新指标警报定义。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}?api-version=2018-03-01

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。名称不区分大小写。
ruleName	path	True	string	规则的名称。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

请求正文

名称	类型	说明
properties.actions	MetricAlertAction[]	警报规则处于活动状态以及解决警报条件时执行的操作数组。
properties.autoMitigate	boolean	指示是否应自动解决警报的标志。默认值为 true。
properties.criteria	MetricAlertCriteria: MetricAlertSingleResourceMultipleMetricCriteria WebtestLocationAvailabilityCriteria MetricAlertMultipleResourceMultipleMetricCriteria	定义特定的警报条件信息。
properties.description	string	警报电子邮件中包含的指标警报的说明。
properties.enabled	boolean	指示是否启用指标警报的标志。
properties.evaluationFrequency	string (duration)	以 ISO 8601 持续时间格式计算指标警报的频率。
properties.scopes	string[]	资源 ID 的列表是此指标警报的范围。
properties.severity	integer (int32)	警报严重性 {0， 1， 2， 3， 4}
properties.targetResourceRegion	string	创建/更新警报的目标资源的区域。 MultipleResourceMultipleMetricCriteria 是必需的。
properties.targetResourceType	string	创建/更新警报的目标资源的资源类型。 MultipleResourceMultipleMetricCriteria 是必需的。
properties.windowSize	string (duration)	用于基于阈值监视警报活动的时间段（采用 ISO 8601 持续时间格式）。
tags	object	资源标记

响应

名称	类型	说明
200 OK	MetricAlertResource	还行
Other Status Codes	ErrorResponse	错误请求

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Create or update an alert rule

示例请求

PATCH https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Insights/metricAlerts/chiricutin?api-version=2018-03-01

{
  "tags": {},
  "properties": {
    "description": "This is the description of the rule1",
    "severity": 3,
    "enabled": true,
    "scopes": [
      "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
    ],
    "evaluationFrequency": "PT1M",
    "windowSize": "PT15M",
    "criteria": {
      "odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria",
      "allOf": [
        {
          "criterionType": "StaticThresholdCriterion",
          "name": "High_CPU_80",
          "metricName": "\\Processor(_Total)\\% Processor Time",
          "dimensions": [],
          "operator": "GreaterThan",
          "threshold": 80.5,
          "timeAggregation": "Average"
        }
      ]
    },
    "autoMitigate": true,
    "actions": [
      {
        "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        "webHookProperties": {
          "key11": "value11",
          "key12": "value12"
        }
      }
    ]
  }
}


import com.azure.resourcemanager.monitor.models.AggregationTypeEnum;
import com.azure.resourcemanager.monitor.models.MetricAlertAction;
import com.azure.resourcemanager.monitor.models.MetricAlertResourcePatch;
import com.azure.resourcemanager.monitor.models.MetricAlertSingleResourceMultipleMetricCriteria;
import com.azure.resourcemanager.monitor.models.MetricCriteria;
import com.azure.resourcemanager.monitor.models.Operator;
import java.time.Duration;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for MetricAlerts Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/UpdateMetricAlert.json
     */
    /**
     * Sample code: Create or update an alert rule.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createOrUpdateAnAlertRule(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.diagnosticSettings().manager().serviceClient().getMetricAlerts()
            .updateWithResponse("gigtest", "chiricutin", new MetricAlertResourcePatch().withTags(mapOf())
                .withDescription("This is the description of the rule1").withSeverity(3).withEnabled(true)
                .withScopes(Arrays.asList(
                    "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"))
                .withEvaluationFrequency(Duration.parse("Pt1m")).withWindowSize(Duration.parse("Pt15m"))
                .withCriteria(new MetricAlertSingleResourceMultipleMetricCriteria().withAllOf(Arrays.asList(
                    new MetricCriteria().withName("High_CPU_80").withMetricName("\\Processor(_Total)\\% Processor Time")
                        .withTimeAggregation(AggregationTypeEnum.AVERAGE).withDimensions(Arrays.asList())
                        .withOperator(Operator.GREATER_THAN).withThreshold(80.5))))
                .withAutoMitigate(true)
                .withActions(Arrays.asList(new MetricAlertAction().withActionGroupId(
                    "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2")
                    .withWebhookProperties(mapOf("key11", "fakeTokenPlaceholder", "key12", "fakeTokenPlaceholder")))),
                com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.monitor import MonitorManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-monitor
# USAGE
    python update_metric_alert.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MonitorManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7",
    )

    response = client.metric_alerts.update(
        resource_group_name="gigtest",
        rule_name="chiricutin",
        parameters={
            "properties": {
                "actions": [
                    {
                        "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
                        "webHookProperties": {"key11": "value11", "key12": "value12"},
                    }
                ],
                "autoMitigate": True,
                "criteria": {
                    "allOf": [
                        {
                            "criterionType": "StaticThresholdCriterion",
                            "dimensions": [],
                            "metricName": "\\Processor(_Total)\\% Processor Time",
                            "name": "High_CPU_80",
                            "operator": "GreaterThan",
                            "threshold": 80.5,
                            "timeAggregation": "Average",
                        }
                    ],
                    "odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria",
                },
                "description": "This is the description of the rule1",
                "enabled": True,
                "evaluationFrequency": "PT1M",
                "scopes": [
                    "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
                ],
                "severity": 3,
                "windowSize": "PT15M",
            },
            "tags": {},
        },
    )
    print(response)


# x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/UpdateMetricAlert.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armmonitor_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/monitor/armmonitor"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/969fd0c2634fbcc1975d7abe3749330a5145a97c/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/UpdateMetricAlert.json
func ExampleMetricAlertsClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmonitor.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewMetricAlertsClient().Update(ctx, "gigtest", "chiricutin", armmonitor.MetricAlertResourcePatch{
		Properties: &armmonitor.MetricAlertPropertiesPatch{
			Description: to.Ptr("This is the description of the rule1"),
			Actions: []*armmonitor.MetricAlertAction{
				{
					ActionGroupID: to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2"),
					WebHookProperties: map[string]*string{
						"key11": to.Ptr("value11"),
						"key12": to.Ptr("value12"),
					},
				}},
			AutoMitigate: to.Ptr(true),
			Criteria: &armmonitor.MetricAlertSingleResourceMultipleMetricCriteria{
				ODataType: to.Ptr(armmonitor.OdatatypeMicrosoftAzureMonitorSingleResourceMultipleMetricCriteria),
				AllOf: []*armmonitor.MetricCriteria{
					{
						Name:            to.Ptr("High_CPU_80"),
						CriterionType:   to.Ptr(armmonitor.CriterionTypeStaticThresholdCriterion),
						Dimensions:      []*armmonitor.MetricDimension{},
						MetricName:      to.Ptr("\\Processor(_Total)\\% Processor Time"),
						TimeAggregation: to.Ptr(armmonitor.AggregationTypeEnumAverage),
						Operator:        to.Ptr(armmonitor.OperatorGreaterThan),
						Threshold:       to.Ptr[float64](80.5),
					}},
			},
			Enabled:             to.Ptr(true),
			EvaluationFrequency: to.Ptr("Pt1m"),
			Scopes: []*string{
				to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme")},
			Severity:   to.Ptr[int32](3),
			WindowSize: to.Ptr("Pt15m"),
		},
		Tags: map[string]*string{},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.MetricAlertResource = armmonitor.MetricAlertResource{
	// 	Type: to.Ptr("Microsoft.Insights/metricAlerts"),
	// 	ID: to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/chiricutin"),
	// 	Location: to.Ptr("global"),
	// 	Tags: map[string]*string{
	// 		"hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": to.Ptr("Resource"),
	// 	},
	// 	Properties: &armmonitor.MetricAlertProperties{
	// 		Description: to.Ptr("This is the description of the rule1"),
	// 		Actions: []*armmonitor.MetricAlertAction{
	// 			{
	// 				ActionGroupID: to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2"),
	// 				WebHookProperties: map[string]*string{
	// 					"key11": to.Ptr("value11"),
	// 					"key12": to.Ptr("value12"),
	// 				},
	// 		}},
	// 		AutoMitigate: to.Ptr(true),
	// 		Criteria: &armmonitor.MetricAlertSingleResourceMultipleMetricCriteria{
	// 			ODataType: to.Ptr(armmonitor.OdatatypeMicrosoftAzureMonitorSingleResourceMultipleMetricCriteria),
	// 			AllOf: []*armmonitor.MetricCriteria{
	// 				{
	// 					Name: to.Ptr("High_CPU_80"),
	// 					CriterionType: to.Ptr(armmonitor.CriterionTypeStaticThresholdCriterion),
	// 					Dimensions: []*armmonitor.MetricDimension{
	// 					},
	// 					MetricName: to.Ptr("\\Processor(_Total)\\% Processor Time"),
	// 					TimeAggregation: to.Ptr(armmonitor.AggregationTypeEnumAverage),
	// 					Operator: to.Ptr(armmonitor.OperatorGreaterThan),
	// 					Threshold: to.Ptr[float64](80.5),
	// 			}},
	// 		},
	// 		Enabled: to.Ptr(true),
	// 		EvaluationFrequency: to.Ptr("Pt1m"),
	// 		Scopes: []*string{
	// 			to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme")},
	// 			Severity: to.Ptr[int32](3),
	// 			WindowSize: to.Ptr("Pt15m"),
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { MonitorClient } = require("@azure/arm-monitor");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Update an metric alert definition.
 *
 * @summary Update an metric alert definition.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/UpdateMetricAlert.json
 */
async function createOrUpdateAnAlertRule() {
  const subscriptionId =
    process.env["MONITOR_SUBSCRIPTION_ID"] || "14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7";
  const resourceGroupName = process.env["MONITOR_RESOURCE_GROUP"] || "gigtest";
  const ruleName = "chiricutin";
  const parameters = {
    description: "This is the description of the rule1",
    actions: [
      {
        actionGroupId:
          "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        webHookProperties: { key11: "value11", key12: "value12" },
      },
    ],
    autoMitigate: true,
    criteria: {
      allOf: [
        {
          name: "High_CPU_80",
          criterionType: "StaticThresholdCriterion",
          dimensions: [],
          metricName: "\\Processor(_Total)\\% Processor Time",
          operator: "GreaterThan",
          threshold: 80.5,
          timeAggregation: "Average",
        },
      ],
      odataType: "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria",
    },
    enabled: true,
    evaluationFrequency: "Pt1m",
    scopes: [
      "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme",
    ],
    severity: 3,
    tags: {},
    windowSize: "Pt15m",
  };
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const result = await client.metricAlerts.update(resourceGroupName, ruleName, parameters);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Monitor.Models;
using Azure.ResourceManager.Monitor;

// Generated from example definition: specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/UpdateMetricAlert.json
// this example is just showing the usage of "MetricAlerts_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://free.blessedness.top/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this MetricAlertResource created on azure
// for more information of creating MetricAlertResource, please refer to the document of MetricAlertResource
string subscriptionId = "14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7";
string resourceGroupName = "gigtest";
string ruleName = "chiricutin";
ResourceIdentifier metricAlertResourceId = MetricAlertResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, ruleName);
MetricAlertResource metricAlert = client.GetMetricAlertResource(metricAlertResourceId);

// invoke the operation
MetricAlertPatch patch = new MetricAlertPatch
{
    Tags = { },
    Description = "This is the description of the rule1",
    Severity = 3,
    IsEnabled = true,
    Scopes = { "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme" },
    EvaluationFrequency = XmlConvert.ToTimeSpan("PT1M"),
    WindowSize = XmlConvert.ToTimeSpan("PT15M"),
    Criteria = new MetricAlertSingleResourceMultipleMetricCriteria
    {
        AllOf = {new MetricCriteria("High_CPU_80", "\\Processor(_Total)\\% Processor Time", MetricCriteriaTimeAggregationType.Average, MetricCriteriaOperator.GreaterThan, 80.5)
        {
        Dimensions = {},
        }},
    },
    IsAutoMitigateEnabled = true,
    Actions = {new MetricAlertAction
    {
    ActionGroupId = new ResourceIdentifier("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2"),
    WebHookProperties =
    {
    ["key11"] = "value11",
    ["key12"] = "value12"
    },
    }},
};
MetricAlertResource result = await metricAlert.UpdateAsync(patch);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
MetricAlertData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/chiricutin",
  "type": "Microsoft.Insights/metricAlerts",
  "location": "global",
  "tags": {
    "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
  },
  "properties": {
    "description": "This is the description of the rule1",
    "severity": 3,
    "enabled": true,
    "scopes": [
      "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
    ],
    "evaluationFrequency": "PT1M",
    "windowSize": "PT15M",
    "criteria": {
      "odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria",
      "allOf": [
        {
          "criterionType": "StaticThresholdCriterion",
          "name": "High_CPU_80",
          "metricName": "\\Processor(_Total)\\% Processor Time",
          "dimensions": [],
          "operator": "GreaterThan",
          "threshold": 80.5,
          "timeAggregation": "Average"
        }
      ]
    },
    "autoMitigate": true,
    "actions": [
      {
        "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        "webHookProperties": {
          "key11": "value11",
          "key12": "value12"
        }
      }
    ]
  }
}

定义

名称	说明
AdditionalInfo	具有“type”和“info”属性的对象数组。 “info”的架构特定于服务，依赖于“type”字符串。
AggregationTypeEnum	条件时间聚合类型。
DynamicMetricCriteria	动态阈值的条件。
DynamicThresholdFailingPeriods	在引发警报所需的所选回溯时间范围内所需的最小冲突数。
DynamicThresholdOperator	用于将指标值与阈值进行比较的运算符。
DynamicThresholdSensitivity	触发警报所需的偏差范围。这会影响阈值对指标系列模式的严格程度。
Error
ErrorDetail	描述错误响应的详细信息。
ErrorResponse	描述错误响应的格式。
MetricAlertAction	警报操作。
MetricAlertMultipleResourceMultipleMetricCriteria	为具有多个指标条件的多个资源指定指标警报条件。
MetricAlertResource	指标警报资源。
MetricAlertResourcePatch	修补操作的指标警报资源。
MetricAlertSingleResourceMultipleMetricCriteria	为具有多个指标条件的单个资源指定指标警报条件。
MetricCriteria	筛选指标的条件。
MetricDimension	指定指标维度。
Operator	条件运算符。
WebtestLocationAvailabilityCriteria	指定 Web 测试资源的指标警报规则条件。

AdditionalInfo

Object

具有“type”和“info”属性的对象数组。 “info”的架构特定于服务，依赖于“type”字符串。

名称	类型	说明
info		特定于类型的其他信息。
type	string	其他信息的类型。

AggregationTypeEnum

枚举

条件时间聚合类型。

值	说明
Average
Count
Minimum
Maximum
Total

DynamicMetricCriteria

Object

动态阈值的条件。

名称	类型	说明
alertSensitivity	DynamicThresholdSensitivity	触发警报所需的偏差范围。这会影响阈值对指标系列模式的严格程度。
criterionType	string: DynamicThresholdCriterion	指定阈值条件的类型
dimensions	MetricDimension[]	维度条件列表。
failingPeriods	DynamicThresholdFailingPeriods	在引发警报所需的所选回溯时间范围内所需的最小冲突数。
ignoreDataBefore	string (date-time)	使用此选项可设置开始学习指标历史数据的日期并计算动态阈值（ISO8601格式）
metricName	string	指标的名称。
metricNamespace	string	指标的命名空间。
name	string	条件的名称。
operator	DynamicThresholdOperator	用于将指标值与阈值进行比较的运算符。
skipMetricValidation	boolean	允许针对尚未发出的自定义指标创建警报规则，方法是跳过指标验证。
timeAggregation	AggregationTypeEnum	条件时间聚合类型。

DynamicThresholdFailingPeriods

Object

在引发警报所需的所选回溯时间范围内所需的最小冲突数。

名称	类型	说明
minFailingPeriodsToAlert	number	触发警报的冲突数。应小于或等于 numberOfEvaluationPeriods。
numberOfEvaluationPeriods	number	聚合回溯点数。回溯时间窗口是根据聚合粒度（windowSize）和所选聚合点数计算的。

DynamicThresholdOperator

枚举

用于将指标值与阈值进行比较的运算符。

值	说明
GreaterThan
LessThan
GreaterOrLessThan

DynamicThresholdSensitivity

枚举

触发警报所需的偏差范围。这会影响阈值对指标系列模式的严格程度。

值	说明
Low
Medium
High

Error

Object

名称	类型	说明
additionalInfo	AdditionalInfo[]	具有“type”和“info”属性的对象数组。 “info”的架构特定于服务，依赖于“type”字符串。
code	string	可用于以编程方式标识错误的未分配字符串。
details	ErrorDetail[]	其他嵌套错误响应信息对象数组，如此协定所述。
message	string	详细描述错误并提供调试信息。如果在请求中设置了 Accept-Language，则必须将其本地化为该语言。
target	string	特定错误的目标（例如，错误中属性的名称）。

ErrorDetail

Object

描述错误响应的详细信息。

名称	类型	说明
additionalInfo	AdditionalInfo[]	具有“type”和“info”属性的对象数组。 “info”的架构特定于服务，依赖于“type”字符串。
code	string	可用于以编程方式标识错误的未分配字符串。
message	string	详细描述错误并提供调试信息。
target	string	特定错误的目标（例如，错误中属性的名称）。

ErrorResponse

Object

描述错误响应的格式。

名称	类型	说明
error	Error

MetricAlertAction

Object

警报操作。

名称	类型	说明
actionGroupId	string	要使用的操作组的 ID。
webHookProperties	object	此字段允许指定自定义属性，这些属性将追加到作为输入发送到 Webhook 的警报有效负载中。

MetricAlertMultipleResourceMultipleMetricCriteria

Object

为具有多个指标条件的多个资源指定指标警报条件。

名称	类型	说明
allOf	MultiMetricCriteria[]: DynamicMetricCriteria[] MetricCriteria[]	此“全部”操作的多个指标条件的列表。
odata.type	string: Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria	指定警报条件的类型。

MetricAlertResource

Object

指标警报资源。

名称	类型	说明
id	string	Azure 资源 ID
location	string	资源位置
name	string	Azure 资源名称
properties.actions	MetricAlertAction[]	警报规则处于活动状态以及解决警报条件时执行的操作数组。
properties.autoMitigate	boolean	指示是否应自动解决警报的标志。默认值为 true。
properties.criteria	MetricAlertCriteria: MetricAlertMultipleResourceMultipleMetricCriteria MetricAlertSingleResourceMultipleMetricCriteria WebtestLocationAvailabilityCriteria	定义特定的警报条件信息。
properties.description	string	警报电子邮件中包含的指标警报的说明。
properties.enabled	boolean	指示是否启用指标警报的标志。
properties.evaluationFrequency	string (duration)	以 ISO 8601 持续时间格式计算指标警报的频率。
properties.isMigrated	boolean	指示是否迁移此警报规则的值。
properties.lastUpdatedTime	string (date-time)	上次以ISO8601格式更新规则的时间。
properties.scopes	string[]	资源 ID 的列表是此指标警报的范围。不能根据日志更改指标规则的范围。
properties.severity	integer (int32)	警报严重性 {0， 1， 2， 3， 4}
properties.targetResourceRegion	string	创建/更新警报的目标资源的区域。如果范围包含订阅、资源组或多个资源，则是必需的。
properties.targetResourceType	string	创建/更新警报的目标资源的资源类型。如果范围包含订阅、资源组或多个资源，则是必需的。
properties.windowSize	string (duration)	用于基于阈值监视警报活动的时间段（采用 ISO 8601 持续时间格式）。
tags	object	资源标记
type	string	Azure 资源类型

MetricAlertResourcePatch

Object

修补操作的指标警报资源。

名称	类型	说明
properties.actions	MetricAlertAction[]	警报规则处于活动状态以及解决警报条件时执行的操作数组。
properties.autoMitigate	boolean	指示是否应自动解决警报的标志。默认值为 true。
properties.criteria	MetricAlertCriteria: MetricAlertMultipleResourceMultipleMetricCriteria MetricAlertSingleResourceMultipleMetricCriteria WebtestLocationAvailabilityCriteria	定义特定的警报条件信息。
properties.description	string	警报电子邮件中包含的指标警报的说明。
properties.enabled	boolean	指示是否启用指标警报的标志。
properties.evaluationFrequency	string (duration)	以 ISO 8601 持续时间格式计算指标警报的频率。
properties.isMigrated	boolean	指示是否迁移此警报规则的值。
properties.lastUpdatedTime	string (date-time)	上次以ISO8601格式更新规则的时间。
properties.scopes	string[]	资源 ID 的列表是此指标警报的范围。
properties.severity	integer (int32)	警报严重性 {0， 1， 2， 3， 4}
properties.targetResourceRegion	string	创建/更新警报的目标资源的区域。 MultipleResourceMultipleMetricCriteria 是必需的。
properties.targetResourceType	string	创建/更新警报的目标资源的资源类型。 MultipleResourceMultipleMetricCriteria 是必需的。
properties.windowSize	string (duration)	用于基于阈值监视警报活动的时间段（采用 ISO 8601 持续时间格式）。
tags	object	资源标记

MetricAlertSingleResourceMultipleMetricCriteria

Object

为具有多个指标条件的单个资源指定指标警报条件。

名称	类型	说明
allOf	MetricCriteria[]	此“全部”操作的指标条件列表。
odata.type	string: Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria	指定警报条件的类型。

MetricCriteria

Object

筛选指标的条件。

名称	类型	说明
criterionType	string: StaticThresholdCriterion	指定阈值条件的类型
dimensions	MetricDimension[]	维度条件列表。
metricName	string	指标的名称。
metricNamespace	string	指标的命名空间。
name	string	条件的名称。
operator	Operator	条件运算符。
skipMetricValidation	boolean	允许针对尚未发出的自定义指标创建警报规则，方法是跳过指标验证。
threshold	number (double)	激活警报的条件阈值。
timeAggregation	AggregationTypeEnum	条件时间聚合类型。

MetricDimension

Object

指定指标维度。

名称	类型	说明
name	string	维度的名称。
operator	string	维度运算符。仅支持“Include”和“Exclude”
values	string[]	维度值列表。

Operator

枚举

条件运算符。

值	说明
Equals
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual

WebtestLocationAvailabilityCriteria

Object

指定 Web 测试资源的指标警报规则条件。

名称	类型	说明
componentId	string	Application Insights 资源 ID。
failedLocationCount	number	失败的位置数。
odata.type	string: Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria	指定警报条件的类型。
webTestId	string	Application Insights Web 测试 ID。