Microsoft.Insights scheduledQueryRules 2022-06-15

Статья
12/09/2024

Замечания

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

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

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

группы ресурсов . См. команды развертывания группы ресурсов

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

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

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

resource symbolicname 'Microsoft.Insights/scheduledQueryRules@2022-06-15' = {
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    actions: {
      actionGroups: [
        'string'
      ]
      customProperties: {
        {customized property}: 'string'
      }
    }
    autoMitigate: bool
    checkWorkspaceAlertsStorageConfigured: bool
    criteria: {
      allOf: [
        {
          dimensions: [
            {
              name: 'string'
              operator: 'string'
              values: [
                'string'
              ]
            }
          ]
          failingPeriods: {
            minFailingPeriodsToAlert: int
            numberOfEvaluationPeriods: int
          }
          metricMeasureColumn: 'string'
          metricName: '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
    skipQueryValidation: bool
    targetResourceTypes: [
      'string'
    ]
    windowSize: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

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

Действия

Имя	Описание	Ценность
actionGroups	Идентификаторы ресурсов группы действий для вызова при срабатывании оповещения.	string[]
customProperties	Свойства полезных данных оповещения.	ActionsCustomProperties

ActionsCustomProperties

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

Состояние

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

ConditionFailingPeriods

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

Измерение

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

Microsoft.Insights/scheduledQueryRules

Имя	Описание	Ценность
добрый	Указывает тип правила запланированного запроса. Значение по умолчанию — LogAlert.	LogAlert LogToMetric
местоположение	Географическое расположение, в котором находится ресурс	строка (обязательно)
имя	Имя ресурса	струна Ограничения целостности: Pattern = `^[^#<>%&:\?/{}*]{1,260}$` (обязательно)
свойства	Свойства правила ресурса.	ScheduledQueryRuleProperties (обязательно)
Теги	Теги ресурсов	Словарь имен и значений тегов. См. теги в шаблонах

ScheduledQueryRuleCriteria

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

ScheduledQueryRuleProperties

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

ScheduledQueryRuleResourceTags

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

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

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

группы ресурсов . См. команды развертывания группы ресурсов

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

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

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

{
  "type": "Microsoft.Insights/scheduledQueryRules",
  "apiVersion": "2022-06-15",
  "name": "string",
  "kind": "string",
  "location": "string",
  "properties": {
    "actions": {
      "actionGroups": [ "string" ],
      "customProperties": {
        "{customized property}": "string"
      }
    },
    "autoMitigate": "bool",
    "checkWorkspaceAlertsStorageConfigured": "bool",
    "criteria": {
      "allOf": [
        {
          "dimensions": [
            {
              "name": "string",
              "operator": "string",
              "values": [ "string" ]
            }
          ],
          "failingPeriods": {
            "minFailingPeriodsToAlert": "int",
            "numberOfEvaluationPeriods": "int"
          },
          "metricMeasureColumn": "string",
          "metricName": "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",
    "skipQueryValidation": "bool",
    "targetResourceTypes": [ "string" ],
    "windowSize": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

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

Действия

Имя	Описание	Ценность
actionGroups	Идентификаторы ресурсов группы действий для вызова при срабатывании оповещения.	string[]
customProperties	Свойства полезных данных оповещения.	ActionsCustomProperties

ActionsCustomProperties

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

Состояние

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

ConditionFailingPeriods

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

Измерение

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

Microsoft.Insights/scheduledQueryRules

Имя	Описание	Ценность
apiVersion	Версия API	'2022-06-15'
добрый	Указывает тип правила запланированного запроса. Значение по умолчанию — LogAlert.	LogAlert LogToMetric
местоположение	Географическое расположение, в котором находится ресурс	строка (обязательно)
имя	Имя ресурса	струна Ограничения целостности: Pattern = `^[^#<>%&:\?/{}*]{1,260}$` (обязательно)
свойства	Свойства правила ресурса.	ScheduledQueryRuleProperties (обязательно)
Теги	Теги ресурсов	Словарь имен и значений тегов. См. теги в шаблонах
тип	Тип ресурса	"Microsoft.Insights/scheduledQueryRules"

ScheduledQueryRuleCriteria

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

ScheduledQueryRuleProperties

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

ScheduledQueryRuleResourceTags

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

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

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

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

Шаблон

Описание

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

развертывание

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

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/scheduledQueryRules@2022-06-15"
  name = "string"
  kind = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      actions = {
        actionGroups = [
          "string"
        ]
        customProperties = {
          {customized property} = "string"
        }
      }
      autoMitigate = bool
      checkWorkspaceAlertsStorageConfigured = bool
      criteria = {
        allOf = [
          {
            dimensions = [
              {
                name = "string"
                operator = "string"
                values = [
                  "string"
                ]
              }
            ]
            failingPeriods = {
              minFailingPeriodsToAlert = int
              numberOfEvaluationPeriods = int
            }
            metricMeasureColumn = "string"
            metricName = "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
      skipQueryValidation = bool
      targetResourceTypes = [
        "string"
      ]
      windowSize = "string"
    }
  })
}

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

Действия

Имя	Описание	Ценность
actionGroups	Идентификаторы ресурсов группы действий для вызова при срабатывании оповещения.	string[]
customProperties	Свойства полезных данных оповещения.	ActionsCustomProperties

ActionsCustomProperties

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

Состояние

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

ConditionFailingPeriods

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

Измерение

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

Microsoft.Insights/scheduledQueryRules

Имя	Описание	Ценность
добрый	Указывает тип правила запланированного запроса. Значение по умолчанию — LogAlert.	LogAlert LogToMetric
местоположение	Географическое расположение, в котором находится ресурс	строка (обязательно)
имя	Имя ресурса	струна Ограничения целостности: Pattern = `^[^#<>%&:\?/{}*]{1,260}$` (обязательно)
свойства	Свойства правила ресурса.	ScheduledQueryRuleProperties (обязательно)
Теги	Теги ресурсов	Словарь имен и значений тегов.
тип	Тип ресурса	"Microsoft.Insights/scheduledQueryRules@2022-06-15"

ScheduledQueryRuleCriteria

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

ScheduledQueryRuleProperties

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

ScheduledQueryRuleResourceTags

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

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

Microsoft.Insights scheduledQueryRules 2022-06-15

Замечания

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

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

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

Действия

ActionsCustomProperties

Состояние

ConditionFailingPeriods

Измерение

Microsoft.Insights/scheduledQueryRules

ScheduledQueryRuleCriteria

ScheduledQueryRuleProperties

ScheduledQueryRuleResourceTags

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

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

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

Действия

ActionsCustomProperties

Состояние

ConditionFailingPeriods

Измерение

Microsoft.Insights/scheduledQueryRules

ScheduledQueryRuleCriteria

ScheduledQueryRuleProperties

ScheduledQueryRuleResourceTags

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

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

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

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

Действия

ActionsCustomProperties

Состояние

ConditionFailingPeriods

Измерение

Microsoft.Insights/scheduledQueryRules

ScheduledQueryRuleCriteria

ScheduledQueryRuleProperties

ScheduledQueryRuleResourceTags

Обратная связь

Дополнительные ресурсы