Metric Alerts - Update
更新指标警报定义。
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}?api-version=2024-03-01-preview
URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
资源组的名称。 此名称不区分大小写。 |
|
rule
|
path | True |
string |
规则的名称。 |
|
subscription
|
path | True |
string minLength: 1 |
目标订阅的 ID。 |
|
api-version
|
query | True |
string minLength: 1 |
要用于此操作的 API 版本。 |
请求正文
| 名称 | 类型 | 说明 |
|---|---|---|
| identity |
资源的标识。 |
|
| properties.actionProperties |
object |
操作属性的属性。 |
| properties.actions |
警报规则处于活动状态以及解决警报条件时执行的操作数组。 |
|
| properties.autoMitigate |
boolean |
指示是否应自动解决警报的标志。 默认值为 true。 |
| properties.criteria | MetricAlertCriteria: |
定义特定的警报条件信息。 |
| properties.customProperties |
object |
警报有效负载的属性。 |
| properties.description |
string |
警报电子邮件中将包含的指标警报的说明。 |
| properties.enabled |
boolean |
指示是否启用指标警报的标志。 |
| properties.evaluationFrequency |
string (duration) |
以 ISO 8601 持续时间格式表示衡量指标警报的评估频率。 |
| properties.resolveConfiguration |
如何解决警示的配置。 适用于 PromQLCriteria。 |
|
| 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 |
资源标记 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
好的 |
|
| Other Status Codes |
错误请求 |
安全性
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=2024-03-01-preview
{
"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"
}
}
]
}
}
定义
AdditionalInfo
一组具有“类型”和“信息”属性的对象。 “info”的模式是服务特定的,并且依赖于“类型”字符串。
| 名称 | 类型 | 说明 |
|---|---|---|
| info |
针对该类型的额外信息。 |
|
| type |
string |
附加信息的类型。 |
AggregationTypeEnum
条件时间聚合类型。 可能会返回以前未记录的值
| 值 | 说明 |
|---|---|
| Average | |
| Count | |
| Minimum | |
| Maximum | |
| Total |
DynamicMetricCriteria
动态阈值的判准标准。
| 名称 | 类型 | 说明 |
|---|---|---|
| alertSensitivity |
触发警报所需的偏差范围。 这会影响阈值对指标系列模式的严格程度。 可能会返回以前未记录的值 |
|
| criterionType |
string:
Dynamic |
指定阈值条件的类型。 可能会返回以前未记录的值 |
| dimensions |
维度条件列表。 |
|
| failingPeriods |
在引发警报所需的所选回溯时间范围内所需的最小冲突数。 |
|
| ignoreDataBefore |
string (date-time) |
使用此选项可设置开始学习指标历史数据的日期并计算动态阈值(ISO8601格式) |
| metricName |
string |
指标的名称。 |
| metricNamespace |
string |
指标Namespace。 |
| name |
string |
条件的名称。 |
| operator |
用于将指标值与阈值进行比较的运算符。 可能会返回以前未记录的值 |
|
| skipMetricValidation |
boolean |
允许尚未发出的自定义指标创建警报规则,方式是使跳过指标验证。 |
| timeAggregation |
条件时间聚合类型。 可能会返回以前未记录的值 |
DynamicPromQLCriteria
动态舞会查询的标准。
| 名称 | 类型 | 说明 |
|---|---|---|
| alertSensitivity |
触发警报所需的偏差范围。 这会影响阈值对指标系列模式的严格程度。 可能会返回以前未记录的值 |
|
| criterionType |
string:
Dynamic |
指定阈值条件的类型。 可能会返回以前未记录的值 |
| ignoreDataBefore |
string (date-time) |
使用此选项可设置开始学习指标历史数据的日期并计算动态阈值(ISO8601格式) |
| name |
string |
条件的名称。 |
| operator |
用于将指标值与阈值进行比较的运算符。 可能会返回以前未记录的值 |
|
| query |
string |
用于评估警报规则的查询 |
DynamicThresholdFailingPeriods
在引发警报所需的所选回溯时间范围内所需的最小冲突数。
| 名称 | 类型 | 说明 |
|---|---|---|
| minFailingPeriodsToAlert |
number |
触发警报的冲突数。 应小于或等于 numberOfEvaluationPeriods。 |
| numberOfEvaluationPeriods |
number |
聚合回溯点数。 回溯时间窗口是根据聚合粒度(windowSize)和所选聚合点数计算的。 |
DynamicThresholdOperator
用于将指标值与阈值进行比较的运算符。 可能会返回以前未记录的值
| 值 | 说明 |
|---|---|
| GreaterThan | |
| LessThan | |
| GreaterOrLessThan |
DynamicThresholdSensitivity
触发警报所需的偏差范围。 这会影响阈值对指标系列模式的严格程度。 可能会返回以前未记录的值
| 值 | 说明 |
|---|---|
| Low | |
| Medium | |
| High |
Error
| 名称 | 类型 | 说明 |
|---|---|---|
| additionalInfo |
一组具有“类型”和“信息”属性的对象。 “info”的模式是服务特定的,并且依赖于“类型”字符串。 |
|
| code |
string |
未局域字符串,可用于程序识别错误。 |
| details |
其他嵌套错误响应信息对象数组,如此协定所述。 |
|
| message |
string |
详细描述错误并提供调试信息。 如果请求中设置了 Accept-Language,则必须本地化到该语言。 |
| target |
string |
特定错误的目标(例如,出错的属性的名称)。 |
ErrorDetail
描述错误响应的细节。
| 名称 | 类型 | 说明 |
|---|---|---|
| additionalInfo |
一组具有“类型”和“信息”属性的对象。 “info”的模式是服务特定的,并且依赖于“类型”字符串。 |
|
| code |
string |
未局域字符串,可用于程序识别错误。 |
| message |
string |
详细描述错误并提供调试信息。 |
| target |
string |
特定错误的目标(例如,出错的属性的名称)。 |
ErrorResponse
描述错误响应的格式。
| 名称 | 类型 | 说明 |
|---|---|---|
| error |
Identity
资源的标识。
| 名称 | 类型 | 说明 |
|---|---|---|
| principalId |
string |
资源标识的主体 ID。 |
| tenantId |
string |
资源的租户 ID。 |
| type |
托管服务标识的类型。 可能会返回以前未记录的值 |
|
| userAssignedIdentities |
<string,
User |
与资源关联的用户标识列表。 用户标识字典键引用将是 Azure 资源 ID,格式为:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 |
IdentityType
托管服务标识的类型。 可能会返回以前未记录的值
| 值 | 说明 |
|---|---|
| SystemAssigned | |
| UserAssigned | |
| None |
MetricAlertAction
警报作。
| 名称 | 类型 | 说明 |
|---|---|---|
| actionGroupId |
string |
要使用的作组的 ID。 |
| webHookProperties |
object |
此字段允许指定自定义属性,这些属性将追加到作为输入发送到 Webhook 的警报有效负载中。 |
MetricAlertMultipleResourceMultipleMetricCriteria
指定具有多个指标标准的多资源的指标警报标准。
| 名称 | 类型 | 说明 |
|---|---|---|
| allOf | MultiMetricCriteria[]: |
此“全部”作的多个指标条件的列表。 |
| odata.type |
string:
Microsoft. |
指定警报条件的类型。 可能会返回以前未记录的值 |
MetricAlertResource
指标警报资源。
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
string |
Azure 资源 ID |
| identity |
资源的标识。 |
|
| location |
string |
资源位置 |
| name |
string |
Azure 资源名称 |
| properties.actionProperties |
object |
操作属性的属性。 |
| properties.actions |
警报规则处于活动状态以及解决警报条件时执行的操作数组。 |
|
| properties.autoMitigate |
boolean |
指示是否应自动解决警报的标志。 默认值为 true。 |
| properties.criteria | MetricAlertCriteria: |
定义特定的警报条件信息。 |
| properties.customProperties |
object |
警报有效负载的属性。 |
| properties.description |
string |
警报电子邮件中将包含的指标警报的说明。 |
| properties.enabled |
boolean |
指示是否启用指标警报的标志。 |
| properties.evaluationFrequency |
string (duration) |
以 ISO 8601 持续时间格式表示衡量指标警报的评估频率。 |
| properties.isMigrated |
boolean |
该值表示该警报规则是否被迁移。 |
| properties.lastUpdatedTime |
string (date-time) |
上次规则更新为ISO8601格式。 |
| properties.resolveConfiguration |
如何解决警示的配置。 适用于 PromQLCriteria。 |
|
| 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
补丁作的指标警报资源。
| 名称 | 类型 | 说明 |
|---|---|---|
| identity |
资源的标识。 |
|
| properties.actionProperties |
object |
操作属性的属性。 |
| properties.actions |
警报规则处于活动状态以及解决警报条件时执行的操作数组。 |
|
| properties.autoMitigate |
boolean |
指示是否应自动解决警报的标志。 默认值为 true。 |
| properties.criteria | MetricAlertCriteria: |
定义特定的警报条件信息。 |
| properties.customProperties |
object |
警报有效负载的属性。 |
| properties.description |
string |
警报电子邮件中将包含的指标警报的说明。 |
| properties.enabled |
boolean |
指示是否启用指标警报的标志。 |
| properties.evaluationFrequency |
string (duration) |
以 ISO 8601 持续时间格式表示衡量指标警报的评估频率。 |
| properties.isMigrated |
boolean |
该值表示该警报规则是否被迁移。 |
| properties.lastUpdatedTime |
string (date-time) |
上次规则更新为ISO8601格式。 |
| properties.resolveConfiguration |
如何解决警示的配置。 适用于 PromQLCriteria。 |
|
| 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 |
资源标记 |
MetricAlertSingleResourceMultipleMetricCriteria
指定具有多个指标标准的单一资源的指标警报标准。
| 名称 | 类型 | 说明 |
|---|---|---|
| allOf |
此“全部”操作的指标条件列表。 |
|
| odata.type |
string:
Microsoft. |
指定警报条件的类型。 可能会返回以前未记录的值 |
MetricCriteria
标准用于过滤指标。
| 名称 | 类型 | 说明 |
|---|---|---|
| criterionType |
string:
Static |
指定阈值条件的类型。 可能会返回以前未记录的值 |
| dimensions |
维度条件列表。 |
|
| metricName |
string |
指标的名称。 |
| metricNamespace |
string |
指标Namespace。 |
| name |
string |
条件的名称。 |
| operator |
条件运算符。 可能会返回以前未记录的值 |
|
| skipMetricValidation |
boolean |
允许尚未发出的自定义指标创建警报规则,方式是使跳过指标验证。 |
| threshold |
number (double) |
激活警报的条件阈值。 |
| timeAggregation |
条件时间聚合类型。 可能会返回以前未记录的值 |
MetricDimension
指定一个度量维度。
| 名称 | 类型 | 说明 |
|---|---|---|
| name |
string |
维度的名称。 |
| operator |
string |
维度运算符。 仅支持“Include”和“Exclude” |
| values |
string[] |
维度值列表。 |
Operator
条件运算符。 可能会返回以前未记录的值
| 值 | 说明 |
|---|---|
| Equals | |
| GreaterThan | |
| GreaterThanOrEqual | |
| LessThan | |
| LessThanOrEqual |
PromQLCriteria
指定了度量警报资源的PromQL标准。
| 名称 | 类型 | 说明 |
|---|---|---|
| allOf | MultiPromQLCriteria[]: |
promQL 标准列表。 当满足所有条件时,将发出警报。 |
| failingPeriods |
基于查询的警报中失败周期的配置。 |
|
| odata.type |
string:
Microsoft. |
指定警报条件的类型。 可能会返回以前未记录的值 |
QueryFailingPeriods
基于查询的警报中失败周期的配置。
| 名称 | 类型 | 说明 |
|---|---|---|
| for |
string (duration) |
触发前必须激活时间量(以 ISO 8601 持续时间格式)警报。 |
ResolveConfiguration
| 名称 | 类型 | 说明 |
|---|---|---|
| autoResolved |
boolean |
指示是否应自动解决警报 |
| timeToResolve |
string (duration) |
警报应自动解决的时间(以 ISO 8601 持续时间格式) |
StaticPromQLCriteria
静态舞会查询的标准。
| 名称 | 类型 | 说明 |
|---|---|---|
| criterionType |
string:
Static |
指定阈值条件的类型。 可能会返回以前未记录的值 |
| name |
string |
条件的名称。 |
| query |
string |
用于评估警报规则的查询 |
UserIdentityProperties
用户分配身份的属性。
| 名称 | 类型 | 说明 |
|---|---|---|
| clientId |
string |
资源身份的客户端ID。 |
| principalId |
string |
资源标识的主体 ID。 |
WebtestLocationAvailabilityCriteria
规定了网络测试资源的指标警报规则标准。
| 名称 | 类型 | 说明 |
|---|---|---|
| componentId |
string |
Application Insights 资源 ID。 |
| failedLocationCount |
number |
失败的位置数。 |
| odata.type |
string:
Microsoft. |
指定警报条件的类型。 可能会返回以前未记录的值 |
| webTestId |
string |
Application Insights Web 测试 ID。 |