Поделиться через


Microsoft.Insights scheduledQueryRules 2018-04-16

Замечания

Рекомендации по развертыванию решений мониторинга см. в статье Создание ресурсов мониторинга с помощью Bicep.

Определение ресурсов Bicep

Тип ресурса scheduledQueryRules можно развернуть с помощью операций, целевых:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.Insights/scheduledQueryRules, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.Insights/scheduledQueryRules@2018-04-16' = {
  location: 'string'
  name: 'string'
  properties: {
    action: {
      odata.type: 'string'
      // For remaining properties, see Action objects
    }
    autoMitigate: bool
    description: 'string'
    displayName: 'string'
    enabled: 'string'
    schedule: {
      frequencyInMinutes: int
      timeWindowInMinutes: int
    }
    source: {
      authorizedResources: [
        'string'
      ]
      dataSourceId: 'string'
      query: 'string'
      queryType: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Объекты действия

Задайте свойство odata.type, чтобы указать тип объекта.

Для Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction, используйте:

{
  aznsAction: {
    actionGroup: [
      'string'
    ]
    customWebhookPayload: 'string'
    emailSubject: 'string'
  }
  odata.type: 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction'
  severity: 'string'
  throttlingInMin: int
  trigger: {
    metricTrigger: {
      metricColumn: 'string'
      metricTriggerType: 'string'
      threshold: int
      thresholdOperator: 'string'
    }
    threshold: int
    thresholdOperator: 'string'
  }
}

Для Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction, используйте:

{
  criteria: [
    {
      dimensions: [
        {
          name: 'string'
          operator: 'string'
          values: [
            'string'
          ]
        }
      ]
      metricName: 'string'
    }
  ]
  odata.type: 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction'
}

Значения свойств

Действие

Имя Описание Ценность
odata.type Задайте для параметра "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction" для типа AlertingAction. Установите значение "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction" для типа LogToMetricAction. 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction'
"Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction" (обязательно)

AlertingAction

Имя Описание Ценность
Справочник по группе действий Azure. AzNsActionGroup
odata.type Указывает действие. Поддерживаемые значения: AlertingAction, LogToMetricAction "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction" (обязательно)
суровость Серьезность оповещения '0'
'1'
'2'
'3'
'4' (обязательно)
регулированиеInMin время (в минутах), для которого должны регулироваться оповещения или подавляться. int
триггер Условие триггера, которое приводит к возникновению правила генерации оповещений. TriggerCondition (обязательно)

AzNsActionGroup

Имя Описание Ценность
actionGroup Справочник по группе действий Azure. string[]
customWebhookPayload Пользовательские полезные данные для отправки всех универсальных кодов ресурса (URI) веб-перехватчика в группе действий Azure струна
emailSubject Переопределение настраиваемого субъекта для всех идентификаторов электронной почты в группе действий Azure струна

Критерии

Имя Описание Ценность
Размеры Список измерений для создания метрик измерение[]
metricName Имя метрики строка (обязательно)

Измерение

Имя Описание Ценность
имя Имя измерения строка (обязательно)
оператор Оператор для значений измерения "Include" (обязательно)
Значения Список значений измерения string[] (обязательно)

LogMetricTrigger

Имя Описание Ценность
metricColumn Оценка метрик для определенного столбца струна
metricTriggerType Тип триггера метрик : "Последовательный" или "Итог" "Последовательный"
"Итог"
порог Пороговое значение триггера метрик. int
thresholdOperator Операция оценки для метрики -'GreaterThan' или "LessThan" или "Equal". "Равно"
'GreaterThan'
'GreaterThanOrEqual'
"LessThan"
"LessThanOrEqual"

LogSearchRule

Имя Описание Ценность
действие Необходимо принять меры по выполнению правила. действие (обязательно)
autoMitigate Флаг, указывающий, следует ли автоматически разрешать оповещение. Значение по умолчанию — false. bool
описание Описание правила поиска по журналам. струна
displayName Отображаемое имя правила генерации оповещений струна
Включен Флаг, указывающий, включено ли правило поиска по журналам. Значение должно иметь значение true или false "false"
"true"
расписание Расписание (частота, временное окно) для правила. Требуется для типа действия — AlertingAction Расписание
источник Источник данных, в отношении которого правило будет запрашивать данные источник (обязательно)

LogToMetricAction

Имя Описание Ценность
критерии Критерии метрики критерии[] (обязательно)
odata.type Указывает действие. Поддерживаемые значения: AlertingAction, LogToMetricAction "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction" (обязательно)

Microsoft.Insights/scheduledQueryRules

Имя Описание Ценность
местоположение Расположение ресурса строка (обязательно)
имя Имя ресурса строка (обязательно)
свойства Свойства правила ресурса. LogSearchRule (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

ResourceTags

Имя Описание Ценность

Расписание

Имя Описание Ценность
frequencyInMinutes частота (в минутах), с которой должно оцениваться условие правила. int (обязательно)
timeWindowInMinutes Период времени, для которого данные должны быть возвращены для запроса (должно быть больше или равно частотеInMinutes). int (обязательно)

Источник

Имя Описание Ценность
авторизованныеresources Список ресурсов, на который ссылается запрос string[]
dataSourceId URI ресурса, по которому выполняется запрос поиска по журналам. строка (обязательно)
запрос Запрос поиска по журналам. Требуется для типа действия — AlertingAction струна
queryType Задайте для параметра ResultCount значение . "ResultCount"

TriggerCondition

Имя Описание Ценность
metricTrigger Условие триггера для правила запроса метрик LogMetricTrigger
порог Пороговое значение результата или подсчета в зависимости от того, какое правило следует активировать. int (обязательно)
thresholdOperator Операция оценки для правила — "GreaterThan" или "LessThan". "Равно"
'GreaterThan'
'GreaterThanOrEqual'
"LessThan"
LessThanOrEqual (обязательный)

Определение ресурса шаблона ARM

Тип ресурса scheduledQueryRules можно развернуть с помощью операций, целевых:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.Insights/scheduledQueryRules, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.Insights/scheduledQueryRules",
  "apiVersion": "2018-04-16",
  "name": "string",
  "location": "string",
  "properties": {
    "action": {
      "odata.type": "string"
      // For remaining properties, see Action objects
    },
    "autoMitigate": "bool",
    "description": "string",
    "displayName": "string",
    "enabled": "string",
    "schedule": {
      "frequencyInMinutes": "int",
      "timeWindowInMinutes": "int"
    },
    "source": {
      "authorizedResources": [ "string" ],
      "dataSourceId": "string",
      "query": "string",
      "queryType": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Объекты действия

Задайте свойство odata.type, чтобы указать тип объекта.

Для Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction, используйте:

{
  "aznsAction": {
    "actionGroup": [ "string" ],
    "customWebhookPayload": "string",
    "emailSubject": "string"
  },
  "odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction",
  "severity": "string",
  "throttlingInMin": "int",
  "trigger": {
    "metricTrigger": {
      "metricColumn": "string",
      "metricTriggerType": "string",
      "threshold": "int",
      "thresholdOperator": "string"
    },
    "threshold": "int",
    "thresholdOperator": "string"
  }
}

Для Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction, используйте:

{
  "criteria": [
    {
      "dimensions": [
        {
          "name": "string",
          "operator": "string",
          "values": [ "string" ]
        }
      ],
      "metricName": "string"
    }
  ],
  "odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction"
}

Значения свойств

Действие

Имя Описание Ценность
odata.type Задайте для параметра "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction" для типа AlertingAction. Установите значение "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction" для типа LogToMetricAction. 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction'
"Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction" (обязательно)

AlertingAction

Имя Описание Ценность
Справочник по группе действий Azure. AzNsActionGroup
odata.type Указывает действие. Поддерживаемые значения: AlertingAction, LogToMetricAction "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction" (обязательно)
суровость Серьезность оповещения '0'
'1'
'2'
'3'
'4' (обязательно)
регулированиеInMin время (в минутах), для которого должны регулироваться оповещения или подавляться. int
триггер Условие триггера, которое приводит к возникновению правила генерации оповещений. TriggerCondition (обязательно)

AzNsActionGroup

Имя Описание Ценность
actionGroup Справочник по группе действий Azure. string[]
customWebhookPayload Пользовательские полезные данные для отправки всех универсальных кодов ресурса (URI) веб-перехватчика в группе действий Azure струна
emailSubject Переопределение настраиваемого субъекта для всех идентификаторов электронной почты в группе действий Azure струна

Критерии

Имя Описание Ценность
Размеры Список измерений для создания метрик измерение[]
metricName Имя метрики строка (обязательно)

Измерение

Имя Описание Ценность
имя Имя измерения строка (обязательно)
оператор Оператор для значений измерения "Include" (обязательно)
Значения Список значений измерения string[] (обязательно)

LogMetricTrigger

Имя Описание Ценность
metricColumn Оценка метрик для определенного столбца струна
metricTriggerType Тип триггера метрик : "Последовательный" или "Итог" "Последовательный"
"Итог"
порог Пороговое значение триггера метрик. int
thresholdOperator Операция оценки для метрики -'GreaterThan' или "LessThan" или "Equal". "Равно"
'GreaterThan'
'GreaterThanOrEqual'
"LessThan"
"LessThanOrEqual"

LogSearchRule

Имя Описание Ценность
действие Необходимо принять меры по выполнению правила. действие (обязательно)
autoMitigate Флаг, указывающий, следует ли автоматически разрешать оповещение. Значение по умолчанию — false. bool
описание Описание правила поиска по журналам. струна
displayName Отображаемое имя правила генерации оповещений струна
Включен Флаг, указывающий, включено ли правило поиска по журналам. Значение должно иметь значение true или false "false"
"true"
расписание Расписание (частота, временное окно) для правила. Требуется для типа действия — AlertingAction Расписание
источник Источник данных, в отношении которого правило будет запрашивать данные источник (обязательно)

LogToMetricAction

Имя Описание Ценность
критерии Критерии метрики критерии[] (обязательно)
odata.type Указывает действие. Поддерживаемые значения: AlertingAction, LogToMetricAction "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction" (обязательно)

Microsoft.Insights/scheduledQueryRules

Имя Описание Ценность
apiVersion Версия API '2018-04-16'
местоположение Расположение ресурса строка (обязательно)
имя Имя ресурса строка (обязательно)
свойства Свойства правила ресурса. LogSearchRule (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
тип Тип ресурса "Microsoft.Insights/scheduledQueryRules"

ResourceTags

Имя Описание Ценность

Расписание

Имя Описание Ценность
frequencyInMinutes частота (в минутах), с которой должно оцениваться условие правила. int (обязательно)
timeWindowInMinutes Период времени, для которого данные должны быть возвращены для запроса (должно быть больше или равно частотеInMinutes). int (обязательно)

Источник

Имя Описание Ценность
авторизованныеresources Список ресурсов, на который ссылается запрос string[]
dataSourceId URI ресурса, по которому выполняется запрос поиска по журналам. строка (обязательно)
запрос Запрос поиска по журналам. Требуется для типа действия — AlertingAction струна
queryType Задайте для параметра ResultCount значение . "ResultCount"

TriggerCondition

Имя Описание Ценность
metricTrigger Условие триггера для правила запроса метрик LogMetricTrigger
порог Пороговое значение результата или подсчета в зависимости от того, какое правило следует активировать. int (обязательно)
thresholdOperator Операция оценки для правила — "GreaterThan" или "LessThan". "Равно"
'GreaterThan'
'GreaterThanOrEqual'
"LessThan"
LessThanOrEqual (обязательный)

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон Описание
Создание правила генерации оповещений для элементов непрерывности бизнес-процессов Azure

развертывание в Azure
Эти шаблоны создают правило генерации оповещений и назначенный пользователем MSI. Он также назначает доступ читателя MSI к подписке, чтобы правило генерации оповещений получите доступ к запросу необходимых защищенных элементов и последних сведений о точке восстановления.

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса scheduledQueryRules можно развернуть с помощью операций, целевых:

  • групп ресурсов

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.Insights/scheduledQueryRules, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/scheduledQueryRules@2018-04-16"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      action = {
        odata.type = "string"
        // For remaining properties, see Action objects
      }
      autoMitigate = bool
      description = "string"
      displayName = "string"
      enabled = "string"
      schedule = {
        frequencyInMinutes = int
        timeWindowInMinutes = int
      }
      source = {
        authorizedResources = [
          "string"
        ]
        dataSourceId = "string"
        query = "string"
        queryType = "string"
      }
    }
  })
}

Объекты действия

Задайте свойство odata.type, чтобы указать тип объекта.

Для Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction, используйте:

{
  aznsAction = {
    actionGroup = [
      "string"
    ]
    customWebhookPayload = "string"
    emailSubject = "string"
  }
  odata.type = "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction"
  severity = "string"
  throttlingInMin = int
  trigger = {
    metricTrigger = {
      metricColumn = "string"
      metricTriggerType = "string"
      threshold = int
      thresholdOperator = "string"
    }
    threshold = int
    thresholdOperator = "string"
  }
}

Для Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction, используйте:

{
  criteria = [
    {
      dimensions = [
        {
          name = "string"
          operator = "string"
          values = [
            "string"
          ]
        }
      ]
      metricName = "string"
    }
  ]
  odata.type = "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction"
}

Значения свойств

Действие

Имя Описание Ценность
odata.type Задайте для параметра "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction" для типа AlertingAction. Установите значение "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction" для типа LogToMetricAction. 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction'
"Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction" (обязательно)

AlertingAction

Имя Описание Ценность
Справочник по группе действий Azure. AzNsActionGroup
odata.type Указывает действие. Поддерживаемые значения: AlertingAction, LogToMetricAction "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction" (обязательно)
суровость Серьезность оповещения '0'
'1'
'2'
'3'
'4' (обязательно)
регулированиеInMin время (в минутах), для которого должны регулироваться оповещения или подавляться. int
триггер Условие триггера, которое приводит к возникновению правила генерации оповещений. TriggerCondition (обязательно)

AzNsActionGroup

Имя Описание Ценность
actionGroup Справочник по группе действий Azure. string[]
customWebhookPayload Пользовательские полезные данные для отправки всех универсальных кодов ресурса (URI) веб-перехватчика в группе действий Azure струна
emailSubject Переопределение настраиваемого субъекта для всех идентификаторов электронной почты в группе действий Azure струна

Критерии

Имя Описание Ценность
Размеры Список измерений для создания метрик измерение[]
metricName Имя метрики строка (обязательно)

Измерение

Имя Описание Ценность
имя Имя измерения строка (обязательно)
оператор Оператор для значений измерения "Include" (обязательно)
Значения Список значений измерения string[] (обязательно)

LogMetricTrigger

Имя Описание Ценность
metricColumn Оценка метрик для определенного столбца струна
metricTriggerType Тип триггера метрик : "Последовательный" или "Итог" "Последовательный"
"Итог"
порог Пороговое значение триггера метрик. int
thresholdOperator Операция оценки для метрики -'GreaterThan' или "LessThan" или "Equal". "Равно"
'GreaterThan'
'GreaterThanOrEqual'
"LessThan"
"LessThanOrEqual"

LogSearchRule

Имя Описание Ценность
действие Необходимо принять меры по выполнению правила. действие (обязательно)
autoMitigate Флаг, указывающий, следует ли автоматически разрешать оповещение. Значение по умолчанию — false. bool
описание Описание правила поиска по журналам. струна
displayName Отображаемое имя правила генерации оповещений струна
Включен Флаг, указывающий, включено ли правило поиска по журналам. Значение должно иметь значение true или false "false"
"true"
расписание Расписание (частота, временное окно) для правила. Требуется для типа действия — AlertingAction Расписание
источник Источник данных, в отношении которого правило будет запрашивать данные источник (обязательно)

LogToMetricAction

Имя Описание Ценность
критерии Критерии метрики критерии[] (обязательно)
odata.type Указывает действие. Поддерживаемые значения: AlertingAction, LogToMetricAction "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction" (обязательно)

Microsoft.Insights/scheduledQueryRules

Имя Описание Ценность
местоположение Расположение ресурса строка (обязательно)
имя Имя ресурса строка (обязательно)
свойства Свойства правила ресурса. LogSearchRule (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов.
тип Тип ресурса "Microsoft.Insights/scheduledQueryRules@2018-04-16"

ResourceTags

Имя Описание Ценность

Расписание

Имя Описание Ценность
frequencyInMinutes частота (в минутах), с которой должно оцениваться условие правила. int (обязательно)
timeWindowInMinutes Период времени, для которого данные должны быть возвращены для запроса (должно быть больше или равно частотеInMinutes). int (обязательно)

Источник

Имя Описание Ценность
авторизованныеresources Список ресурсов, на который ссылается запрос string[]
dataSourceId URI ресурса, по которому выполняется запрос поиска по журналам. строка (обязательно)
запрос Запрос поиска по журналам. Требуется для типа действия — AlertingAction струна
queryType Задайте для параметра ResultCount значение . "ResultCount"

TriggerCondition

Имя Описание Ценность
metricTrigger Условие триггера для правила запроса метрик LogMetricTrigger
порог Пороговое значение результата или подсчета в зависимости от того, какое правило следует активировать. int (обязательно)
thresholdOperator Операция оценки для правила — "GreaterThan" или "LessThan". "Равно"
'GreaterThan'
'GreaterThanOrEqual'
"LessThan"
LessThanOrEqual (обязательный)