Microsoft.Insights metricAlerts

Статья
12/17/2024

последние
2018-03-01

Замечания

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

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

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

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

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

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

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

resource symbolicname 'Microsoft.Insights/metricAlerts@2018-03-01' = {
  location: 'string'
  name: 'string'
  properties: {
    actions: [
      {
        actionGroupId: 'string'
        webHookProperties: {
          {customized property}: 'string'
        }
      }
    ]
    autoMitigate: bool
    criteria: {
      odata.type: 'string'
      // For remaining properties, see MetricAlertCriteria objects
    }
    description: 'string'
    enabled: bool
    evaluationFrequency: 'string'
    scopes: [
      'string'
    ]
    severity: int
    targetResourceRegion: 'string'
    targetResourceType: 'string'
    windowSize: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Объекты MultiMetricCriteria

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

Для DynamicThresholdCriterionиспользуйте:

{
  alertSensitivity: 'string'
  criterionType: 'DynamicThresholdCriterion'
  failingPeriods: {
    minFailingPeriodsToAlert: int
    numberOfEvaluationPeriods: int
  }
  ignoreDataBefore: 'string'
  operator: 'string'
}

Для staticThresholdCriterionиспользуйте:

{
  criterionType: 'StaticThresholdCriterion'
  operator: 'string'
  threshold: int
}

Объекты MetricAlertCriteria

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

Для Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteriaиспользуйте следующее:

{
  allOf: [
    {
      dimensions: [
        {
          name: 'string'
          operator: 'string'
          values: [
            'string'
          ]
        }
      ]
      metricName: 'string'
      metricNamespace: 'string'
      name: 'string'
      skipMetricValidation: bool
      timeAggregation: 'string'
      criterionType: 'string'
      // For remaining properties, see MultiMetricCriteria objects
    }
  ]
  odata.type: 'Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria'
}

Для Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteriaиспользуйте следующее:

{
  allOf: [
    {
      criterionType: 'string'
      dimensions: [
        {
          name: 'string'
          operator: 'string'
          values: [
            'string'
          ]
        }
      ]
      metricName: 'string'
      metricNamespace: 'string'
      name: 'string'
      operator: 'string'
      skipMetricValidation: bool
      threshold: int
      timeAggregation: 'string'
    }
  ]
  odata.type: 'Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria'
}

Для Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteriaиспользуйте следующее:

{
  componentId: 'string'
  failedLocationCount: int
  odata.type: 'Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria'
  webTestId: 'string'
}

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

DynamicMetricCriteria

Имя	Описание	Ценность
alertSensitivity	Степень отклонения, необходимого для активации оповещения. Это повлияет на то, насколько жестко пороговое значение соответствует шаблону ряда метрик.	"Высокий" "Низкий" "Средний" (обязательный)
criterionType	Указывает тип пороговых условий	DynamicThresholdCriterion (обязательно)
сбойPeriods	Минимальное количество нарушений, необходимых в выбранном окне времени обратного просмотра, необходимое для создания оповещения.	DynamicThresholdFailingPeriods (обязательно)
ignoreDataBefore	Используйте этот параметр, чтобы задать дату, с которой начать обучение исторических данных метрик и вычислить динамические пороговые значения (в формате ISO8601)	струна
оператор	Оператор, используемый для сравнения значения метрик с пороговым значением.	'GreaterOrLessThan' 'GreaterThan' "LessThan" (обязательный)

DynamicThresholdFailingPeriods

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

MetricAlertAction

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

MetricAlertActionWebHookProperties

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

MetricAlertCriteria

Имя	Описание	Ценность
odata.type	Установите значение "Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria" для типа MetricAlertMultipleResourceMultipleMetricCriteria. Установите значение "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria" для типа MetricAlertSingleResourceMultipleMetricCriteria. Установите значение Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria для типа WebtestLocationAvailabilityCriteria.	"Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria" "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria" "Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria" (обязательно)

MetricAlertMultipleResourceMultipleMetricCriteria

Имя	Описание	Ценность
allOf	Список нескольких критериев метрик для этой операции "все".	MultiMetricCriteria[]
odata.type	указывает тип условий генерации оповещений.	"Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria" (обязательно)

MetricAlertProperties

Имя	Описание	Ценность
Действия	массив действий, выполняемых при активации правила генерации оповещений, и при разрешении условия генерации оповещений.	MetricAlertAction[]
autoMitigate	флаг, указывающий, следует ли автоматически разрешать оповещение. Значение по умолчанию — true.	bool
критерии	определяет определенные сведения о критериях генерации оповещений.	MetricAlertCriteria (обязательно)
описание	описание оповещения метрик, которое будет включено в сообщение электронной почты оповещений.	струна
Включен	флаг, указывающий, включена ли оповещение метрик.	bool (обязательно)
evaluationFrequency	как часто оповещение метрик оценивается в формате длительности ISO 8601.	строка (обязательно)
Области	Список идентификаторов ресурса, к которым относится это оповещение метрик.	string[] (обязательно)
суровость	Уровень серьезности оповещений {0, 1, 2, 3, 4}	int (обязательно)
targetResourceRegion	регион целевых ресурсов, на которых создается или обновляется оповещение. Обязательно, если область содержит подписку, группу ресурсов или несколько ресурсов.	струна
targetResourceType	Тип ресурса целевого ресурса, для которого создается или обновляется оповещение. Обязательно, если область содержит подписку, группу ресурсов или несколько ресурсов.	струна
windowSize	период времени (в формате длительности ISO 8601), используемый для отслеживания действий оповещений на основе порогового значения.	строка (обязательно)

MetricAlertSingleResourceMultipleMetricCriteria

Имя	Описание	Ценность
allOf	Список критериев метрик для этой операции "все".	MetricCriteria[]
odata.type	указывает тип условий генерации оповещений.	"Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria" (обязательно)

MetricCriteria

Имя	Описание	Ценность
criterionType	Указывает тип пороговых условий	DynamicThresholdCriterion "StaticThresholdCriterion" (обязательный)
Размеры	Список условий измерения.	MetricDimension[]
metricName	Имя метрики.	строка (обязательно)
Пространство метрик	Пространство имен метрик.	струна
имя	Имя критерия.	строка (обязательно)
оператор	оператор условий.	"Равно" 'GreaterThan' 'GreaterThanOrEqual' "LessThan" LessThanOrEqual (обязательный)
skipMetricValidation	Позволяет создавать правило генерации оповещений для пользовательской метрики, которая еще не была вызвана проверкой метрик.	bool
порог	пороговое значение условия, которое активирует оповещение.	int (обязательно)
timeAggregation	Типы агрегирования времени условий.	"Среднее" "Count" "Максимум" "Минимальный" "Total" (обязательный)

MetricCriteria

Имя	Описание	Ценность
criterionType	Указывает тип пороговых условий	"StaticThresholdCriterion" (обязательный)
оператор	оператор условий.	"Равно" 'GreaterThan' 'GreaterThanOrEqual' "LessThan" LessThanOrEqual (обязательный)
порог	пороговое значение условия, которое активирует оповещение.	int (обязательно)

MetricDimension

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