Activity Log Alerts - Create Or Update
创建新的活动日志警报规则或更新现有日志警报规则。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/activityLogAlerts/{activityLogAlertName}?api-version=2020-10-01
URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
activity
|
path | True |
string |
活动日志警报规则的名称。 |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
资源组的名称。 名称不区分大小写。 |
|
subscription
|
path | True |
string minLength: 1 |
目标订阅的 ID。 |
|
api-version
|
query | True |
string minLength: 1 |
用于此作的 API 版本。 |
请求正文
| 名称 | 必需 | 类型 | 说明 |
|---|---|---|---|
| properties.actions | True |
满足条件时将激活的操作。 |
|
| properties.condition | True |
导致此警报激活的条件。 |
|
| properties.scopes | True |
string[] |
将用作前缀的资源 ID 的列表。 警报仅适用于包含属于其中一个前缀的资源 ID 的活动日志事件。 此列表必须至少包含一个项目。 |
| location |
string |
资源的位置。 全球、西欧和北欧区域支持 Azure 活动日志警报规则。 |
|
| properties.description |
string |
此活动日志警报规则的说明。 |
|
| properties.enabled |
boolean |
指示是否启用此活动日志警报规则。 如果未启用活动日志警报规则,则不会激活其任何操作。 |
|
| tags |
object |
资源的标记。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
已成功更新现有的活动日志警报规则。 |
|
| 201 Created |
已成功创建新的活动日志警报规则。 |
|
| 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 Activity Log Alert rule |
|
Create or update an Activity Log Alert rule with 'any |
|
Create or update an Activity Log Alert rule with 'contains |
Create or update an Activity Log Alert rule
示例请求
PUT https://management.azure.com/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/activityLogAlerts/SampleActivityLogAlertRule?api-version=2020-10-01
{
"location": "Global",
"tags": {},
"properties": {
"scopes": [
"/subscriptions/187f412d-1758-44d9-b052-169e2564721d"
],
"condition": {
"allOf": [
{
"field": "category",
"equals": "Administrative"
},
{
"field": "level",
"equals": "Error"
}
]
},
"actions": {
"actionGroups": [
{
"actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/actionGroups/SampleActionGroup",
"webhookProperties": {
"sampleWebhookProperty": "SamplePropertyValue"
}
}
]
},
"enabled": true,
"description": "Description of sample Activity Log Alert rule."
}
}
示例响应
{
"id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRule",
"type": "Microsoft.Insights/ActivityLogAlerts",
"name": "SampleActivityLogAlertRule",
"location": "Global",
"tags": {},
"properties": {
"scopes": [
"subscriptions/187f412d-1758-44d9-b052-169e2564721d"
],
"condition": {
"allOf": [
{
"field": "Category",
"equals": "Administrative"
},
{
"field": "Level",
"equals": "Error"
}
]
},
"actions": {
"actionGroups": [
{
"actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/actionGroups/SampleActionGroup",
"webhookProperties": {
"sampleWebhookProperty": "SamplePropertyValue"
}
}
]
},
"enabled": true,
"description": "Description of sample Activity Log Alert rule."
}
}
{
"id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRule",
"type": "Microsoft.Insights/ActivityLogAlerts",
"name": "SampleActivityLogAlertRule",
"location": "Global",
"tags": {},
"properties": {
"scopes": [
"subscriptions/187f412d-1758-44d9-b052-169e2564721d"
],
"condition": {
"allOf": [
{
"field": "Category",
"equals": "Administrative"
},
{
"field": "Level",
"equals": "Error"
}
]
},
"actions": {
"actionGroups": [
{
"actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/actionGroups/SampleActionGroup",
"webhookProperties": {
"sampleWebhookProperty": "SamplePropertyValue"
}
}
]
},
"enabled": true,
"description": "Description of sample Activity Log Alert rule."
}
}
Create or update an Activity Log Alert rule with 'anyOf' condition
示例请求
PUT https://management.azure.com/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/activityLogAlerts/SampleActivityLogAlertRuleWithAnyOfCondition?api-version=2020-10-01
{
"location": "Global",
"tags": {},
"properties": {
"scopes": [
"subscriptions/187f412d-1758-44d9-b052-169e2564721d"
],
"condition": {
"allOf": [
{
"field": "category",
"equals": "ServiceHealth"
},
{
"anyOf": [
{
"field": "properties.incidentType",
"equals": "Incident"
},
{
"field": "properties.incidentType",
"equals": "Maintenance"
}
]
}
]
},
"actions": {
"actionGroups": [
{
"actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/actionGroups/SampleActionGroup",
"webhookProperties": {
"sampleWebhookProperty": "SamplePropertyValue"
}
}
]
},
"enabled": true,
"description": "Description of sample Activity Log Alert rule with 'anyOf' condition."
}
}
示例响应
{
"id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRuleWithAnyOfCondition",
"type": "Microsoft.Insights/ActivityLogAlerts",
"name": "SampleActivityLogAlertRuleWithAnyOfCondition",
"location": "Global",
"tags": {},
"properties": {
"scopes": [
"subscriptions/187f412d-1758-44d9-b052-169e2564721d"
],
"condition": {
"allOf": [
{
"field": "category",
"equals": "ServiceHealth"
},
{
"anyOf": [
{
"field": "properties.incidentType",
"equals": "Incident"
},
{
"field": "properties.incidentType",
"equals": "Maintenance"
}
]
}
]
},
"actions": {
"actionGroups": [
{
"actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/actionGroups/SampleActionGroup",
"webhookProperties": {
"sampleWebhookProperty": "SamplePropertyValue"
}
}
]
},
"enabled": true,
"description": "Description of sample Activity Log Alert rule with 'anyOf' condition."
}
}
{
"id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRuleWithAnyOfCondition",
"type": "Microsoft.Insights/ActivityLogAlerts",
"name": "SampleActivityLogAlertRuleWithAnyOfCondition",
"location": "Global",
"tags": {},
"properties": {
"scopes": [
"subscriptions/187f412d-1758-44d9-b052-169e2564721d"
],
"condition": {
"allOf": [
{
"field": "category",
"equals": "ServiceHealth"
},
{
"anyOf": [
{
"field": "properties.incidentType",
"equals": "Incident"
},
{
"field": "properties.incidentType",
"equals": "Maintenance"
}
]
}
]
},
"actions": {
"actionGroups": [
{
"actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/actionGroups/SampleActionGroup",
"webhookProperties": {
"sampleWebhookProperty": "SamplePropertyValue"
}
}
]
},
"enabled": true,
"description": "Description of sample Activity Log Alert rule with 'anyOf' condition."
}
}
Create or update an Activity Log Alert rule with 'containsAny'
示例请求
PUT https://management.azure.com/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/activityLogAlerts/SampleActivityLogAlertRuleWithContainsAny?api-version=2020-10-01
{
"location": "Global",
"tags": {},
"properties": {
"scopes": [
"subscriptions/187f412d-1758-44d9-b052-169e2564721d"
],
"condition": {
"allOf": [
{
"field": "category",
"equals": "ServiceHealth"
},
{
"field": "properties.impactedServices[*].ImpactedRegions[*].RegionName",
"containsAny": [
"North Europe",
"West Europe"
]
}
]
},
"actions": {
"actionGroups": [
{
"actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/actionGroups/SampleActionGroup",
"webhookProperties": {
"sampleWebhookProperty": "SamplePropertyValue"
}
}
]
},
"enabled": true,
"description": "Description of sample Activity Log Alert rule with 'containsAny'."
}
}
示例响应
{
"id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRuleWithContainsAny",
"type": "Microsoft.Insights/ActivityLogAlerts",
"name": "SampleActivityLogAlertRuleWithContainsAny",
"location": "Global",
"tags": {},
"properties": {
"scopes": [
"subscriptions/187f412d-1758-44d9-b052-169e2564721d"
],
"condition": {
"allOf": [
{
"field": "category",
"equals": "ServiceHealth"
},
{
"field": "properties.impactedServices[*].ImpactedRegions[*].RegionName",
"containsAny": [
"North Europe",
"West Europe"
]
}
]
},
"actions": {
"actionGroups": [
{
"actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/actionGroups/SampleActionGroup",
"webhookProperties": {
"sampleWebhookProperty": "SamplePropertyValue"
}
}
]
},
"enabled": true,
"description": "Description of sample Activity Log Alert rule with 'containsAny'."
}
}
{
"id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRuleWithContainsAny",
"type": "Microsoft.Insights/ActivityLogAlerts",
"name": "SampleActivityLogAlertRuleWithContainsAny",
"location": "Global",
"tags": {},
"properties": {
"scopes": [
"subscriptions/187f412d-1758-44d9-b052-169e2564721d"
],
"condition": {
"allOf": [
{
"field": "category",
"equals": "ServiceHealth"
},
{
"field": "properties.impactedServices[*].ImpactedRegions[*].RegionName",
"containsAny": [
"North Europe",
"West Europe"
]
}
]
},
"actions": {
"actionGroups": [
{
"actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/actionGroups/SampleActionGroup",
"webhookProperties": {
"sampleWebhookProperty": "SamplePropertyValue"
}
}
]
},
"enabled": true,
"description": "Description of sample Activity Log Alert rule with 'containsAny'."
}
}
定义
| 名称 | 说明 |
|---|---|
|
Action |
指向 Azure作组的指针。 |
|
Action |
活动日志警报规则作的列表。 |
|
Activity |
活动日志警报规则资源。 |
|
Alert |
满足其所有成员条件时满足的活动日志警报规则条件。 |
|
Alert |
满足其所有成员条件时满足的活动日志警报规则条件。 每个条件可以是下列类型之一:重要:每种类型都有其唯一的属性子集。 不同类型的属性不能存在于一个条件中。
|
|
Alert |
通过比较活动日志事件的字段和值来满足的活动日志警报规则条件。 此条件必须包含“field”和“equalsAny”。 |
|
Error |
错误响应。 |
ActionGroup
指向 Azure作组的指针。
| 名称 | 类型 | 说明 |
|---|---|---|
| actionGroupId |
string |
操作组的资源 ID。 这不能为 null 或为空。 |
| webhookProperties |
object |
要包含在 post 操作中的自定义属性的字典。 这些数据将追加到 Webhook 有效负载中。 |
ActionList
活动日志警报规则作的列表。
| 名称 | 类型 | 说明 |
|---|---|---|
| actionGroups |
操作组的列表。 |
ActivityLogAlertResource
活动日志警报规则资源。
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| id |
string |
资源 ID。 |
|
| location |
string |
global |
资源的位置。 全球、西欧和北欧区域支持 Azure 活动日志警报规则。 |
| name |
string |
资源的名称。 |
|
| properties.actions |
满足条件时将激活的操作。 |
||
| properties.condition |
导致此警报激活的条件。 |
||
| properties.description |
string |
此活动日志警报规则的说明。 |
|
| properties.enabled |
boolean |
True |
指示是否启用此活动日志警报规则。 如果未启用活动日志警报规则,则不会激活其任何操作。 |
| properties.scopes |
string[] |
将用作前缀的资源 ID 的列表。 警报仅适用于包含属于其中一个前缀的资源 ID 的活动日志事件。 此列表必须至少包含一个项目。 |
|
| tags |
object |
资源的标记。 |
|
| type |
string |
资源的类型。 |
AlertRuleAllOfCondition
满足其所有成员条件时满足的活动日志警报规则条件。
| 名称 | 类型 | 说明 |
|---|---|---|
| allOf |
活动日志警报规则条件的列表。 |
AlertRuleAnyOfOrLeafCondition
满足其所有成员条件时满足的活动日志警报规则条件。 每个条件可以是下列类型之一:重要:每种类型都有其唯一的属性子集。 不同类型的属性不能存在于一个条件中。
- 叶条件 - 必须包含“field”和“equalsAny”。 请注意,“anyOf”应 不在叶条件中设置。
- AnyOf 条件 - 必须仅包含 “anyOf”(即叶条件数组)的。 请注意,“field”、“equals”和“containsAny”应 不在 AnyOf 条件中设置。
| 名称 | 类型 | 说明 |
|---|---|---|
| anyOf |
活动日志警报规则“anyOf”条件。 |
|
| containsAny |
string[] |
事件字段的值将与此数组中的值(不区分大小写)进行比较,以确定是否满足条件。 |
| equals |
string |
事件字段的值将与此值(不区分大小写)进行比较,以确定是否满足条件。 |
| field |
string |
此条件将检查的活动日志事件字段的名称。 此字段的可能值为(不区分大小写):“resourceId”、“category”、“caller”、“level”、“operationName”、“resourceGroup”、“resourceProvider”、“status”、“subStatus”、“resourceType”或以“properties”开头的任何内容。 |
AlertRuleLeafCondition
通过比较活动日志事件的字段和值来满足的活动日志警报规则条件。 此条件必须包含“field”和“equalsAny”。
| 名称 | 类型 | 说明 |
|---|---|---|
| containsAny |
string[] |
事件字段的值将与此数组中的值(不区分大小写)进行比较,以确定是否满足条件。 |
| equals |
string |
事件字段的值将与此值(不区分大小写)进行比较,以确定是否满足条件。 |
| field |
string |
此条件将检查的活动日志事件字段的名称。 此字段的可能值为(不区分大小写):“resourceId”、“category”、“caller”、“level”、“operationName”、“resourceGroup”、“resourceProvider”、“status”、“subStatus”、“resourceType”或以“properties”开头的任何内容。 |
ErrorResponse
错误响应。
| 名称 | 类型 | 说明 |
|---|---|---|
| code |
string |
错误代码。 |
| message |
string |
指示作失败的原因的错误消息。 |