microsoft.alertsManagement smartDetectorAlertRules

Poznámky

Pokyny k nasazení řešení monitorování najdete v tématu Vytvoření monitorovacích prostředků pomocí nástroje Bicep.

Definice prostředku Bicep

Typ prostředku smartDetectorAlertRules lze nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Příklady použití

Ukázky Bicep

Základní příklad nasazení pravidla upozornění na inteligentní detektor monitoru.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource actionGroup 'Microsoft.Insights/actionGroups@2023-01-01' = {
  name: resourceName
  location: 'global'
  properties: {
    armRoleReceivers: []
    automationRunbookReceivers: []
    azureAppPushReceivers: []
    azureFunctionReceivers: []
    emailReceivers: []
    enabled: true
    eventHubReceivers: []
    groupShortName: 'acctestag'
    itsmReceivers: []
    logicAppReceivers: []
    smsReceivers: []
    voiceReceivers: []
    webhookReceivers: []
  }
}

resource component 'Microsoft.Insights/components@2020-02-02' = {
  name: resourceName
  location: location
  kind: 'web'
  properties: {
    Application_Type: 'web'
    DisableIpMasking: false
    DisableLocalAuth: false
    ForceCustomerStorageForProfiler: false
    RetentionInDays: 90
    SamplingPercentage: 100
    publicNetworkAccessForIngestion: 'Enabled'
    publicNetworkAccessForQuery: 'Enabled'
  }
}

resource smartDetectorAlertRule 'microsoft.alertsManagement/smartDetectorAlertRules@2019-06-01' = {
  name: resourceName
  location: 'global'
  properties: {
    actionGroups: {
      customEmailSubject: ''
      customWebhookPayload: ''
      groupIds: [
        actionGroup.id
      ]
    }
    description: ''
    detector: {
      id: 'FailureAnomaliesDetector'
    }
    frequency: 'PT1M'
    scope: [
      component.id
    ]
    severity: 'Sev0'
    state: 'Enabled'
  }
}

Formát prostředku

Pokud chcete vytvořit prostředek microsoft.alertsManagement/smartDetectorAlertRules, přidejte do šablony následující bicep.

