|
| 1 | +{ |
| 2 | + "id": "https://schema.management.azure.com/schemas/2019-03-01/microsoft.alertsManagement.json#", |
| 3 | + "$schema": "http://json-schema.org/draft-04/schema#", |
| 4 | + "title": "microsoft.alertsManagement", |
| 5 | + "description": "microsoft alertsManagement Resource Types", |
| 6 | + "resourceDefinitions": { |
| 7 | + "smartDetectorAlertRules": { |
| 8 | + "type": "object", |
| 9 | + "properties": { |
| 10 | + "apiVersion": { |
| 11 | + "type": "string", |
| 12 | + "enum": [ |
| 13 | + "2019-03-01" |
| 14 | + ] |
| 15 | + }, |
| 16 | + "name": { |
| 17 | + "type": "string", |
| 18 | + "description": "The name of the alert rule." |
| 19 | + }, |
| 20 | + "properties": { |
| 21 | + "oneOf": [ |
| 22 | + { |
| 23 | + "$ref": "#/definitions/AlertRuleProperties" |
| 24 | + }, |
| 25 | + { |
| 26 | + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" |
| 27 | + } |
| 28 | + ], |
| 29 | + "description": "The alert rule properties." |
| 30 | + }, |
| 31 | + "type": { |
| 32 | + "type": "string", |
| 33 | + "enum": [ |
| 34 | + "microsoft.alertsManagement/smartDetectorAlertRules" |
| 35 | + ] |
| 36 | + } |
| 37 | + }, |
| 38 | + "required": [ |
| 39 | + "apiVersion", |
| 40 | + "name", |
| 41 | + "properties", |
| 42 | + "type" |
| 43 | + ], |
| 44 | + "description": "microsoft.alertsManagement/smartDetectorAlertRules" |
| 45 | + } |
| 46 | + }, |
| 47 | + "definitions": { |
| 48 | + "ActionGroupsInformation": { |
| 49 | + "type": "object", |
| 50 | + "properties": { |
| 51 | + "customEmailSubject": { |
| 52 | + "type": "string", |
| 53 | + "description": "An optional custom email subject to use in email notifications." |
| 54 | + }, |
| 55 | + "customWebhookPayload": { |
| 56 | + "type": "string", |
| 57 | + "description": "An optional custom web-hook payload to use in web-hook notifications." |
| 58 | + }, |
| 59 | + "groupIds": { |
| 60 | + "oneOf": [ |
| 61 | + { |
| 62 | + "type": "array", |
| 63 | + "items": { |
| 64 | + "type": "string" |
| 65 | + } |
| 66 | + }, |
| 67 | + { |
| 68 | + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" |
| 69 | + } |
| 70 | + ], |
| 71 | + "description": "The Action Group resource IDs." |
| 72 | + } |
| 73 | + }, |
| 74 | + "required": [ |
| 75 | + "groupIds" |
| 76 | + ], |
| 77 | + "description": "The Action Groups information, used by the alert rule." |
| 78 | + }, |
| 79 | + "AlertRuleProperties": { |
| 80 | + "type": "object", |
| 81 | + "properties": { |
| 82 | + "actionGroups": { |
| 83 | + "oneOf": [ |
| 84 | + { |
| 85 | + "$ref": "#/definitions/ActionGroupsInformation" |
| 86 | + }, |
| 87 | + { |
| 88 | + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" |
| 89 | + } |
| 90 | + ], |
| 91 | + "description": "The Action Groups information, used by the alert rule." |
| 92 | + }, |
| 93 | + "description": { |
| 94 | + "type": "string", |
| 95 | + "description": "The alert rule description." |
| 96 | + }, |
| 97 | + "detector": { |
| 98 | + "oneOf": [ |
| 99 | + { |
| 100 | + "$ref": "#/definitions/Detector" |
| 101 | + }, |
| 102 | + { |
| 103 | + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" |
| 104 | + } |
| 105 | + ], |
| 106 | + "description": "The detector information. By default this is not populated, unless it's specified in expandDetector" |
| 107 | + }, |
| 108 | + "frequency": { |
| 109 | + "type": "string", |
| 110 | + "format": "duration", |
| 111 | + "description": "The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 5 minutes." |
| 112 | + }, |
| 113 | + "scope": { |
| 114 | + "oneOf": [ |
| 115 | + { |
| 116 | + "type": "array", |
| 117 | + "items": { |
| 118 | + "type": "string" |
| 119 | + } |
| 120 | + }, |
| 121 | + { |
| 122 | + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" |
| 123 | + } |
| 124 | + ], |
| 125 | + "description": "The alert rule resources scope." |
| 126 | + }, |
| 127 | + "severity": { |
| 128 | + "oneOf": [ |
| 129 | + { |
| 130 | + "type": "string", |
| 131 | + "enum": [ |
| 132 | + "Sev0", |
| 133 | + "Sev1", |
| 134 | + "Sev2", |
| 135 | + "Sev3", |
| 136 | + "Sev4" |
| 137 | + ] |
| 138 | + }, |
| 139 | + { |
| 140 | + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" |
| 141 | + } |
| 142 | + ], |
| 143 | + "description": "The alert rule severity." |
| 144 | + }, |
| 145 | + "state": { |
| 146 | + "oneOf": [ |
| 147 | + { |
| 148 | + "type": "string", |
| 149 | + "enum": [ |
| 150 | + "Enabled", |
| 151 | + "Disabled" |
| 152 | + ] |
| 153 | + }, |
| 154 | + { |
| 155 | + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" |
| 156 | + } |
| 157 | + ], |
| 158 | + "description": "The alert rule state." |
| 159 | + }, |
| 160 | + "throttling": { |
| 161 | + "oneOf": [ |
| 162 | + { |
| 163 | + "$ref": "#/definitions/ThrottlingInformation" |
| 164 | + }, |
| 165 | + { |
| 166 | + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" |
| 167 | + } |
| 168 | + ], |
| 169 | + "description": "Optional throttling information for the alert rule." |
| 170 | + } |
| 171 | + }, |
| 172 | + "required": [ |
| 173 | + "actionGroups", |
| 174 | + "detector", |
| 175 | + "frequency", |
| 176 | + "scope", |
| 177 | + "severity", |
| 178 | + "state" |
| 179 | + ], |
| 180 | + "description": "The alert rule properties." |
| 181 | + }, |
| 182 | + "Detector": { |
| 183 | + "type": "object", |
| 184 | + "properties": { |
| 185 | + "description": { |
| 186 | + "type": "string", |
| 187 | + "description": "The Smart Detector description. By default this is not populated, unless it's specified in expandDetector" |
| 188 | + }, |
| 189 | + "id": { |
| 190 | + "type": "string", |
| 191 | + "description": "The detector id." |
| 192 | + }, |
| 193 | + "imagePaths": { |
| 194 | + "oneOf": [ |
| 195 | + { |
| 196 | + "type": "array", |
| 197 | + "items": { |
| 198 | + "type": "string" |
| 199 | + } |
| 200 | + }, |
| 201 | + { |
| 202 | + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" |
| 203 | + } |
| 204 | + ], |
| 205 | + "description": "The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector" |
| 206 | + }, |
| 207 | + "name": { |
| 208 | + "type": "string", |
| 209 | + "description": "The Smart Detector name. By default this is not populated, unless it's specified in expandDetector" |
| 210 | + }, |
| 211 | + "parameters": { |
| 212 | + "oneOf": [ |
| 213 | + { |
| 214 | + "type": "object", |
| 215 | + "additionalProperties": { |
| 216 | + "type": "object", |
| 217 | + "properties": {} |
| 218 | + }, |
| 219 | + "properties": {} |
| 220 | + }, |
| 221 | + { |
| 222 | + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" |
| 223 | + } |
| 224 | + ], |
| 225 | + "description": "The detector's parameters.'" |
| 226 | + }, |
| 227 | + "supportedResourceTypes": { |
| 228 | + "oneOf": [ |
| 229 | + { |
| 230 | + "type": "array", |
| 231 | + "items": { |
| 232 | + "type": "string" |
| 233 | + } |
| 234 | + }, |
| 235 | + { |
| 236 | + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" |
| 237 | + } |
| 238 | + ], |
| 239 | + "description": "The Smart Detector supported resource types. By default this is not populated, unless it's specified in expandDetector" |
| 240 | + } |
| 241 | + }, |
| 242 | + "required": [ |
| 243 | + "id" |
| 244 | + ], |
| 245 | + "description": "The detector information. By default this is not populated, unless it's specified in expandDetector" |
| 246 | + }, |
| 247 | + "ThrottlingInformation": { |
| 248 | + "type": "object", |
| 249 | + "properties": { |
| 250 | + "duration": { |
| 251 | + "type": "string", |
| 252 | + "format": "duration", |
| 253 | + "description": "The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes" |
| 254 | + } |
| 255 | + }, |
| 256 | + "description": "Optional throttling information for the alert rule." |
| 257 | + } |
| 258 | + } |
| 259 | +} |
0 commit comments