Smart Detector Alert Rules - Create Or Update
Smart Detector アラート ルールを作成または更新します。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.alertsManagement/smartDetectorAlertRules/{alertRuleName}?api-version=2019-06-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
alert
|
path | True |
string |
アラート ルールの名前。 |
resource
|
path | True |
string |
リソース グループの名前。 |
subscription
|
path | True |
string |
ターゲット サブスクリプションの ID。 |
api-version
|
query | True |
string |
クライアント API のバージョン。 |
要求本文
名前 | 必須 | 型 | 説明 |
---|---|---|---|
properties.actionGroups | True |
アラート ルールのアクション。 |
|
properties.detector | True |
アラート ルールの検出機能。 |
|
properties.frequency | True |
string |
アラート ルールの頻度 (ISO8601形式)。 時間の細分性は分単位で、最小値は 5 分である必要があります。 |
properties.scope | True |
string[] |
アラート ルールリソースのスコープ。 |
properties.severity | True |
アラート ルールの重大度。 |
|
properties.state | True |
アラート ルールの状態。 |
|
location |
string |
リソースの場所。 |
|
properties.description |
string |
アラート ルールの説明。 |
|
properties.throttling |
アラート ルールの調整情報。 |
||
tags |
object |
リソース タグ。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
Smart Detector アラート ルールを更新するための要求が成功しました。 |
|
201 Created |
Smart Detector アラート ルールを作成するための要求が成功しました。 |
|
Other Status Codes |
操作に失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
Create or update a Smart Detector alert rule
要求のサンプル
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"
}
}
}
応答のサンプル
{
"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"
}
}
}
{
"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"
}
}
}
定義
名前 | 説明 |
---|---|
Action |
アラート ルールで使用されるアクション グループ情報。 |
Alert |
アラート ルールの情報 |
Alert |
アラート ルールの状態。 |
Detector |
検出情報。 expandDetector で指定されていない限り、既定では設定されません |
Severity |
アラート ルールの重大度。 |
Smart |
エラー応答の形式について説明します。 |
Throttling |
アラート ルールのオプションの調整情報。 |
ActionGroupsInformation
アラート ルールで使用されるアクション グループ情報。
名前 | 型 | 説明 |
---|---|---|
customEmailSubject |
string |
電子メール通知で使用するオプションのカスタム 電子メールの件名。 |
customWebhookPayload |
string |
Web フック通知で使用するオプションのカスタム Web フック ペイロード。 |
groupIds |
string[] |
アクション グループ リソース ID。 |
AlertRule
アラート ルールの情報
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
id |
string |
リソース ID。 |
|
location |
string |
global |
リソースの場所。 |
name |
string |
リソースの名前。 |
|
properties.actionGroups |
アラート ルールのアクション。 |
||
properties.description |
string |
アラート ルールの説明。 |
|
properties.detector |
アラート ルールの検出機能。 |
||
properties.frequency |
string |
アラート ルールの頻度 (ISO8601形式)。 時間の細分性は分単位で、最小値は 5 分である必要があります。 |
|
properties.scope |
string[] |
アラート ルールリソースのスコープ。 |
|
properties.severity |
アラート ルールの重大度。 |
||
properties.state |
アラート ルールの状態。 |
||
properties.throttling |
アラート ルールの調整情報。 |
||
tags |
object |
リソース タグ。 |
|
type |
string |
リソースの種類。 |
AlertRuleState
アラート ルールの状態。
名前 | 型 | 説明 |
---|---|---|
Disabled |
string |
|
Enabled |
string |
Detector
検出情報。 expandDetector で指定されていない限り、既定では設定されません
名前 | 型 | 説明 |
---|---|---|
description |
string |
Smart Detector の説明。 expandDetector で指定されていない限り、既定では設定されません |
id |
string |
ディテクタ ID。 |
imagePaths |
string[] |
Smart Detector イメージ パス。 expandDetector で指定されていない限り、既定では設定されません |
name |
string |
Smart Detector の名前。 expandDetector で指定されていない限り、既定では設定されません |
parameters |
object |
検出機能のパラメーター。 |
supportedResourceTypes |
string[] |
Smart Detector でサポートされているリソースの種類。 expandDetector で指定されていない限り、既定では設定されません |
Severity
アラート ルールの重大度。
名前 | 型 | 説明 |
---|---|---|
Sev0 |
string |
|
Sev1 |
string |
|
Sev2 |
string |
|
Sev3 |
string |
|
Sev4 |
string |
SmartDetectorErrorResponse
エラー応答の形式について説明します。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コード |
message |
string |
操作が失敗した理由を示すエラー メッセージ。 |
ThrottlingInformation
アラート ルールのオプションの調整情報。
名前 | 型 | 説明 |
---|---|---|
duration |
string |
アラート ルールに再度通知する前に待機するために必要な期間 (ISO8601形式)。 時間の細分性は分単位で、最小値は 0 分である必要があります |