resource symbolicname 'microsoft.alertsManagement/smartDetectorAlertRules@2021-04-01' = {
  location: 'string'
  name: 'string'
  properties: {
    actionGroups: {
      customEmailSubject: 'string'
      customWebhookPayload: 'string'
      groupIds: [
        'string'
      ]
    }
    description: 'string'
    detector: {
      id: 'string'
      parameters: {
        {customized property}: any(...)
      }
    }
    frequency: 'string'
    scope: [
      'string'
    ]
    severity: 'string'
    state: 'string'
    throttling: {
      duration: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Hodnoty vlastností

microsoft.alertsManagement/smartDetectorAlertRules

Jméno Popis Hodnota
poloha Umístění prostředku. řetězec
Jméno Název prostředku string (povinné)
vlastnosti Vlastnosti pravidla upozornění UpozorněníRuleProperties
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách

Informace o akčních skupinách

Jméno Popis Hodnota
customEmailSubject Volitelný vlastní e-mailový předmět, který se má použít v e-mailových oznámeních. řetězec
customWebhookPayload Volitelná vlastní datová část webhooku pro použití v oznámeních web-hook. řetězec
identifikátory skupin ID prostředků skupiny akcí string[] (povinné)

UpozorněníRuleProperties

Jméno Popis Hodnota
actionGroups Akce pravidla upozornění. ActionGroupsInformation (povinné)
popis Popis pravidla upozornění. řetězec
detektor Detektor pravidla upozornění. detektoru (povinné)
frekvence Frekvence pravidla upozornění ve formátu ISO8601. Časové intervaly musí být v minutách a minimální hodnota je 1 minuta v závislosti na detektoru. string (povinné)
obor Rozsah prostředků pravidla upozornění. string[] (povinné)
závažnost Závažnost pravidla upozornění. 'Sev0'
'Sev1'
'Sev2'
'Sev3'
Sev4 (povinné)
stav Stav pravidla upozornění. Zakázáno
Povoleno (povinné)
omezování Informace o omezení pravidla upozornění omezování informací

Značky AzureResourceTags

Jméno Popis Hodnota

Detektor

Jméno Popis Hodnota
identifikační číslo ID detektoru. string (povinné)
parametry Parametry detektoru." Parametry detektoru

Parametry detektoru

Jméno Popis Hodnota

Informace o omezování

Jméno Popis Hodnota
trvání Požadovaná doba trvání (ve formátu ISO8601) k čekání před opětovnou výstrahou na pravidlo upozornění. Časové intervaly musí být v minutách a minimální hodnota je 0 minut. řetězec

Definice prostředku šablony ARM

Typ prostředku smartDetectorAlertRules lze nasadit s operacemi, které cílí:

Příklady použití

Formát prostředku

Pokud chcete vytvořit prostředek microsoft.alertsManagement/smartDetectorAlertRules, přidejte do šablony následující KÓD JSON.

{
  "type": "microsoft.alertsManagement/smartDetectorAlertRules",
  "apiVersion": "2021-04-01",
  "name": "string",
  "location": "string",
  "properties": {
    "actionGroups": {
      "customEmailSubject": "string",
      "customWebhookPayload": "string",
      "groupIds": [ "string" ]
    },
    "description": "string",
    "detector": {
      "id": "string",
      "parameters": {
        "{customized property}": {}
      }
    },
    "frequency": "string",
    "scope": [ "string" ],
    "severity": "string",
    "state": "string",
    "throttling": {
      "duration": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Hodnoty vlastností

microsoft.alertsManagement/smartDetectorAlertRules

Jméno Popis Hodnota
Verze rozhraní apiVersion Verze rozhraní API '2021-04-01'
poloha Umístění prostředku. řetězec
Jméno Název prostředku string (povinné)
vlastnosti Vlastnosti pravidla upozornění UpozorněníRuleProperties
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách
typ Typ prostředku Microsoft.alertsManagement/smartDetectorAlertRules

Informace o akčních skupinách

Jméno Popis Hodnota
customEmailSubject Volitelný vlastní e-mailový předmět, který se má použít v e-mailových oznámeních. řetězec
customWebhookPayload Volitelná vlastní datová část webhooku pro použití v oznámeních web-hook. řetězec
identifikátory skupin ID prostředků skupiny akcí string[] (povinné)

UpozorněníRuleProperties

Jméno Popis Hodnota
actionGroups Akce pravidla upozornění. ActionGroupsInformation (povinné)
popis Popis pravidla upozornění. řetězec
detektor Detektor pravidla upozornění. detektoru (povinné)
frekvence Frekvence pravidla upozornění ve formátu ISO8601. Časové intervaly musí být v minutách a minimální hodnota je 1 minuta v závislosti na detektoru. string (povinné)
obor Rozsah prostředků pravidla upozornění. string[] (povinné)
závažnost Závažnost pravidla upozornění. 'Sev0'
'Sev1'
'Sev2'
'Sev3'
Sev4 (povinné)
stav Stav pravidla upozornění. Zakázáno
Povoleno (povinné)
omezování Informace o omezení pravidla upozornění omezování informací

Značky AzureResourceTags

Jméno Popis Hodnota

Detektor

Jméno Popis Hodnota
identifikační číslo ID detektoru. string (povinné)
parametry Parametry detektoru." Parametry detektoru

Parametry detektoru

Jméno Popis Hodnota

Informace o omezování

Jméno Popis Hodnota
trvání Požadovaná doba trvání (ve formátu ISO8601) k čekání před opětovnou výstrahou na pravidlo upozornění. Časové intervaly musí být v minutách a minimální hodnota je 0 minut. řetězec

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku smartDetectorAlertRules lze nasadit s operacemi, které cílí:

  • Skupiny zdrojů Pro seznam změněných vlastností v každé verzi API viz log změn.

Příklady použití

Ukázky Terraformu

Základní příklad nasazení pravidla upozornění na inteligentní detektor monitoru.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "actionGroup" {
  type      = "Microsoft.Insights/actionGroups@2023-01-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = "global"
  body = {
    properties = {
      armRoleReceivers = [
      ]
      automationRunbookReceivers = [
      ]
      azureAppPushReceivers = [
      ]
      azureFunctionReceivers = [
      ]
      emailReceivers = [
      ]
      enabled = true
      eventHubReceivers = [
      ]
      groupShortName = "acctestag"
      itsmReceivers = [
      ]
      logicAppReceivers = [
      ]
      smsReceivers = [
      ]
      voiceReceivers = [
      ]
      webhookReceivers = [
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "component" {
  type      = "Microsoft.Insights/components@2020-02-02"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "web"
    properties = {
      Application_Type                = "web"
      DisableIpMasking                = false
      DisableLocalAuth                = false
      ForceCustomerStorageForProfiler = false
      RetentionInDays                 = 90
      SamplingPercentage              = 100
      publicNetworkAccessForIngestion = "Enabled"
      publicNetworkAccessForQuery     = "Enabled"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "smartDetectorAlertRule" {
  type      = "microsoft.alertsManagement/smartDetectorAlertRules@2019-06-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = "global"
  body = {
    properties = {
      actionGroups = {
        customEmailSubject   = ""
        customWebhookPayload = ""
        groupIds = [
          azapi_resource.actionGroup.id,
        ]
      }
      description = ""
      detector = {
        id = "FailureAnomaliesDetector"
      }
      frequency = "PT1M"
      scope = [
        azapi_resource.component.id,
      ]
      severity = "Sev0"
      state    = "Enabled"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Formát prostředku

Pokud chcete vytvořit prostředek microsoft.alertsManagement/smartDetectorAlertRules, přidejte do šablony následující Terraform.

resource "azapi_resource" "symbolicname" {
  type = "microsoft.alertsManagement/smartDetectorAlertRules@2021-04-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      actionGroups = {
        customEmailSubject = "string"
        customWebhookPayload = "string"
        groupIds = [
          "string"
        ]
      }
      description = "string"
      detector = {
        id = "string"
        parameters = {
          {customized property} = ?
        }
      }
      frequency = "string"
      scope = [
        "string"
      ]
      severity = "string"
      state = "string"
      throttling = {
        duration = "string"
      }
    }
  }
}

Hodnoty vlastností

microsoft.alertsManagement/smartDetectorAlertRules

Jméno Popis Hodnota
poloha Umístění prostředku. řetězec
Jméno Název prostředku string (povinné)
vlastnosti Vlastnosti pravidla upozornění UpozorněníRuleProperties
visačky Značky prostředků Slovník názvů a hodnot značek
typ Typ prostředku Microsoft.alertsManagement/smartDetectorAlertRules@2021-04-01

Informace o akčních skupinách

Jméno Popis Hodnota
customEmailSubject Volitelný vlastní e-mailový předmět, který se má použít v e-mailových oznámeních. řetězec
customWebhookPayload Volitelná vlastní datová část webhooku pro použití v oznámeních web-hook. řetězec
identifikátory skupin ID prostředků skupiny akcí string[] (povinné)

UpozorněníRuleProperties

Jméno Popis Hodnota
actionGroups Akce pravidla upozornění. ActionGroupsInformation (povinné)
popis Popis pravidla upozornění. řetězec
detektor Detektor pravidla upozornění. detektoru (povinné)
frekvence Frekvence pravidla upozornění ve formátu ISO8601. Časové intervaly musí být v minutách a minimální hodnota je 1 minuta v závislosti na detektoru. string (povinné)
obor Rozsah prostředků pravidla upozornění. string[] (povinné)
závažnost Závažnost pravidla upozornění. 'Sev0'
'Sev1'
'Sev2'
'Sev3'
Sev4 (povinné)
stav Stav pravidla upozornění. Zakázáno
Povoleno (povinné)
omezování Informace o omezení pravidla upozornění omezování informací

Značky AzureResourceTags

Jméno Popis Hodnota

Detektor

Jméno Popis Hodnota
identifikační číslo ID detektoru. string (povinné)
parametry Parametry detektoru." Parametry detektoru

Parametry detektoru

Jméno Popis Hodnota

Informace o omezování

Jméno Popis Hodnota
trvání Požadovaná doba trvání (ve formátu ISO8601) k čekání před opětovnou výstrahou na pravidlo upozornění. Časové intervaly musí být v minutách a minimální hodnota je 0 minut. řetězec