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


Microsoft.Insights scheduledQueryRules 2020-05-01-preview

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

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

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

Замечания

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

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

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

resource symbolicname 'Microsoft.Insights/scheduledQueryRules@2020-05-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    actions: [
      {
        actionGroupId: 'string'
        webHookProperties: {
          {customized property}: 'string'
        }
      }
    ]
    criteria: {
      allOf: [
        {
          dimensions: [
            {
              name: 'string'
              operator: 'string'
              values: [
                'string'
              ]
            }
          ]
          failingPeriods: {
            minFailingPeriodsToAlert: int
            numberOfEvaluationPeriods: int
          }
          metricMeasureColumn: 'string'
          operator: 'string'
          query: 'string'
          resourceIdColumn: 'string'
          threshold: int
          timeAggregation: 'string'
        }
      ]
    }
    description: 'string'
    displayName: 'string'
    enabled: bool
    evaluationFrequency: 'string'
    muteActionsDuration: 'string'
    overrideQueryTimeRange: 'string'
    scopes: [
      'string'
    ]
    severity: int
    targetResourceTypes: [
      'string'
    ]
    windowSize: 'string'
  }
}

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

scheduledQueryRules

Имя Описание Ценность
имя Имя ресурса строка (обязательно)

Ограничение символов: 1–260

Допустимые символы:
Не удается использовать:
*<>%{}&:\\?/#| или управляющие символы

Не удается завершиться пробелом или периодом.
местоположение Географическое расположение, в котором находится ресурс строка (обязательно)
Теги Теги ресурсов. Словарь имен и значений тегов. См. теги в шаблонах
свойства Свойства правила ресурса. ScheduledQueryRuleProperties (обязательно)

ScheduledQueryRuleProperties

Имя Описание Ценность
Действия действие[]
критерии Критерии правила, определяющие условия запланированного правила запроса. ScheduledQueryRuleCriteria
описание Описание правила запланированного запроса. струна
displayName Отображаемое имя правила генерации оповещений струна
Включен Флаг, указывающий, включено ли это правило запланированного запроса. Значение должно иметь значение true или false bool
evaluationFrequency Как часто правило запланированного запроса оценивается в формате длительности ISO 8601. струна
muteActionsDuration Отключение действий в течение выбранного периода времени (в формате длительности ISO 8601) после запуска оповещения. струна
overrideQueryTimeRange Если задано, переопределяет диапазон времени запроса (по умолчанию — WindowSize*NumberOfEvaluationPeriods) струна
Области Список идентификаторов ресурса, к которым применяется это правило запланированного запроса. string[]
суровость Серьезность оповещения. Должно быть целым числом между [0–4]. Значение 0 является самым серьезным int
targetResourceTypes Список типов ресурсов целевого ресурса, на котором создается или обновляется оповещение. Например, если область — это группа ресурсов и targetResourceTypes — Microsoft.Compute/virtualMachines, то для каждой виртуальной машины в группе ресурсов будет запущено другое оповещение, соответствующее критериям генерации оповещений. string[]
windowSize Период времени (в формате длительности ISO 8601), в котором будет выполняться запрос генерации оповещений (размер ячейки). струна

Действие

Имя Описание Ценность
actionGroupId Идентификатор ресурса группы действий для вызова при срабатывании оповещения. струна
webHookProperties Свойства объекта веб-перехватчика. ActionWebHookProperties

ActionWebHookProperties

Имя Описание Ценность
{настраиваемое свойство} струна

ScheduledQueryRuleCriteria

Имя Описание Ценность
allOf Список условий для оценки по указанным областям условие []

Состояние

Имя Описание Ценность
Размеры Список условий измерений измерение[]
сбойPeriods Минимальное количество нарушений, необходимых в выбранном окне времени обратного просмотра, необходимое для создания оповещения. ConditionFailingPeriods
metricMeasureColumn Столбец, содержащий номер метрики. струна
оператор Оператор условий. "Равно"
'GreaterThan'
'GreaterThanOrEqual'
"LessThan"
LessThanOrEqual (обязательный)
запрос Оповещение запроса журнала струна
resourceIdColumn Столбец, содержащий идентификатор ресурса. Содержимое столбца должно иметь формат URI в виде идентификатора ресурса. струна
порог пороговое значение условия, которое активирует оповещение. int (обязательно)
timeAggregation Тип агрегирования "Среднее"
"Count"
"Максимум"
"Минимальный"
"Total" (обязательный)

Измерение

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

ConditionFailingPeriods

Имя Описание Ценность
minFailingPeriodsToAlert Количество нарушений для активации оповещения. Должно быть меньше или равно числуOfEvaluationPeriods. Значение по умолчанию — 1 int
numberOfEvaluationPeriods Количество агрегированных точек обратного просмотра. Окно времени обратного просмотра вычисляется на основе детализации агрегирования (windowSize) и выбранного числа агрегированных точек. Значение по умолчанию — 1 int

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

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

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

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

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

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

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

Замечания

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

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

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

