Microsoft.AlertsManagement actionRules

發行項
12/21/2024

Bicep 資源定義

actionRules 資源類型可以使用目標作業來部署：

資源群組 - 請參閱資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.AlertsManagement/actionRules 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.AlertsManagement/actionRules@2024-03-01-preview' = {
  location: 'string'
  name: 'string'
  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'
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

動作物件

設定 actionType 屬性，以指定物件的類型。

針對 AddActionGroups，請使用：

{
  actionGroupIds: [
    'string'
  ]
  actionType: 'AddActionGroups'
}

針對 CorrelateAlerts，請使用：

{
  actionType: 'CorrelateAlerts'
  correlateBy: [
    {
      field: 'string'
    }
  ]
  correlationInterval: 'string'
  correlationUpdates: {
    actionGroups: [
      'string'
    ]
    updateInterval: 'string'
    updateType: 'string'
  }
  notificationsForCorrelatedAlerts: 'string'
  priority: int
}

針對 RemoveAllActionGroups，請使用：

{
  actionType: 'RemoveAllActionGroups'
}

周期物件

設定 recurrenceType 屬性，以指定對象的類型。

針對每日，請使用：

{
  recurrenceType: 'Daily'
}

針對每月，請使用：

{
  daysOfMonth: [
    int
  ]
  recurrenceType: 'Monthly'
}

針對每周，請使用：

{
  daysOfWeek: [
    'string'
  ]
  recurrenceType: 'Weekly'
}

屬性值

行動

名字	描述	價值
actionType	針對 AddActionGroups 類型設定為 'AddActionGroups'，。將類型設定為 'CorrelateAlerts'，CorrelateAlerts。針對 RemoveAllActionGroups 類型設定為 'RemoveAllActionGroups'，。	'AddActionGroups' 'CorrelateAlerts' 'RemoveAllActionGroups' （必要）

AddActionGroups

名字	描述	價值
actionGroupIds	要新增至警示處理規則的動作群組標識符清單。	string[] （必要）
actionType	應套用的動作。	'AddActionGroups' （必要）

AlertProcessingRuleProperties

名字	描述	價值
行動	要套用的動作。	動作[] （必要）
條件	將篩選警示的條件。	條件[]
描述	警示處理規則的描述。	字串
啟用	指出指定的警示處理規則是否已啟用或停用。	bool
附表	警示處理規則的排程。	排程
範圍	將套用警示處理規則的範圍。	string[] （必要）

條件

名字	描述	價值
田	指定條件的欄位。	'AlertContext' 'AlertRuleId' 'AlertRuleName' 'Description' 'MonitorCondition' 'MonitorService' 'Severity' 'SignalType' 'TargetResource' 'TargetResourceGroup' 'TargetResourceType'
算子	指定條件的運算子。	'Contains' 'DoesNotContain' 'Equals' 'NotEquals'
值	要符合指定條件的值清單。	string[]

CorrelateAlerts

名字	描述	價值
actionType	應套用的動作。	'CorrelateAlerts' （必要）
correlateBy	警示相互關聯的條件清單。	CorrelateBy[] （必要）
correlationInterval	警示相互關聯的必要持續時間（ISO8601格式）。	字串（必要）
correlationUpdates	定義要套用至相互關聯的更新。	CorrelationUpdates
notificationsForCorrelatedAlerts	指出如何處理子警示通知。	'NotifyAlways' 'SuppressAlways'
優先權	這個相互關聯的優先順序。	int （必要）

CorrelateBy

名字	描述	價值
田	警示應該相互關聯的屬性 JPath。	字串

CorrelationUpdates

名字	描述	價值
actionGroups	動作群組標識碼。	string[] （必要）
updateInterval	以ISO8601格式更新通知更新的更新間隔。	字串（必要）
updateType	需要執行的更新類型。	'timeBased' （必要）

DailyRecurrence

名字	描述	價值
recurrenceType	指定何時應套用週期。	'每日' （必要）

ManagedResourceTags

名字	描述	價值

Microsoft.AlertsManagement/actionRules

名字	描述	價值
位置	資源位置	字串（必要）
名字	資源名稱	字串（必要）
性能	警示處理規則屬性。	AlertProcessingRuleProperties
標籤	資源標籤	標記名稱和值的字典。請參閱範本中的標籤

MonthlyRecurrence

名字	描述	價值
daysOfMonth	指定每月週期模式的值。	int[] （必要）
recurrenceType	指定何時應套用週期。	'每月' （必要）

復發

名字	描述	價值
endTime	週期的結束時間。	字串
recurrenceType	設定為 [每日] 類型 DailyRecurrence。針對 monthlyRecurrence 類型設定為 'Monthly'，。將類型設定為 'Weekly'，WeeklyRecurrence。	'Daily' 'Monthly' 'Weekly' （必要）
startTime	週期的開始時間。	字串

