microsoft.alertsManagement smartDetectorAlertRules 2019-03-01

  • Article

Bicep resource definition

The smartDetectorAlertRules resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Remarks

For guidance on deploying monitoring solutions, see Create monitoring resources by using Bicep.

Resource format

To create a microsoft.alertsManagement/smartDetectorAlertRules resource, add the following Bicep to your template.

resource symbolicname 'microsoft.alertsManagement/smartDetectorAlertRules@2019-03-01' = {
  name: 'string'
  properties: {
    actionGroups: {
      customEmailSubject: 'string'
      customWebhookPayload: 'string'
      groupIds: [
        'string'
      ]
    }
    description: 'string'
    detector: {
      description: 'string'
      id: 'string'
      imagePaths: [
        'string'
      ]
      name: 'string'
      parameters: {}
      supportedResourceTypes: [
        'string'
      ]
    }
    frequency: 'string'
    scope: [
      'string'
    ]
    severity: 'string'
    state: 'string'
    throttling: {
      duration: 'string'
    }
  }
}

Property values

smartDetectorAlertRules

Name Description Value
name The resource name string (required)
properties The properties of the alert rule. AlertRuleProperties

AlertRuleProperties

Name Description Value
actionGroups The alert rule actions. ActionGroupsInformation (required)
description The alert rule description. string
detector The alert rule's detector. Detector (required)
frequency The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 5 minutes. string (required)
scope The alert rule resources scope. string[] (required)
severity The alert rule severity. 'Sev0'
'Sev1'
'Sev2'
'Sev3'
'Sev4' (required)
state The alert rule state. 'Disabled'
'Enabled' (required)
throttling The alert rule throttling information. ThrottlingInformation

ActionGroupsInformation

Name Description Value
customEmailSubject An optional custom email subject to use in email notifications. string
customWebhookPayload An optional custom web-hook payload to use in web-hook notifications. string
groupIds The Action Group resource IDs. string[] (required)

Detector

Name Description Value
description The Smart Detector description. By default this is not populated, unless it's specified in expandDetector string
id The detector id. string (required)
imagePaths The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector string[]
name The Smart Detector name. By default this is not populated, unless it's specified in expandDetector string
parameters The detector's parameters.' object
supportedResourceTypes The Smart Detector supported resource types. By default this is not populated, unless it's specified in expandDetector string[]

ThrottlingInformation

Name Description Value
duration 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 string

ARM template resource definition

The smartDetectorAlertRules resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Remarks

For guidance on deploying monitoring solutions, see Create monitoring resources by using Bicep.

Resource format

To create a microsoft.alertsManagement/smartDetectorAlertRules resource, add the following JSON to your template.

{
  "type": "microsoft.alertsManagement/smartDetectorAlertRules",
  "apiVersion": "2019-03-01",
  "name": "string",
  "properties": {
    "actionGroups": {
      "customEmailSubject": "string",
      "customWebhookPayload": "string",
      "groupIds": [ "string" ]
    },
    "description": "string",
    "detector": {
      "description": "string",
      "id": "string",
      "imagePaths": [ "string" ],
      "name": "string",
      "parameters": {},
      "supportedResourceTypes": [ "string" ]
    },
    "frequency": "string",
    "scope": [ "string" ],
    "severity": "string",
    "state": "string",
    "throttling": {
      "duration": "string"
    }
  }
}

Property values

smartDetectorAlertRules

Name Description Value
type The resource type 'microsoft.alertsManagement/smartDetectorAlertRules'
apiVersion The resource api version '2019-03-01'
name The resource name string (required)
properties The properties of the alert rule. AlertRuleProperties

AlertRuleProperties

Name Description Value
actionGroups The alert rule actions. ActionGroupsInformation (required)
description The alert rule description. string
detector The alert rule's detector. Detector (required)
frequency The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 5 minutes. string (required)
scope The alert rule resources scope. string[] (required)
severity The alert rule severity. 'Sev0'
'Sev1'
'Sev2'
'Sev3'
'Sev4' (required)
state The alert rule state. 'Disabled'
'Enabled' (required)
throttling The alert rule throttling information. ThrottlingInformation

ActionGroupsInformation

Name Description Value
customEmailSubject An optional custom email subject to use in email notifications. string
customWebhookPayload An optional custom web-hook payload to use in web-hook notifications. string
groupIds The Action Group resource IDs. string[] (required)

Detector

Name Description Value
description The Smart Detector description. By default this is not populated, unless it's specified in expandDetector string
id The detector id. string (required)
imagePaths The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector string[]
name The Smart Detector name. By default this is not populated, unless it's specified in expandDetector string
parameters The detector's parameters.' object
supportedResourceTypes The Smart Detector supported resource types. By default this is not populated, unless it's specified in expandDetector string[]

ThrottlingInformation

Name Description Value
duration 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 string

Terraform (AzAPI provider) resource definition

The smartDetectorAlertRules resource type can be deployed to:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a microsoft.alertsManagement/smartDetectorAlertRules resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "microsoft.alertsManagement/smartDetectorAlertRules@2019-03-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      actionGroups = {
        customEmailSubject = "string"
        customWebhookPayload = "string"
        groupIds = [
          "string"
        ]
      }
      description = "string"
      detector = {
        description = "string"
        id = "string"
        imagePaths = [
          "string"
        ]
        name = "string"
        parameters = {}
        supportedResourceTypes = [
          "string"
        ]
      }
      frequency = "string"
      scope = [
        "string"
      ]
      severity = "string"
      state = "string"
      throttling = {
        duration = "string"
      }
    }
  })
}

Property values

smartDetectorAlertRules

Name Description Value
type The resource type "microsoft.alertsManagement/smartDetectorAlertRules@2019-03-01"
name The resource name string (required)
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
properties The properties of the alert rule. AlertRuleProperties

AlertRuleProperties

Name Description Value
actionGroups The alert rule actions. ActionGroupsInformation (required)
description The alert rule description. string
detector The alert rule's detector. Detector (required)
frequency The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 5 minutes. string (required)
scope The alert rule resources scope. string[] (required)
severity The alert rule severity. "Sev0"
"Sev1"
"Sev2"
"Sev3"
"Sev4" (required)
state The alert rule state. "Disabled"
"Enabled" (required)
throttling The alert rule throttling information. ThrottlingInformation

ActionGroupsInformation

Name Description Value
customEmailSubject An optional custom email subject to use in email notifications. string
customWebhookPayload An optional custom web-hook payload to use in web-hook notifications. string
groupIds The Action Group resource IDs. string[] (required)

Detector

Name Description Value
description The Smart Detector description. By default this is not populated, unless it's specified in expandDetector string
id The detector id. string (required)
imagePaths The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector string[]
name The Smart Detector name. By default this is not populated, unless it's specified in expandDetector string
parameters The detector's parameters.' object
supportedResourceTypes The Smart Detector supported resource types. By default this is not populated, unless it's specified in expandDetector string[]

ThrottlingInformation

Name Description Value
duration 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 string