{
  "type": "Microsoft.Insights/scheduledQueryRules",
  "apiVersion": "2020-05-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "actions": [
      {
        "actionGroupId": "string",
        "webHookProperties": {
          "{customized property}": "string"
        }
      }
    ],
    "criteria": {
      "allOf": [
        {
          "dimensions": [
            {
              "name": "string",
              "operator": "string",
              "values": [ "string" ]
            }
          ],
          "failingPeriods": {
            "minFailingPeriodsToAlert": "int",
            "numberOfEvaluationPeriods": "int"
          },
          "metricMeasureColumn": "string",
          "operator": "string",
          "query": "string",
          "resourceIdColumn": "string",
          "threshold": "int",
          "timeAggregation": "string"
        }
      ]
    },
    "description": "string",
    "displayName": "string",
    "enabled": "bool",
    "evaluationFrequency": "string",
    "muteActionsDuration": "string",
    "overrideQueryTimeRange": "string",
    "scopes": [ "string" ],
    "severity": "int",
    "targetResourceTypes": [ "string" ],
    "windowSize": "string"
  }
}

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

scheduledQueryRules

Имя Описание Ценность
тип Тип ресурса "Microsoft.Insights/scheduledQueryRules"
apiVersion Версия API ресурсов '2020-05-01-preview'
имя Имя ресурса строка (обязательно)

Ограничение символов: 1–260

Допустимые символы:
Не удается использовать:
*<>%{}&:\\?/#| или управляющие символы

Не удается завершиться пробелом или периодом.
местоположение Географическое расположение, в котором находится ресурс строка (обязательно)
Теги Теги ресурсов. Словарь имен и значений тегов. См. теги в шаблонах
свойства Свойства правила ресурса. ScheduledQueryRuleProperties (обязательно)

ScheduledQueryRuleProperties

Имя Описание Ценность
Действия действие[]
критерии Критерии правила, определяющие условия запланированного правила запроса. ScheduledQueryRuleCriteria
описание Описание правила запланированного запроса. струна
displayName Отображаемое имя правила генерации оповещений струна
Включен Флаг, указывающий, включено ли это правило запланированного запроса. Значение должно иметь значение true или false bool
evaluationFrequency Как часто правило запланированного запроса оценивается в формате длительности ISO 8601. струна
muteActionsDuration Отключение действий в течение выбранного периода времени (в формате длительности ISO 8601) после запуска оповещения. струна
overrideQueryTimeRange Если задано, переопределяет диапазон времени запроса (по умолчанию — WindowSize*NumberOfEvaluationPeriods) струна
Области Список идентификаторов ресурса, к которым применяется это правило запланированного запроса. string[]
суровость Серьезность оповещения. Должно быть целым числом между [0–4]. Значение 0 является самым серьезным int
targetResourceTypes Список типов ресурсов целевого ресурса, на котором создается или обновляется оповещение. Например, если область — это группа ресурсов и targetResourceTypes — Microsoft.Compute/virtualMachines, то для каждой виртуальной машины в группе ресурсов будет запущено другое оповещение, соответствующее критериям генерации оповещений. string[]
windowSize Период времени (в формате длительности ISO 8601), в котором будет выполняться запрос генерации оповещений (размер ячейки). струна

Действие

Имя Описание Ценность
actionGroupId Идентификатор ресурса группы действий для вызова при срабатывании оповещения. струна
webHookProperties Свойства объекта веб-перехватчика. ActionWebHookProperties

ActionWebHookProperties

Имя Описание Ценность
{настраиваемое свойство} струна

ScheduledQueryRuleCriteria

Имя Описание Ценность
allOf Список условий для оценки по указанным областям условие []

Состояние

Имя Описание Ценность
Размеры Список условий измерений измерение[]
сбойPeriods Минимальное количество нарушений, необходимых в выбранном окне времени обратного просмотра, необходимое для создания оповещения. ConditionFailingPeriods
metricMeasureColumn Столбец, содержащий номер метрики. струна
оператор Оператор условий. "Равно"
'GreaterThan'
'GreaterThanOrEqual'
"LessThan"
LessThanOrEqual (обязательный)
запрос Оповещение запроса журнала струна
resourceIdColumn Столбец, содержащий идентификатор ресурса. Содержимое столбца должно иметь формат URI в виде идентификатора ресурса. струна
порог пороговое значение условия, которое активирует оповещение. int (обязательно)
timeAggregation Тип агрегирования "Среднее"
"Count"
"Максимум"
"Минимальный"
"Total" (обязательный)

Измерение

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

ConditionFailingPeriods