RemoveAllActionGroups

名字	描述	價值
actionType	應套用的動作。	'RemoveAllActionGroups' （必要）

附表

名字	描述	價值
effectiveFrom	排程從時間起生效。 Date-Time ISO-8601 格式，不含時區後綴。	字串約束： Pattern = `^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$`
effectiveUntil	排程有效直到時間為止。 Date-Time ISO-8601 格式，不含時區後綴。	字串約束： Pattern = `^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$`
復發	週期清單。	循環[]
timeZone	排程時區。	字串

WeeklyRecurrence

名字	描述	價值
daysOfWeek	指定每周週期模式的值。	包含任何的字串數組： 'Friday' 'Monday' 'Saturday' 'Sunday' 'Thursday' 'Tuesday' '星期三' （必要）
recurrenceType	指定何時應套用週期。	'Weekly' （必要）

快速入門範例

下列快速入門範例會部署此資源類型。

Bicep 檔案	描述
使用 Azure 監視器設定備份警示的通知	此範本可讓您使用 Azure 監視器來設定復原服務保存庫的電子郵件通知，方法是部署警示處理規則和動作群組

ARM 樣本資源定義

actionRules 資源類型可以使用目標作業來部署：

資源群組 - 請參閱資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.AlertsManagement/actionRules 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.AlertsManagement/actionRules",
  "apiVersion": "2024-03-01-preview",
  "name": "string",
  "location": "string",
  "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" ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

動作物件

設定 actionType 屬性，以指定物件的類型。

針對 AddActionGroups，請使用：

{
  "actionGroupIds": [ "string" ],
  "actionType": "AddActionGroups"
}

針對 CorrelateAlerts，請使用：

{
  "actionType": "CorrelateAlerts",
  "correlateBy": [
    {
      "field": "string"
    }
  ],
  "correlationInterval": "string",
  "correlationUpdates": {
    "actionGroups": [ "string" ],
    "updateInterval": "string",
    "updateType": "string"
  },
  "notificationsForCorrelatedAlerts": "string",
  "priority": "int"
}

針對 RemoveAllActionGroups，請使用：

{
  "actionType": "RemoveAllActionGroups"
}

周期物件

設定 recurrenceType 屬性，以指定對象的類型。

針對每日，請使用：

{
  "recurrenceType": "Daily"
}

針對每月，請使用：

{
  "daysOfMonth": [ "int" ],
  "recurrenceType": "Monthly"
}

針對每周，請使用：

{
  "daysOfWeek": [ "string" ],
  "recurrenceType": "Weekly"
}

屬性值

行動

名字	描述	價值
actionType	針對 AddActionGroups 類型設定為 'AddActionGroups'，。將類型設定為 'CorrelateAlerts'，CorrelateAlerts。針對 RemoveAllActionGroups 類型設定為 'RemoveAllActionGroups'，。	'AddActionGroups' 'CorrelateAlerts' 'RemoveAllActionGroups' （必要）

AddActionGroups

名字	描述	價值
actionGroupIds	要新增至警示處理規則的動作群組標識符清單。	string[] （必要）
actionType	應套用的動作。	'AddActionGroups' （必要）

AlertProcessingRuleProperties

名字	描述	價值
行動	要套用的動作。	動作[] （必要）
條件	將篩選警示的條件。	條件[]
描述	警示處理規則的描述。	字串
啟用	指出指定的警示處理規則是否已啟用或停用。	bool
附表	警示處理規則的排程。	排程
範圍	將套用警示處理規則的範圍。	string[] （必要）

條件

名字	描述	價值
田	指定條件的欄位。	'AlertContext' 'AlertRuleId' 'AlertRuleName' 'Description' 'MonitorCondition' 'MonitorService' 'Severity' 'SignalType' 'TargetResource' 'TargetResourceGroup' 'TargetResourceType'
算子	指定條件的運算子。	'Contains' 'DoesNotContain' 'Equals' 'NotEquals'
值	要符合指定條件的值清單。	string[]

CorrelateAlerts

名字	描述	價值
actionType	應套用的動作。	'CorrelateAlerts' （必要）
correlateBy	警示相互關聯的條件清單。	CorrelateBy[] （必要）
correlationInterval	警示相互關聯的必要持續時間（ISO8601格式）。	字串（必要）
correlationUpdates	定義要套用至相互關聯的更新。	CorrelationUpdates
notificationsForCorrelatedAlerts	指出如何處理子警示通知。	'NotifyAlways' 'SuppressAlways'
優先權	這個相互關聯的優先順序。	int （必要）

CorrelateBy

名字	描述	價值
田	警示應該相互關聯的屬性 JPath。	字串

