microsoft.alertsManagement smartDetectorAlertRules 2021-04-01
Bicep-Ressourcendefinition
Der Ressourcentyp smartDetectorAlertRules kann für folgendes bereitgestellt werden:
- Ressourcengruppen : Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Bemerkungen
Anleitungen zum Bereitstellen von Überwachungslösungen finden Sie unter Erstellen von Überwachungsressourcen mit Bicep.
Ressourcenformat
Um eine microsoft.alertsManagement/smartDetectorAlertRules-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.
resource symbolicname 'microsoft.alertsManagement/smartDetectorAlertRules@2021-04-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
actionGroups: {
customEmailSubject: 'string'
customWebhookPayload: 'string'
groupIds: [
'string'
]
}
description: 'string'
detector: {
id: 'string'
parameters: {}
}
frequency: 'string'
scope: [
'string'
]
severity: 'string'
state: 'string'
throttling: {
duration: 'string'
}
}
}
Eigenschaftswerte
smartDetectorAlertRules
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| location | Der Ressourcenspeicherort. | Zeichenfolge |
| tags | Die Ressourcentags. | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
| properties | Die Eigenschaften der Warnungsregel. | AlertRuleProperties |
AlertRuleProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| actionGroups | Die Warnungsregelaktionen. | ActionGroupsInformation (erforderlich) |
| description | Die Beschreibung der Warnungsregel. | Zeichenfolge |
| Detektor | Der Detektor der Warnungsregel. | Detektor (erforderlich) |
| frequency | Die Häufigkeit der Warnungsregel im ISO8601-Format. Die Zeitgranularität muss in Minuten sein, und der Mindestwert beträgt je nach Detektor 1 Minute. | Zeichenfolge (erforderlich) |
| scope | Der Ressourcenbereich der Warnungsregel. | string[] (erforderlich) |
| severity | Der Schweregrad der Warnungsregel. | 'Sev0' 'Sev1' 'Sev2' 'Sev3' 'Sev4' (erforderlich) |
| state | Der Status der Warnungsregel. | "Deaktiviert" "Aktiviert" (erforderlich) |
| Drosselung | Die Warnungsregel drosselt Informationen. | DrosselungInformation |
ActionGroupsInformation
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| customEmailSubject | Eine optionale benutzerdefinierte E-Mail, die in E-Mail-Benachrichtigungen verwendet werden kann. | Zeichenfolge |
| customWebhookPayload | Eine optionale benutzerdefinierte Webhakennutzlast, die in Web-Hook-Benachrichtigungen verwendet werden kann. | Zeichenfolge |
| groupIds | Die Ressourcen-IDs der Aktionsgruppe. | string[] (erforderlich) |
Erkennungsmodul
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| id | Die Detektor-ID. | Zeichenfolge (erforderlich) |
| parameters | Die Parameter des Detektors." | Objekt |
DrosselungInformation
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| duration | Die erforderliche Dauer (im ISO8601-Format), um zu warten, bevor die Warnungsregel erneut benachrichtigt wird. Die Zeitgranularität muss in Minuten sein, und der Mindestwert beträgt 0 Minuten. | Zeichenfolge |
Ressourcendefinition mit einer ARM-Vorlage
Der Ressourcentyp smartDetectorAlertRules kann für folgendes bereitgestellt werden:
- Ressourcengruppen : Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Bemerkungen
Anleitungen zum Bereitstellen von Überwachungslösungen finden Sie unter Erstellen von Überwachungsressourcen mit Bicep.
Ressourcenformat
Um eine microsoft.alertsManagement/smartDetectorAlertRules-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"type": "microsoft.alertsManagement/smartDetectorAlertRules",
"apiVersion": "2021-04-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"actionGroups": {
"customEmailSubject": "string",
"customWebhookPayload": "string",
"groupIds": [ "string" ]
},
"description": "string",
"detector": {
"id": "string",
"parameters": {}
},
"frequency": "string",
"scope": [ "string" ],
"severity": "string",
"state": "string",
"throttling": {
"duration": "string"
}
}
}
Eigenschaftswerte
smartDetectorAlertRules
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Ressourcentyp | "microsoft.alertsManagement/smartDetectorAlertRules" |
| apiVersion | Die Version der Ressourcen-API | '2021-04-01' |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| location | Der Ressourcenspeicherort. | Zeichenfolge |
| tags | Die Ressourcentags. | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
| properties | Die Eigenschaften der Warnungsregel. | AlertRuleProperties |
AlertRuleProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| actionGroups | Die Warnungsregelaktionen. | ActionGroupsInformation (erforderlich) |
| description | Die Beschreibung der Warnungsregel. | Zeichenfolge |
| Detektor | Der Detektor der Warnungsregel. | Detektor (erforderlich) |
| frequency | Die Häufigkeit der Warnungsregel im ISO8601-Format. Die Zeitgranularität muss in Minuten sein, und der Mindestwert beträgt je nach Detektor 1 Minute. | Zeichenfolge (erforderlich) |
| scope | Der Ressourcenbereich der Warnungsregel. | string[] (erforderlich) |
| severity | Der Schweregrad der Warnungsregel. | 'Sev0' 'Sev1' 'Sev2' 'Sev3' 'Sev4' (erforderlich) |
| state | Der Status der Warnungsregel. | "Deaktiviert" "Aktiviert" (erforderlich) |
| Drosselung | Die Warnungsregel drosselt Informationen. | DrosselungInformation |
ActionGroupsInformation
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| customEmailSubject | Eine optionale benutzerdefinierte E-Mail, die in E-Mail-Benachrichtigungen verwendet werden kann. | Zeichenfolge |
| customWebhookPayload | Eine optionale benutzerdefinierte Webhakennutzlast, die in Web-Hook-Benachrichtigungen verwendet werden kann. | Zeichenfolge |
| groupIds | Die Ressourcen-IDs der Aktionsgruppe. | string[] (erforderlich) |
Erkennungsmodul
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| id | Die Detektor-ID. | Zeichenfolge (erforderlich) |
| parameters | Die Parameter des Detektors." | Objekt |
DrosselungInformation
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| duration | Die erforderliche Dauer (im ISO8601-Format), um zu warten, bevor die Warnungsregel erneut benachrichtigt wird. Die Zeitgranularität muss in Minuten sein, und der Mindestwert beträgt 0 Minuten. | Zeichenfolge |
Terraform (AzAPI-Anbieter) Ressourcendefinition
Der Ressourcentyp smartDetectorAlertRules kann für folgendes bereitgestellt werden:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine ressource microsoft.alertsManagement/smartDetectorAlertRules zu erstellen, fügen Sie ihrer Vorlage den folgenden Terraform hinzu.
resource "azapi_resource" "symbolicname" {
type = "microsoft.alertsManagement/smartDetectorAlertRules@2021-04-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
actionGroups = {
customEmailSubject = "string"
customWebhookPayload = "string"
groupIds = [
"string"
]
}
description = "string"
detector = {
id = "string"
parameters = {}
}
frequency = "string"
scope = [
"string"
]
severity = "string"
state = "string"
throttling = {
duration = "string"
}
}
})
}
Eigenschaftswerte
smartDetectorAlertRules
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Ressourcentyp | "microsoft.alertsManagement/smartDetectorAlertRules@2021-04-01" |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| location | Der Ressourcenspeicherort. | Zeichenfolge |
| parent_id | Verwenden Sie zum Bereitstellen in einer Ressourcengruppe die ID dieser Ressourcengruppe. | Zeichenfolge (erforderlich) |
| tags | Die Ressourcentags. | Wörterbuch der Tagnamen und -werte. |
| properties | Die Eigenschaften der Warnungsregel. | AlertRuleProperties |
AlertRuleProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| actionGroups | Die Warnungsregelaktionen. | ActionGroupsInformation (erforderlich) |
| description | Die Beschreibung der Warnungsregel. | Zeichenfolge |
| Detektor | Die Erkennung der Warnungsregel. | Erkennung (erforderlich) |
| frequency | Die Häufigkeit der Warnungsregel im ISO8601-Format. Die Zeitgranularität muss in Minuten angegeben werden, und der Mindestwert beträgt je nach Erkennung 1 Minute. | Zeichenfolge (erforderlich) |
| scope | Der Ressourcenbereich der Warnungsregel. | string[] (erforderlich) |
| severity | Der Schweregrad der Warnungsregel. | "Sev0" "Sev1" "Sev2" "Sev3" "Sev4" (erforderlich) |
| state | Der Status der Warnungsregel. | "Deaktiviert" "Aktiviert" (erforderlich) |
| Drosselung | Informationen zur Drosselung der Warnungsregel. | DrosselungInformation |
ActionGroupsInformation
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| customEmailSubject | Ein optionaler benutzerdefinierter E-Mail-Betreff, der in E-Mail-Benachrichtigungen verwendet werden kann. | Zeichenfolge |
| customWebhookPayload | Eine optionale benutzerdefinierte Webhooknutzlast, die in Webhookbenachrichtigungen verwendet werden soll. | Zeichenfolge |
| groupIds | Die Ressourcen-IDs der Aktionsgruppe. | string[] (erforderlich) |
Erkennungsmodul
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| id | Die Detektor-ID. | Zeichenfolge (erforderlich) |
| parameters | Die Parameter des Detektors." | Objekt |
DrosselungInformation
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| duration | Die erforderliche Dauer (im ISO8601-Format), um zu warten, bevor die Warnungsregel erneut benachrichtigt wird. Die Zeitgranularität muss in Minuten und der Mindestwert 0 Minuten betragen. | Zeichenfolge |