Имя Описание Ценность
minFailingPeriodsToAlert Количество нарушений для активации оповещения. Должно быть меньше или равно числуOfEvaluationPeriods. Значение по умолчанию — 1 int
numberOfEvaluationPeriods Количество агрегированных точек обратного просмотра. Окно времени обратного просмотра вычисляется на основе детализации агрегирования (windowSize) и выбранного числа агрегированных точек. Значение по умолчанию — 1 int

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

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

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

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

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/scheduledQueryRules@2020-05-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      actions = [
        {
          actionGroupId = "string"
          webHookProperties = {
            {customized property} = "string"
          }
        }
      ]
      criteria = {
        allOf = [
          {
            dimensions = [
              {
                name = "string"
                operator = "string"
                values = [
                  "string"
                ]
              }
            ]
            failingPeriods = {
              minFailingPeriodsToAlert = int
              numberOfEvaluationPeriods = int
            }
            metricMeasureColumn = "string"
            operator = "string"
            query = "string"
            resourceIdColumn = "string"
            threshold = int
            timeAggregation = "string"
          }
        ]
      }
      description = "string"
      displayName = "string"
      enabled = bool
      evaluationFrequency = "string"
      muteActionsDuration = "string"
      overrideQueryTimeRange = "string"
      scopes = [
        "string"
      ]
      severity = int
      targetResourceTypes = [
        "string"
      ]
      windowSize = "string"
    }
  })
}

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

scheduledQueryRules

Имя Описание Ценность
тип Тип ресурса "Microsoft.Insights/scheduledQueryRules@2020-05-01-preview"
имя Имя ресурса строка (обязательно)

Ограничение символов: 1–260

Допустимые символы:
Не удается использовать:
*<>%{}&:\\?/#| или управляющие символы

Не удается завершиться пробелом или периодом.
местоположение Географическое расположение, в котором находится ресурс строка (обязательно)
parent_id Чтобы развернуть в группе ресурсов, используйте идентификатор этой группы ресурсов. строка (обязательно)
Теги Теги ресурсов. Словарь имен и значений тегов.
свойства Свойства правила ресурса. ScheduledQueryRuleProperties (обязательно)

ScheduledQueryRuleProperties

Имя Описание Ценность
Действия действие[]
критерии Критерии правила, определяющие условия запланированного правила запроса. ScheduledQueryRuleCriteria
описание Описание правила запланированного запроса. струна
displayName Отображаемое имя правила генерации оповещений струна
Включен Флаг, указывающий, включено ли это правило запланированного запроса. Значение должно иметь значение true или false bool
evaluationFrequency Как часто правило запланированного запроса оценивается в формате длительности ISO 8601. струна
muteActionsDuration Отключение действий в течение выбранного периода времени (в формате длительности ISO 8601) после запуска оповещения. струна
overrideQueryTimeRange Если задано, переопределяет диапазон времени запроса (по умолчанию — WindowSize*NumberOfEvaluationPeriods) струна
Области Список идентификаторов ресурса, к которым применяется это правило запланированного запроса. string[]
суровость Серьезность оповещения. Должно быть целым числом между [0–4]. Значение 0 является самым серьезным int
targetResourceTypes Список типов ресурсов целевого ресурса, на котором создается или обновляется оповещение. Например, если область — это группа ресурсов и targetResourceTypes — Microsoft.Compute/virtualMachines, то для каждой виртуальной машины в группе ресурсов будет запущено другое оповещение, соответствующее критериям генерации оповещений. string[]
windowSize Период времени (в формате длительности ISO 8601), в котором будет выполняться запрос генерации оповещений (размер ячейки). струна

Действие

Имя Описание Ценность
actionGroupId Идентификатор ресурса группы действий для вызова при срабатывании оповещения. струна
webHookProperties Свойства объекта веб-перехватчика. ActionWebHookProperties

ActionWebHookProperties

Имя Описание Ценность
{настраиваемое свойство} струна

ScheduledQueryRuleCriteria

Имя Описание Ценность
allOf Список условий для оценки по указанным областям условие []

Состояние

Имя Описание Ценность
Размеры Список условий измерений измерение[]
сбойPeriods Минимальное количество нарушений, необходимых в выбранном окне времени обратного просмотра, необходимое для создания оповещения. ConditionFailingPeriods
metricMeasureColumn Столбец, содержащий номер метрики. струна
оператор Оператор условий. "Равно"
"GreaterThan"
"GreaterThanOrEqual"
"LessThan"
"LessThanOrEqual" (обязательно)
запрос Оповещение запроса журнала струна
resourceIdColumn Столбец, содержащий идентификатор ресурса. Содержимое столбца должно иметь формат URI в виде идентификатора ресурса. струна
порог пороговое значение условия, которое активирует оповещение. int (обязательно)
timeAggregation Тип агрегирования "Среднее"
"Count"
"Максимум"
"Минимальный"
"Total" (обязательно)

Измерение

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

ConditionFailingPeriods

Имя Описание Ценность
minFailingPeriodsToAlert Количество нарушений для активации оповещения. Должно быть меньше или равно числуOfEvaluationPeriods. Значение по умолчанию — 1 int
numberOfEvaluationPeriods Количество агрегированных точек обратного просмотра. Окно времени обратного просмотра вычисляется на основе детализации агрегирования (windowSize) и выбранного числа агрегированных точек. Значение по умолчанию — 1 int