CorrelationUpdates

名字	描述	價值
actionGroups	動作群組標識碼。	string[] （必要）
updateInterval	以ISO8601格式更新通知更新的更新間隔。	字串（必要）
updateType	需要執行的更新類型。	'timeBased' （必要）

DailyRecurrence

名字	描述	價值
recurrenceType	指定何時應套用週期。	'每日' （必要）

ManagedResourceTags

名字	描述	價值

Microsoft.AlertsManagement/actionRules

名字	描述	價值
apiVersion	API 版本	'2024-03-01-preview'
位置	資源位置	字串（必要）
名字	資源名稱	字串（必要）
性能	警示處理規則屬性。	AlertProcessingRuleProperties
標籤	資源標籤	標記名稱和值的字典。請參閱範本中的標籤
類型	資源類型	'Microsoft.AlertsManagement/actionRules'

MonthlyRecurrence

名字	描述	價值
daysOfMonth	指定每月週期模式的值。	int[] （必要）
recurrenceType	指定何時應套用週期。	'每月' （必要）

復發

名字	描述	價值
endTime	週期的結束時間。	字串
recurrenceType	設定為 [每日] 類型 DailyRecurrence。針對 monthlyRecurrence 類型設定為 'Monthly'，。將類型設定為 'Weekly'，WeeklyRecurrence。	'Daily' 'Monthly' 'Weekly' （必要）
startTime	週期的開始時間。	字串

RemoveAllActionGroups

名字	描述	價值
actionType	應套用的動作。	'RemoveAllActionGroups' （必要）

附表

名字	描述	價值
effectiveFrom	排程從時間起生效。 Date-Time ISO-8601 格式，不含時區後綴。	字串約束： Pattern = `^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$`
effectiveUntil	排程有效直到時間為止。 Date-Time ISO-8601 格式，不含時區後綴。	字串約束： Pattern = `^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$`
復發	週期清單。	循環[]
timeZone	排程時區。	字串

WeeklyRecurrence

名字	描述	價值
daysOfWeek	指定每周週期模式的值。	包含任何的字串數組： 'Friday' 'Monday' 'Saturday' 'Sunday' 'Thursday' 'Tuesday' '星期三' （必要）
recurrenceType	指定何時應套用週期。	'Weekly' （必要）

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
使用 Azure 監視器設定備份警示的通知	此範本可讓您使用 Azure 監視器來設定復原服務保存庫的電子郵件通知，方法是部署警示處理規則和動作群組

Terraform （AzAPI 提供者）資源定義

actionRules 資源類型可以使用目標作業來部署：

資源群組

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.AlertsManagement/actionRules 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AlertsManagement/actionRules@2024-03-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  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，請使用：

{
  actionGroupIds = [
    "string"
  ]
  actionType = "AddActionGroups"
}

針對 CorrelateAlerts，請使用：

{
  actionType = "CorrelateAlerts"
  correlateBy = [
    {
      field = "string"
    }
  ]
  correlationInterval = "string"
  correlationUpdates = {
    actionGroups = [
      "string"
    ]
    updateInterval = "string"
    updateType = "string"
  }
  notificationsForCorrelatedAlerts = "string"
  priority = int
}

針對 RemoveAllActionGroups，請使用：

{
  actionType = "RemoveAllActionGroups"
}

周期物件

設定 recurrenceType 屬性，以指定對象的類型。

針對每日，請使用：

{
  recurrenceType = "Daily"
}

針對每月，請使用：

{
  daysOfMonth = [
    int
  ]
  recurrenceType = "Monthly"
}

針對每周，請使用：

{
  daysOfWeek = [
    "string"
  ]
  recurrenceType = "Weekly"
}

屬性值

行動

名字	描述	價值
actionType	針對 AddActionGroups 類型設定為 'AddActionGroups'，。將類型設定為 'CorrelateAlerts'，CorrelateAlerts。針對 RemoveAllActionGroups 類型設定為 'RemoveAllActionGroups'，。	'AddActionGroups' 'CorrelateAlerts' 'RemoveAllActionGroups' （必要）

AddActionGroups

名字	描述	價值
actionGroupIds	要新增至警示處理規則的動作群組標識符清單。	string[] （必要）
actionType	應套用的動作。	'AddActionGroups' （必要）

AlertProcessingRuleProperties

名字	描述	價值
行動	要套用的動作。	動作[] （必要）
條件	將篩選警示的條件。	條件[]
描述	警示處理規則的描述。	字串
啟用	指出指定的警示處理規則是否已啟用或停用。	bool
附表	警示處理規則的排程。	排程
範圍	將套用警示處理規則的範圍。	string[] （必要）

條件

