你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Microsoft.AlertsManagement actionRules
Bicep 资源定义
actionRules 资源类型可以部署到:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.AlertsManagement/actionRules 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.AlertsManagement/actionRules@2021-08-08' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
actions: [
{
actionType: 'string'
// For remaining properties, see Action objects
}
]
conditions: [
{
field: 'string'
operator: 'string'
values: [
'string'
]
}
]
description: 'string'
enabled: bool
schedule: {
effectiveFrom: 'string'
effectiveUntil: 'string'
recurrences: [
{
endTime: 'string'
startTime: 'string'
recurrenceType: 'string'
// For remaining properties, see Recurrence objects
}
]
timeZone: 'string'
}
scopes: [
'string'
]
}
}
操作对象
设置 actionType 属性以指定对象的类型。
对于 AddActionGroups,请使用:
actionType: 'AddActionGroups'
actionGroupIds: [
'string'
]
对于 RemoveAllActionGroups,请使用:
actionType: 'RemoveAllActionGroups'
Recurrence 对象
设置 recurrenceType 属性以指定对象的类型。
对于 “每日”,请使用:
recurrenceType: 'Daily'
对于 “每月”,请使用:
recurrenceType: 'Monthly'
daysOfMonth: [
int
]
对于 “每周”,请使用:
recurrenceType: 'Weekly'
daysOfWeek: [
'string'
]
属性值
actionRules
名称 | 说明 | 值 |
---|---|---|
name | 资源名称 | 字符串 (必需) |
location | 资源位置 | 字符串 (必需) |
标记 | 资源标记 | 标记名称和值的字典。 请参阅 模板中的标记 |
properties | 警报处理规则属性。 | AlertProcessingRuleProperties |
AlertProcessingRuleProperties
名称 | 说明 | 值 |
---|---|---|
actions | 要应用的操作。 | 操作[] (必需) |
条件 | 筛选警报的条件。 | Condition[] |
description | 警报处理规则的说明。 | 字符串 |
enabled | 指示给定的警报处理规则是启用或禁用的。 | bool |
schedule | 计划警报处理规则。 | 计划 |
范围 | 将应用警报处理规则的范围。 | string[] (必需) |
操作
名称 | 说明 | 值 |
---|---|---|
actionType | 设置对象类型 | AddActionGroups RemoveAllActionGroups (必需) |
AddActionGroups
名称 | 说明 | 值 |
---|---|---|
actionType | 应应用的操作。 | “AddActionGroups” (必需) |
actionGroupIds | 要添加到警报处理规则的操作组 ID 列表。 | string[] (必需) |
RemoveAllActionGroups
名称 | 说明 | 值 |
---|---|---|
actionType | 应应用的操作。 | “RemoveAllActionGroups” (必需) |
条件
名称 | 说明 | 值 |
---|---|---|
field | 给定条件的字段。 | 'AlertContext' 'AlertRuleId' 'AlertRuleName' 'Description' “MonitorCondition” “MonitorService” “严重性” “SignalType” “TargetResource” “TargetResourceGroup” “TargetResourceType” |
运算符后的表达式 | 给定条件的运算符。 | “Contains” 'DoesNotContain' “Equals” “NotEquals” |
值 | 要与给定条件匹配的值列表。 | string[] |
计划
名称 | 说明 | 值 |
---|---|---|
effectiveFrom | 计划从时间起生效。 Date-Time ISO-8601 格式,不带时区后缀。 | 字符串 |
effectiveUntil | 计划有效到时间为止。 Date-Time ISO-8601 格式,不带时区后缀。 | string |
复发 | 定期列表。 | Recurrence[] |
timezone | 计划时区。 | 字符串 |
定期
名称 | 说明 | 值 |
---|---|---|
endTime | 定期的结束时间。 | string |
startTime | 定期的开始时间。 | string |
recurrenceType | 设置对象类型 | 每日 每月 每周 (必需) |
DailyRecurrence
名称 | 说明 | 值 |
---|---|---|
recurrenceType | 指定何时应应用定期。 | 需要“每日” () |
MonthlyRecurrence
名称 | 说明 | 值 |
---|---|---|
recurrenceType | 指定何时应应用定期。 | “每月” (必需) |
daysOfMonth | 指定每月重复模式的值。 | int[] (必需的) |
WeeklyRecurrence
名称 | 说明 | 值 |
---|---|---|
recurrenceType | 指定何时应应用定期。 | 需要“每周” () |
daysOfWeek | 指定每周重复模式的值。 | 包含任意项的字符串数组: “Friday” “Monday” “Saturday” “星期日” “星期四” “Tuesday” 需要“星期三” () |
快速入门模板
以下快速入门模板部署此资源类型。
模板 | 说明 |
---|---|
使用 Azure Monitor 设置备份警报通知 |
通过此模板,可以通过部署警报处理规则和操作组,使用 Azure Monitor 为恢复服务保管库设置电子邮件通知 |
ARM 模板资源定义
actionRules 资源类型可以部署到:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.AlertsManagement/actionRules 资源,请将以下 JSON 添加到模板。
{
"type": "Microsoft.AlertsManagement/actionRules",
"apiVersion": "2021-08-08",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"actions": [
{
"actionType": "string"
// For remaining properties, see Action objects
}
],
"conditions": [
{
"field": "string",
"operator": "string",
"values": [ "string" ]
}
],
"description": "string",
"enabled": "bool",
"schedule": {
"effectiveFrom": "string",
"effectiveUntil": "string",
"recurrences": [
{
"endTime": "string",
"startTime": "string",
"recurrenceType": "string"
// For remaining properties, see Recurrence objects
}
],
"timeZone": "string"
},
"scopes": [ "string" ]
}
}
操作对象
设置 actionType 属性以指定对象的类型。
对于 AddActionGroups,请使用:
"actionType": "AddActionGroups",
"actionGroupIds": [ "string" ]
对于 RemoveAllActionGroups,请使用:
"actionType": "RemoveAllActionGroups"
定期对象
设置 recurrenceType 属性以指定对象的类型。
对于 “每日”,请使用:
"recurrenceType": "Daily"
对于 “每月”,请使用:
"recurrenceType": "Monthly",
"daysOfMonth": [ "int" ]
对于 “每周”,请使用:
"recurrenceType": "Weekly",
"daysOfWeek": [ "string" ]
属性值
actionRules
名称 | 说明 | Value |
---|---|---|
type | 资源类型 | “Microsoft.AlertsManagement/actionRules” |
apiVersion | 资源 API 版本 | '2021-08-08' |
name | 资源名称 | 字符串 (必需) |
location | 资源位置 | 字符串 (必需) |
标记 | 资源标记 | 标记名称和值的字典。 请参阅 模板中的标记 |
properties | 警报处理规则属性。 | AlertProcessingRuleProperties |
AlertProcessingRuleProperties
名称 | 说明 | 值 |
---|---|---|
actions | 要应用的操作。 | Action[] (必需的) |
条件 | 筛选警报的条件。 | Condition[] |
description | 警报处理规则的说明。 | 字符串 |
enabled | 指示是启用或禁用给定的警报处理规则。 | bool |
schedule | 警报处理规则的计划。 | 计划 |
范围 | 将应用警报处理规则的范围。 | string[] (必需的) |
操作
名称 | 说明 | 值 |
---|---|---|
actionType | 设置对象类型 | AddActionGroups RemoveAllActionGroups (必需) |
AddActionGroups
名称 | 说明 | 值 |
---|---|---|
actionType | 应应用的操作。 | “AddActionGroups” (必需) |
actionGroupIds | 要添加到警报处理规则的操作组 ID 列表。 | string[] (必需的) |
RemoveAllActionGroups
名称 | 说明 | 值 |
---|---|---|
actionType | 应应用的操作。 | “RemoveAllActionGroups” (必需) |
条件
名称 | 说明 | 值 |
---|---|---|
field | 给定条件的字段。 | “AlertContext” “AlertRuleId” “AlertRuleName” “说明” “MonitorCondition” “MonitorService” “严重性” “SignalType” “TargetResource” “TargetResourceGroup” “TargetResourceType” |
运算符后的表达式 | 给定条件的运算符。 | “Contains” 'DoesNotContain' “Equals” “NotEquals” |
值 | 要与给定条件匹配的值列表。 | string[] |
计划
名称 | 说明 | 值 |
---|---|---|
effectiveFrom | 计划从时间起生效。 不带时区后缀的 ISO-8601 格式的Date-Time。 | 字符串 |
effectiveUntil | 计划有效到时间为止。 不带时区后缀的 ISO-8601 格式的Date-Time。 | 字符串 |
复发 | 重复周期列表。 | Recurrence[] |
timezone | 计划时区。 | string |
定期
名称 | 说明 | 值 |
---|---|---|
endTime | 重复周期的结束时间。 | 字符串 |
startTime | 重复周期的开始时间。 | 字符串 |
recurrenceType | 设置对象类型 | 每日 每月 需要每周 () |
DailyRecurrence
名称 | 说明 | 值 |
---|---|---|
recurrenceType | 指定何时应应用重复周期。 | “每日” (必需) |
MonthlyRecurrence
名称 | 说明 | 值 |
---|---|---|
recurrenceType | 指定何时应应用重复周期。 | 需要“每月” () |
daysOfMonth | 指定每月重复模式的值。 | int[] (必需) |
WeeklyRecurrence
名称 | 说明 | 值 |
---|---|---|
recurrenceType | 指定何时应应用重复周期。 | 需要“每周” () |
daysOfWeek | 指定每周重复模式的值。 | 包含任何一项的字符串数组: “Friday” “Monday” “Saturday” “星期日” “星期四” “Tuesday” 需要“星期三” () |
快速入门模板
以下快速入门模板部署此资源类型。
模板 | 说明 |
---|---|
使用 Azure Monitor 设置备份警报通知 |
使用此模板,可以通过部署警报处理规则和操作组,使用 Azure Monitor 为恢复服务保管库设置电子邮件通知 |
Terraform (AzAPI 提供程序) 资源定义
actionRules 资源类型可以部署到:
- 资源组
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.AlertsManagement/actionRules 资源,请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AlertsManagement/actionRules@2021-08-08"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
actions = [
{
actionType = "string"
// For remaining properties, see Action objects
}
]
conditions = [
{
field = "string"
operator = "string"
values = [
"string"
]
}
]
description = "string"
enabled = bool
schedule = {
effectiveFrom = "string"
effectiveUntil = "string"
recurrences = [
{
endTime = "string"
startTime = "string"
recurrenceType = "string"
// For remaining properties, see Recurrence objects
}
]
timeZone = "string"
}
scopes = [
"string"
]
}
})
}
操作对象
设置 actionType 属性以指定对象的类型。
对于 AddActionGroups,请使用:
actionType = "AddActionGroups"
actionGroupIds = [
"string"
]
对于 RemoveAllActionGroups,请使用:
actionType = "RemoveAllActionGroups"
Recurrence 对象
设置 recurrenceType 属性以指定对象的类型。
对于 “每日”,请使用:
recurrenceType = "Daily"
对于 “每月”,请使用:
recurrenceType = "Monthly"
daysOfMonth = [
int
]
对于 “每周”,请使用:
recurrenceType = "Weekly"
daysOfWeek = [
"string"
]
属性值
actionRules
名称 | 说明 | Value |
---|---|---|
type | 资源类型 | “Microsoft.AlertsManagement/actionRules@2021-08-08” |
name | 资源名称 | 字符串 (必需) |
location | 资源位置 | 字符串 (必需) |
parent_id | 若要部署到资源组,请使用该资源组的 ID。 | 字符串 (必需) |
标记 | 资源标记 | 标记名称和值的字典。 |
properties | 警报处理规则属性。 | AlertProcessingRuleProperties |
AlertProcessingRuleProperties
名称 | 说明 | 值 |
---|---|---|
actions | 要应用的操作。 | Action[] (必需的) |
条件 | 筛选警报的条件。 | Condition[] |
description | 警报处理规则的说明。 | 字符串 |
enabled | 指示是启用或禁用给定的警报处理规则。 | bool |
schedule | 警报处理规则的计划。 | 计划 |
范围 | 将应用警报处理规则的范围。 | string[] (必需的) |
操作
名称 | 说明 | 值 |
---|---|---|
actionType | 设置对象类型 | AddActionGroups RemoveAllActionGroups (必需) |
AddActionGroups
名称 | 说明 | 值 |
---|---|---|
actionType | 应应用的操作。 | “AddActionGroups” (必需) |
actionGroupIds | 要添加到警报处理规则的操作组 ID 列表。 | string[] (必需的) |
RemoveAllActionGroups
名称 | 说明 | 值 |
---|---|---|
actionType | 应应用的操作。 | “RemoveAllActionGroups” (必需) |
条件
名称 | 说明 | 值 |
---|---|---|
field | 给定条件的字段。 | “AlertContext” “AlertRuleId” “AlertRuleName” “说明” “MonitorCondition” “MonitorService” “严重性” “SignalType” “TargetResource” “TargetResourceGroup” “TargetResourceType” |
运算符后的表达式 | 给定条件的运算符。 | “Contains” “DoesNotContain” “Equals” “NotEquals” |
值 | 要与给定条件匹配的值列表。 | string[] |
计划
名称 | 说明 | 值 |
---|---|---|
effectiveFrom | 计划从时间起生效。 Date-Time ISO-8601 格式,不带时区后缀。 | 字符串 |
effectiveUntil | 计划有效到时间为止。 Date-Time ISO-8601 格式,不带时区后缀。 | 字符串 |
复发 | 定期列表。 | Recurrence[] |
timezone | 计划时区。 | string |
定期
名称 | 说明 | 值 |
---|---|---|
endTime | 定期的结束时间。 | string |
startTime | 定期的开始时间。 | string |
recurrenceType | 设置对象类型 | 每日 每月 每周 (必需) |
DailyRecurrence
名称 | 说明 | 值 |
---|---|---|
recurrenceType | 指定何时应应用定期。 | 需要“每日” () |
MonthlyRecurrence
名称 | 说明 | 值 |
---|---|---|
recurrenceType | 指定何时应应用定期。 | 需要“每月” () |
daysOfMonth | 指定每月重复模式的值。 | int[] (必需的) |
WeeklyRecurrence
名称 | 说明 | 值 |
---|---|---|
recurrenceType | 指定何时应应用定期。 | “每周” (必需) |
daysOfWeek | 指定每周重复模式的值。 | 包含任意项的字符串数组: "Friday" “星期一” “星期六” "Sunday" "Thursday" "Tuesday" 需要“星期三” () |