Smart Detector Alert Rules - Create Or Update

參考

Service:: Monitor

API Version:: 2019-06-01

建立或更新Smart Detector警示規則。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.alertsManagement/smartDetectorAlertRules/{alertRuleName}?api-version=2019-06-01

URI 參數

名稱	位於	必要	類型	Description
alertRuleName	path	True	string	警示規則名稱。
resourceGroupName	path	True	string	資源群組的名稱。
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	用戶端 API 版本。

要求本文

名稱	必要	類型	Description
properties.actionGroups	True	ActionGroupsInformation	警示規則動作。
properties.detector	True	Detector	警示規則的偵測器。
properties.frequency	True	string	ISO8601格式的警示規則頻率。時間粒度必須以分鐘為單位，最小值為 5 分鐘。
properties.scope	True	string[]	警示規則資源範圍。
properties.severity	True	Severity	警示規則嚴重性。
properties.state	True	AlertRuleState	警示規則狀態。
location		string	資源位置。
properties.description		string	警示規則描述。
properties.throttling		ThrottlingInformation	警示規則節流資訊。
tags		object	資源標籤。

回應

名稱	類型	Description
200 OK	AlertRule	成功要求更新Smart Detector警示規則。
201 Created	AlertRule	成功要求建立Smart Detector警示規則。
Other Status Codes	SmartDetectorErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Create or update a Smart Detector alert rule

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/MyAlertRules/providers/microsoft.alertsManagement/smartDetectorAlertRules/MyAlertRule?api-version=2019-06-01

{
  "properties": {
    "description": "Sample smart detector alert rule description",
    "state": "Enabled",
    "severity": "Sev3",
    "frequency": "PT5M",
    "detector": {
      "id": "VMMemoryLeak"
    },
    "scope": [
      "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/MyVms/providers/Microsoft.Compute/virtualMachines/vm1"
    ],
    "actionGroups": {
      "customEmailSubject": "My custom email subject",
      "customWebhookPayload": "{\"AlertRuleName\":\"#alertrulename\"}",
      "groupIds": [
        "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourcegroups/actionGroups/providers/microsoft.insights/actiongroups/MyActionGroup"
      ]
    },
    "throttling": {
      "duration": "PT20M"
    }
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/MyAlertRules/providers/microsoft.alertsManagement/smartDetectorAlertRules/MyAlertRule",
  "type": "Microsoft.AlertsManagement/smartDetectorAlertRules",
  "name": "MyAlertRule",
  "location": "global",
  "tags": {},
  "properties": {
    "description": "Sample smart detector alert rule description",
    "state": "Enabled",
    "severity": "Sev3",
    "frequency": "PT5M",
    "detector": {
      "id": "VMMemoryLeak"
    },
    "scope": [
      "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/MyVms/providers/Microsoft.Compute/virtualMachines/vm1"
    ],
    "actionGroups": [
      {
        "actionGroupId": "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourcegroups/actionGroups/providers/microsoft.insights/actiongroups/MyActionGroup"
      }
    ],
    "throttling": {
      "duration": "PT20M"
    }
  }
}

Status code:: 201

{
  "id": "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/MyAlertRules/providers/microsoft.alertsManagement/smartDetectorAlertRules/MyAlertRule",
  "type": "Microsoft.AlertsManagement/smartDetectorAlertRules",
  "name": "MyAlertRule",
  "location": "global",
  "tags": {},
  "properties": {
    "description": "Sample smart detector alert rule description",
    "state": "Enabled",
    "severity": "Sev3",
    "frequency": "PT5M",
    "detector": {
      "id": "VMMemoryLeak"
    },
    "scope": [
      "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/MyVms/providers/Microsoft.Compute/virtualMachines/vm1"
    ],
    "actionGroups": [
      {
        "actionGroupId": "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourcegroups/actionGroups/providers/microsoft.insights/actiongroups/MyActionGroup"
      }
    ],
    "throttling": {
      "duration": "PT20M"
    }
  }
}

定義

名稱	Description
ActionGroupsInformation	警示規則所使用的動作群組資訊。
AlertRule	警示規則資訊
AlertRuleState	警示規則狀態。
Detector	偵測器資訊。根據預設，除非在expandDetector中指定，否則不會填入此專案
Severity	警示規則嚴重性。
SmartDetectorErrorResponse	描述錯誤回應的格式。
ThrottlingInformation	警示規則的選擇性節流資訊。

ActionGroupsInformation

警示規則所使用的動作群組資訊。

名稱	類型	Description
customEmailSubject	string	選擇性自定義電子郵件主體，用於電子郵件通知。
customWebhookPayload	string	要在 Web 攔截通知中使用的選擇性自定義 Web 攔截承載。
groupIds	string[]	動作群組資源標識碼。

AlertRule

警示規則資訊

名稱	類型	預設值	Description
id	string		資源識別碼。
location	string	global	資源位置。
name	string		資源名稱。
properties.actionGroups	ActionGroupsInformation		警示規則動作。
properties.description	string		警示規則描述。
properties.detector	Detector		警示規則的偵測器。
properties.frequency	string		ISO8601格式的警示規則頻率。時間粒度必須以分鐘為單位，最小值為 5 分鐘。
properties.scope	string[]		警示規則資源範圍。
properties.severity	Severity		警示規則嚴重性。
properties.state	AlertRuleState		警示規則狀態。
properties.throttling	ThrottlingInformation		警示規則節流資訊。
tags	object		資源標籤。
type	string		資源類型。

AlertRuleState

警示規則狀態。

名稱	類型	Description
Disabled	string
Enabled	string

Detector

偵測器資訊。根據預設，除非在expandDetector中指定，否則不會填入此專案

名稱	類型	Description
description	string	智慧偵測器描述。根據預設，除非在expandDetector中指定，否則不會填入此專案
id	string	偵測器標識碼。
imagePaths	string[]	Smart Detector 影像路徑。根據預設，除非在expandDetector中指定，否則不會填入此專案
name	string	Smart Detector 名稱。根據預設，除非在expandDetector中指定，否則不會填入此專案
parameters	object	偵測器的參數。'
supportedResourceTypes	string[]	Smart Detector 支援的資源類型。根據預設，除非在expandDetector中指定，否則不會填入此專案

Severity

警示規則嚴重性。

名稱	類型	Description
Sev0	string
Sev1	string
Sev2	string
Sev3	string
Sev4	string

SmartDetectorErrorResponse

描述錯誤回應的格式。

名稱	類型	Description
code	string	錯誤碼
message	string	指出作業失敗原因的錯誤訊息。

ThrottlingInformation

警示規則的選擇性節流資訊。

名稱	類型	Description
duration	string	必要持續時間 (ISO8601 格式) 等候，再再次通知警示規則。時間粒度必須以分鐘為單位，最小值為 0 分鐘

Share via