名字	描述	價值
田	指定條件的欄位。	'AlertContext' 'AlertRuleId' 'AlertRuleName' 'Description' 'MonitorCondition' 'MonitorService' 'Severity' 'SignalType' 'TargetResource' 'TargetResourceGroup' 'TargetResourceType'
算子	指定條件的運算子。	'Contains' 'DoesNotContain' 'Equals' 'NotEquals'
值	要符合指定條件的值清單。	string[]

CorrelateAlerts

名字	描述	價值
actionType	應套用的動作。	'CorrelateAlerts' （必要）
correlateBy	警示相互關聯的條件清單。	CorrelateBy[] （必要）
correlationInterval	警示相互關聯的必要持續時間（ISO8601格式）。	字串（必要）
correlationUpdates	定義要套用至相互關聯的更新。	CorrelationUpdates
notificationsForCorrelatedAlerts	指出如何處理子警示通知。	'NotifyAlways' 'SuppressAlways'
優先權	這個相互關聯的優先順序。	int （必要）

CorrelateBy

名字	描述	價值
田	警示應該相互關聯的屬性 JPath。	字串

CorrelationUpdates

名字	描述	價值
actionGroups	動作群組標識碼。	string[] （必要）
updateInterval	以ISO8601格式更新通知更新的更新間隔。	字串（必要）
updateType	需要執行的更新類型。	'timeBased' （必要）

DailyRecurrence

名字	描述	價值
recurrenceType	指定何時應套用週期。	'每日' （必要）

ManagedResourceTags

名字	描述	價值

Microsoft.AlertsManagement/actionRules

名字	描述	價值
位置	資源位置	字串（必要）
名字	資源名稱	字串（必要）
性能	警示處理規則屬性。	AlertProcessingRuleProperties
標籤	資源標籤	標記名稱和值的字典。
類型	資源類型	“Microsoft.AlertsManagement/actionRules@2024-03-01-preview”

MonthlyRecurrence

名字	描述	價值
daysOfMonth	指定每月週期模式的值。	int[] （必要）
recurrenceType	指定何時應套用週期。	'每月' （必要）

復發

名字	描述	價值
endTime	週期的結束時間。	字串
recurrenceType	設定為 [每日] 類型 DailyRecurrence。針對 monthlyRecurrence 類型設定為 'Monthly'，。將類型設定為 'Weekly'，WeeklyRecurrence。	'Daily' 'Monthly' 'Weekly' （必要）
startTime	週期的開始時間。	字串

RemoveAllActionGroups

名字	描述	價值
actionType	應套用的動作。	'RemoveAllActionGroups' （必要）

附表

名字	描述	價值
effectiveFrom	排程從時間起生效。 Date-Time ISO-8601 格式，不含時區後綴。	字串約束： Pattern = `^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$`
effectiveUntil	排程有效直到時間為止。 Date-Time ISO-8601 格式，不含時區後綴。	字串約束： Pattern = `^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$`
復發	週期清單。	循環[]
timeZone	排程時區。	字串

WeeklyRecurrence

名字	描述	價值
daysOfWeek	指定每周週期模式的值。	包含任何的字串數組： 'Friday' 'Monday' 'Saturday' 'Sunday' 'Thursday' 'Tuesday' '星期三' （必要）
recurrenceType	指定何時應套用週期。	'Weekly' （必要）

共用方式為

Microsoft.AlertsManagement actionRules

Bicep 資源定義

資源格式

動作物件

周期物件

屬性值

行動

AddActionGroups

AlertProcessingRuleProperties

條件

CorrelateAlerts

CorrelateBy

CorrelationUpdates

DailyRecurrence

ManagedResourceTags

Microsoft.AlertsManagement/actionRules

MonthlyRecurrence

復發

RemoveAllActionGroups

附表

WeeklyRecurrence

快速入門範例

ARM 樣本資源定義

資源格式

動作物件

周期物件

屬性值

行動

AddActionGroups

AlertProcessingRuleProperties

條件

CorrelateAlerts

CorrelateBy

CorrelationUpdates

DailyRecurrence

ManagedResourceTags

Microsoft.AlertsManagement/actionRules

MonthlyRecurrence

復發

RemoveAllActionGroups

附表

WeeklyRecurrence

快速入門範本

Terraform （AzAPI 提供者） 資源定義

資源格式

動作物件

周期物件

屬性值

行動

AddActionGroups

AlertProcessingRuleProperties

條件

CorrelateAlerts

CorrelateBy

CorrelationUpdates

DailyRecurrence

ManagedResourceTags

Microsoft.AlertsManagement/actionRules

MonthlyRecurrence

復發

RemoveAllActionGroups

附表

WeeklyRecurrence

意見反應

其他資源

Terraform （AzAPI 提供者）資源定義