你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Metric Alerts - Update
更新指标警报定义。
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}?api-version=2018-03-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
resource
|
path | True |
string |
资源组的名称。 此名称不区分大小写。 |
rule
|
path | True |
string |
规则的名称。 |
subscription
|
path | True |
string |
目标订阅的 ID。 |
api-version
|
query | True |
string |
要用于此操作的 API 版本。 |
请求正文
名称 | 类型 | 说明 |
---|---|---|
properties.actions |
警报规则变为活动状态以及解决警报条件时执行的操作数组。 |
|
properties.autoMitigate |
boolean |
指示是否应自动解决警报的标志。 默认值为 true。 |
properties.criteria | MetricAlertCriteria: |
定义特定的警报条件信息。 |
properties.description |
string |
警报电子邮件中将包含的指标警报的说明。 |
properties.enabled |
boolean |
指示是否启用指标警报的标志。 |
properties.evaluationFrequency |
string |
以 ISO 8601 持续时间格式表示的指标警报评估频率。 |
properties.scopes |
string[] |
此指标警报的作用域为的资源 ID 的列表。 |
properties.severity |
integer |
警报严重性 {0, 1, 2, 3, 4} |
properties.targetResourceRegion |
string |
目标资源的区域 (创建/更新警报的) 。 对于 MultipleResourceMultipleMetricCriteria 是必需的。 |
properties.targetResourceType |
string |
创建/更新警报的目标资源 () 的资源类型。 对于 MultipleResourceMultipleMetricCriteria 是必需的。 |
properties.windowSize |
string |
iso 8601 持续时间格式 (的时间段) ,用于根据阈值监视警报活动。 |
tags |
object |
资源标记 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
确定 |
|
Other Status Codes |
BadRequest |
安全性
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"
}
}
]
}
}
示例响应
{
"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"
}
}
]
}
}
定义
名称 | 说明 |
---|---|
Aggregation |
条件时间聚合类型。 |
Dynamic |
动态阈值的条件。 |
Dynamic |
在所选回溯时间范围内引发警报所需的最小冲突数。 |
Dynamic |
用于将指标值与阈值进行比较的运算符。 |
Dynamic |
触发警报所需的偏差程度。 这会影响阈值与指标序列模式的紧密程度。 |
Error |
描述错误响应的格式。 |
Metric |
警报操作。 |
Metric |
为具有多个指标条件的多个资源指定指标警报条件。 |
Metric |
指标警报资源。 |
Metric |
修补操作的指标警报资源。 |
Metric |
为具有多个指标条件的单个资源指定指标警报条件。 |
Metric |
筛选指标的条件。 |
Metric |
指定指标维度。 |
Operator |
条件运算符。 |
Webtest |
指定 Web 测试资源的指标警报规则条件。 |
AggregationTypeEnum
条件时间聚合类型。
名称 | 类型 | 说明 |
---|---|---|
Average |
string |
|
Count |
string |
|
Maximum |
string |
|
Minimum |
string |
|
Total |
string |
DynamicMetricCriteria
动态阈值的条件。
名称 | 类型 | 说明 |
---|---|---|
alertSensitivity |
触发警报所需的偏差程度。 这会影响阈值与指标序列模式的紧密程度。 |
|
criterionType |
string:
Dynamic |
指定阈值条件的类型 |
dimensions |
维度条件列表。 |
|
failingPeriods |
在所选回溯时间范围内引发警报所需的最小冲突数。 |
|
ignoreDataBefore |
string |
使用此选项可以设置开始学习指标历史数据的日期,并计算 (ISO8601格式的动态阈值) |
metricName |
string |
指标的名称。 |
metricNamespace |
string |
指标的命名空间。 |
name |
string |
条件的名称。 |
operator |
用于将指标值与阈值进行比较的运算符。 |
|
skipMetricValidation |
boolean |
允许尚未发出的自定义指标创建警报规则,方式是使跳过指标验证。 |
timeAggregation |
条件时间聚合类型。 |
DynamicThresholdFailingPeriods
在所选回溯时间范围内引发警报所需的最小冲突数。
名称 | 类型 | 说明 |
---|---|---|
minFailingPeriodsToAlert |
number |
触发警报的冲突数。 应小于或等于 numberOfEvaluationPeriods。 |
numberOfEvaluationPeriods |
number |
聚合的回溯点数。 回溯时间窗口是根据聚合粒度 (windowSize) 和所选的聚合点数计算的。 |
DynamicThresholdOperator
用于将指标值与阈值进行比较的运算符。
名称 | 类型 | 说明 |
---|---|---|
GreaterOrLessThan |
string |
|
GreaterThan |
string |
|
LessThan |
string |
DynamicThresholdSensitivity
触发警报所需的偏差程度。 这会影响阈值与指标序列模式的紧密程度。
名称 | 类型 | 说明 |
---|---|---|
High |
string |
|
Low |
string |
|
Medium |
string |
ErrorResponse
描述错误响应的格式。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误代码 |
message |
string |
指示操作失败原因的错误消息。 |
MetricAlertAction
警报操作。
名称 | 类型 | 说明 |
---|---|---|
actionGroupId |
string |
要使用的操作组的 ID。 |
webHookProperties |
object |
此字段允许指定自定义属性,这些属性将追加到作为输入发送到 Webhook 的警报有效负载。 |
MetricAlertMultipleResourceMultipleMetricCriteria
为具有多个指标条件的多个资源指定指标警报条件。
名称 | 类型 | 说明 |
---|---|---|
allOf | MultiMetricCriteria[]: |
此“全部”操作的多个指标条件的列表。 |
odata.type |
string:
Microsoft. |
指定警报条件的类型。 |
MetricAlertResource
指标警报资源。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
Azure 资源 ID |
location |
string |
资源位置 |
name |
string |
Azure 资源名称 |
properties.actions |
警报规则变为活动状态以及解决警报条件时执行的操作数组。 |
|
properties.autoMitigate |
boolean |
指示是否应自动解决警报的标志。 默认值为 true。 |
properties.criteria | MetricAlertCriteria: |
定义特定的警报条件信息。 |
properties.description |
string |
警报电子邮件中将包含的指标警报的说明。 |
properties.enabled |
boolean |
指示是否启用指标警报的标志。 |
properties.evaluationFrequency |
string |
以 ISO 8601 持续时间格式表示的指标警报评估频率。 |
properties.isMigrated |
boolean |
指示是否迁移此警报规则的值。 |
properties.lastUpdatedTime |
string |
上次以ISO8601格式更新规则的时间。 |
properties.scopes |
string[] |
此指标警报的作用域为的资源 ID 的列表。 |
properties.severity |
integer |
警报严重性 {0, 1, 2, 3, 4} |
properties.targetResourceRegion |
string |
目标资源的区域 (创建/更新警报的) 。 如果范围包含订阅、资源组或多个资源,则是必需的。 |
properties.targetResourceType |
string |
创建/更新警报的目标资源 () 的资源类型。 如果范围包含订阅、资源组或多个资源,则是必需的。 |
properties.windowSize |
string |
iso 8601 持续时间格式 (的时间段) ,用于根据阈值监视警报活动。 |
tags |
object |
资源标记 |
type |
string |
Azure 资源类型 |
MetricAlertResourcePatch
修补操作的指标警报资源。
名称 | 类型 | 说明 |
---|---|---|
properties.actions |
警报规则变为活动状态以及解决警报条件时执行的操作数组。 |
|
properties.autoMitigate |
boolean |
指示是否应自动解决警报的标志。 默认值为 true。 |
properties.criteria | MetricAlertCriteria: |
定义特定的警报条件信息。 |
properties.description |
string |
警报电子邮件中将包含的指标警报的说明。 |
properties.enabled |
boolean |
指示是否启用指标警报的标志。 |
properties.evaluationFrequency |
string |
以 ISO 8601 持续时间格式表示的指标警报评估频率。 |
properties.isMigrated |
boolean |
指示是否迁移此警报规则的值。 |
properties.lastUpdatedTime |
string |
上次以ISO8601格式更新规则的时间。 |
properties.scopes |
string[] |
此指标警报的作用域为的资源 ID 的列表。 |
properties.severity |
integer |
警报严重性 {0, 1, 2, 3, 4} |
properties.targetResourceRegion |
string |
目标资源的区域 (创建/更新警报的) 。 对于 MultipleResourceMultipleMetricCriteria 是必需的。 |
properties.targetResourceType |
string |
创建/更新警报的目标资源 () 的资源类型。 对于 MultipleResourceMultipleMetricCriteria 是必需的。 |
properties.windowSize |
string |
iso 8601 持续时间格式 (的时间段) ,用于根据阈值监视警报活动。 |
tags |
object |
资源标记 |
MetricAlertSingleResourceMultipleMetricCriteria
为具有多个指标条件的单个资源指定指标警报条件。
名称 | 类型 | 说明 |
---|---|---|
allOf |
此“全部”操作的指标条件列表。 |
|
odata.type |
string:
Microsoft. |
指定警报条件的类型。 |
MetricCriteria
筛选指标的条件。
名称 | 类型 | 说明 |
---|---|---|
criterionType |
string:
Static |
指定阈值条件的类型 |
dimensions |
维度条件列表。 |
|
metricName |
string |
指标的名称。 |
metricNamespace |
string |
指标的命名空间。 |
name |
string |
条件的名称。 |
operator |
条件运算符。 |
|
skipMetricValidation |
boolean |
允许尚未发出的自定义指标创建警报规则,方式是使跳过指标验证。 |
threshold |
number |
激活警报的条件阈值。 |
timeAggregation |
条件时间聚合类型。 |
MetricDimension
指定指标维度。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
维度的名称。 |
operator |
string |
维度运算符。 仅支持“包含”和“排除” |
values |
string[] |
维度值的列表。 |
Operator
条件运算符。
名称 | 类型 | 说明 |
---|---|---|
Equals |
string |
|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
WebtestLocationAvailabilityCriteria
指定 Web 测试资源的指标警报规则条件。
名称 | 类型 | 说明 |
---|---|---|
componentId |
string |
Application Insights 资源 ID。 |
failedLocationCount |
number |
失败位置的数目。 |
odata.type |
string:
Microsoft. |
指定警报条件的类型。 |
webTestId |
string |
Application Insights Web 测试 ID。 |