Microsoft.Insights metricAlerts 2018-03-01
Определение ресурса Bicep
Тип ресурса metricAlerts можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов — см. команды развертывания групп ресурсов.
Список измененных свойств в каждой версии API см. в журнале изменений.
Комментарии
Рекомендации по развертыванию решений для мониторинга см. в статье Создание ресурсов мониторинга с помощью Bicep.
Формат ресурсов
Чтобы создать ресурс Microsoft.Insights/metricAlerts, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.Insights/metricAlerts@2018-03-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
actions: [
{
actionGroupId: 'string'
webHookProperties: {}
}
]
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'
}
}
Объекты MetricAlertCriteria
Задайте свойство odata.type , чтобы указать тип объекта .
Для Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria используйте:
'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
}
]
Для Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria используйте:
'odata.type': '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'
}
]
Для Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria используйте:
'odata.type': 'Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria'
componentId: 'string'
failedLocationCount: int
webTestId: 'string'
Объекты MultiMetricCriteria
Задайте свойство criterionType , чтобы указать тип объекта .
Для DynamicThresholdCriterion используйте:
criterionType: 'DynamicThresholdCriterion'
alertSensitivity: 'string'
failingPeriods: {
minFailingPeriodsToAlert: int
numberOfEvaluationPeriods: int
}
ignoreDataBefore: 'string'
operator: 'string'
Для StaticThresholdCriterion используйте:
criterionType: 'StaticThresholdCriterion'
operator: 'string'
threshold: int
Значения свойств
metricAlerts
Имя | Описание | Значение |
---|---|---|
name | имя ресурса. | string (обязательно) Ограничение символов: 1–260 Допустимые символы: Нельзя использовать: *#&+:<>?@%{}\/ или управляющие символы. Не может заканчиваться пробелом или точкой. |
location | Расположение ресурса | string (обязательно) |
tags | Теги ресурсов | Словарь имен и значений тегов. См . раздел Теги в шаблонах |
properties | Свойства правила генерации оповещений ресурса. | MetricAlertProperties (обязательно) |
MetricAlertProperties
Имя | Описание | Значение |
---|---|---|
actions | массив действий, выполняемых при активации правила генерации оповещений и при разрешении условия оповещения. | MetricAlertAction[] |
autoMitigate | флаг, указывающий, должно ли оповещение разрешаться автоматически. Значение по умолчанию — true. | bool |
критерий | определяет сведения о конкретных критериях генерации оповещений. | MetricAlertCriteria (обязательно) |
description | описание оповещения метрики, которое будет включено в сообщение электронной почты с оповещением. | строка |
Включено | флаг, указывающий, включено ли оповещение метрики. | bool (обязательно) |
evaluationFrequency | как часто оповещение метрики оценивается в формате длительности ISO 8601. | string (обязательно) |
Области | список идентификаторов ресурса, к которым относится это оповещение метрики. | string[] (обязательно) |
severity | Серьезность оповещения {0, 1, 2, 3, 4} | int (обязательно) |
targetResourceRegion | регион целевых ресурсов, в которых создается или обновляется оповещение. Обязательно, если область содержит подписку, группу ресурсов или несколько ресурсов. | строка |
targetResourceType | тип ресурса целевых ресурсов, для которых создается или обновляется оповещение. Обязательно, если область содержит подписку, группу ресурсов или несколько ресурсов. | строка |
windowSize | период времени (в формате длительности ISO 8601), который используется для мониторинга действий оповещений на основе порогового значения. | string (обязательно) |
MetricAlertAction
Имя | Описание | Значение |
---|---|---|
actionGroupId | идентификатор используемой группы действий. | строка |
webHookProperties | Это поле позволяет указать пользовательские свойства, которые будут добавлены к полезным данным оповещения, отправленным в качестве входных данных в веб-перехватчик. | object |
MetricAlertCriteria
Имя | Описание | Значение |
---|---|---|
odata.type | Установка типа объекта | Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria (обязательно) |
MetricAlertMultipleResourceMultipleMetricCriteria
Имя | Описание | Значение |
---|---|---|
odata.type | указывает тип условий оповещения. | Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria (обязательно) |
allOf | список нескольких критериев метрик для этой операции "все". | MultiMetricCriteria[] |
MultiMetricCriteria
Имя | Описание | Значение |
---|---|---|
dimensions | Список условий измерения. | MetricDimension[] |
metricName | Имя метрики. | string (обязательно) |
metricNamespace | Пространство имен метрики. | строка |
name | Имя условия. | string (обязательно) |
skipMetricValidation | Это позволяет создать правило генерации оповещений для пользовательской метрики, которая еще не создана, настроив пропуск проверки этой метрики. | bool |
timeAggregation | типы агрегирования времени условий. | "Среднее" 'Count' "Максимум" "Минимум" "Всего" (обязательно) |
Тип условия | Установка типа объекта | DynamicThresholdCriterion StaticThresholdCriterion (обязательно) |
MetricDimension
Имя | Описание | Значение |
---|---|---|
name | Имя измерения. | string (обязательно) |
оператор | оператор измерения. Поддерживаются только "Include" и "Exclude" | string (обязательно) |
значения | список значений измерений. | string[] (обязательно) |
DynamicMetricCriteria
Имя | Описание | Значение |
---|---|---|
Тип условия | Указывает тип пороговых критериев | DynamicThresholdCriterion (обязательно) |
alertSensitivity | Степень отклонения, необходимая для активации оповещения. Это повлияет на то, насколько жестким является пороговое значение для шаблона рядов метрик. | "Высокий" "Низкий" "Средний" (обязательный) |
failingPeriods | Минимальное количество нарушений, необходимых в течение выбранного периода времени обратного просмотра, необходимого для создания оповещения. | DynamicThresholdFailingPeriods (обязательно) |
ignoreDataBefore | Используйте этот параметр, чтобы задать дату, с которой следует начать изучение исторических данных метрик и вычислить динамические пороговые значения (в ISO8601 формате). | строка |
оператор | Оператор, используемый для сравнения значения метрики с пороговым значением. | 'GreaterOrLessThan' 'GreaterThan' LessThan (обязательно) |
DynamicThresholdFailingPeriods
Имя | Описание | Значение |
---|---|---|
minFailingPeriodsToAlert | Количество нарушений, инициируемых оповещением. Значение должно быть меньше или равно numberOfEvaluationPeriods. | int (обязательно) |
numberOfEvaluationPeriods | Количество агрегированных точек обратного просмотра. Окно времени обратного просмотра вычисляется на основе степени детализации агрегирования (windowSize) и выбранного количества агрегированных точек. | int (обязательно) |
MetricCriteria
Имя | Описание | Значение |
---|---|---|
Тип условия | Указывает тип пороговых условий. | DynamicThresholdCriterion StaticThresholdCriterion (обязательно) |
dimensions | Список условий измерения. | MetricDimension[] |
metricName | Имя метрики. | строка (обязательно) |
metricNamespace | Пространство имен метрики. | строка |
name | Имя условия. | строка (обязательно) |
оператор | оператор условия. | "Равно" 'GreaterThan' 'GreaterThanOrEqual' "LessThan" LessThanOrEqual (обязательно) |
skipMetricValidation | Это позволяет создать правило генерации оповещений для пользовательской метрики, которая еще не создана, настроив пропуск проверки этой метрики. | bool |
threshold | пороговое значение условия, которое активирует оповещение. | int (обязательно) |
timeAggregation | Типы агрегирования времени условий. | "Среднее" 'Count' "Максимум" "Минимум" "Total" (обязательно) |
MetricAlertSingleResourceMultipleMetricCriteria
Имя | Описание | Значение |
---|---|---|
odata.type | указывает тип условия оповещения. | Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria (обязательно) |
allOf | Список критериев метрик для этой операции "все". | MetricCriteria[] |
WebtestLocationAvailabilityCriteria
Имя | Описание | Значение |
---|---|---|
odata.type | указывает тип условия оповещения. | Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria (обязательно) |
componentId | Идентификатор ресурса Application Insights. | строка (обязательно) |
failedLocationCount | Количество неудачных расположений. | int (обязательно) |
webTestId | Идентификатор веб-теста Application Insights. | строка (обязательно) |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
Шаблон | Описание |
---|---|
BrowserBox Azure Edition |
Этот шаблон развертывает BrowserBox на виртуальной машине LVM Azure Ubuntu Server 22.04 LTS, Debian 11 или RHEL 8.7. |
Масштабируемое веб-приложение Umbraco CMS |
Этот шаблон предоставляет простой способ развертывания веб-приложения umbraco CMS на Служба приложений Azure веб-приложения. |
Создание оповещений для Шлюз приложений |
Используйте эти шаблоны для создания важных оповещений о событиях для Шлюз приложений Azure. |
Оповещение для метрики ответа последнего байта серверной части |
Используйте такие шаблоны для создания важных оповещений о событиях для Шлюз приложений Azure. |
Метрика "Оповещение о количестве неработоспособных узлов" |
Используйте такие шаблоны для создания важных оповещений о событиях для Шлюз приложений Azure. |
Enterprise Governance—AppService, SQL Db, AD, OMS, Runbook |
Для внедрения облачных решений для малого или крупного предприятия требуются модели ответственного и эффективного управления, чтобы извлечь выгоду из облачных развертываний. CloudWise (кодовое имя решения) — это составное решение, доступное в кратких руководствах для партнеров Azure. Это средство внедрения для клиентов, системных интеграторов и партнеров, которое предоставляет решение для самообслуживания автоматизированного управления и эксплуатации, ориентированное на оптимизацию затрат, повышение надежности приложений, снижение бизнес-рисков. Решение выделяет основные принципы управления видимостью и контролем. |
Создание динамического веб-теста |
Создайте любое количество веб-тестов App Insights (ping). |
Развертывание Application Insight и создание оповещений в ней |
Этот шаблон позволяет развернуть Application Insight и создать в нем оповещение. |
Правило генерации оповещений метрик с динамическим пороговым значением |
Этот шаблон создает правило генерации оповещений метрики, которое отслеживает метрику процент ЦП виртуальной машины, используя тип условия динамического порога. |
Правило генерации оповещений метрик со статическим пороговым значением |
Этот шаблон создает правило генерации оповещений метрики, которое отслеживает метрику процент ЦП виртуальной машины, используя тип условия статического порога. |
Правило генерации оповещений метрик для теста доступности |
Этот шаблон создает тест доступности Application Insights вместе с правилом генерации оповещений метрик, которое отслеживает его. |
Определение ресурса шаблона ARM
Тип ресурса metricAlerts можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов — см. команды развертывания группы ресурсов.
Список измененных свойств в каждой версии API см. в журнале изменений.
Комментарии
Инструкции по развертыванию решений мониторинга см. в статье Создание ресурсов мониторинга с помощью Bicep.
Формат ресурсов
Чтобы создать ресурс Microsoft.Insights/metricAlerts, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.Insights/metricAlerts",
"apiVersion": "2018-03-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"actions": [
{
"actionGroupId": "string",
"webHookProperties": {}
}
],
"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"
}
}
Объекты MetricAlertCriteria
Задайте свойство odata.type , чтобы указать тип объекта .
Для Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria используйте:
"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
}
]
Для Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria используйте:
"odata.type": "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"
}
]
Для Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria используйте:
"odata.type": "Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria",
"componentId": "string",
"failedLocationCount": "int",
"webTestId": "string"
Объекты MultiMetricCriteria
Задайте свойство criterionType , чтобы указать тип объекта.
Для DynamicThresholdCriterion используйте:
"criterionType": "DynamicThresholdCriterion",
"alertSensitivity": "string",
"failingPeriods": {
"minFailingPeriodsToAlert": "int",
"numberOfEvaluationPeriods": "int"
},
"ignoreDataBefore": "string",
"operator": "string"
Для StaticThresholdCriterion используйте:
"criterionType": "StaticThresholdCriterion",
"operator": "string",
"threshold": "int"
Значения свойств
metricAlerts
Имя | Описание | Значение |
---|---|---|
тип | Тип ресурса | Microsoft.Insights/metricAlerts |
версия_API | Версия API ресурсов | '2018-03-01' |
name | имя ресурса. | строка (обязательно) Ограничение символов: 1–260 Допустимые символы: Нельзя использовать: *#&+:<>?@%{}\/ или управляющие символы. Не может заканчиваться пробелом или точкой. |
location | Расположение ресурса | строка (обязательно) |
tags | Теги ресурсов | Словарь имен и значений тегов. См . раздел Теги в шаблонах |
properties | Свойства правила генерации оповещений ресурса. | MetricAlertProperties (обязательно) |
MetricAlertProperties
Имя | Описание | Значение |
---|---|---|
actions | массив действий, выполняемых при активации правила генерации оповещений и при разрешении условия оповещения. | MetricAlertAction[] |
autoMitigate | флаг, указывающий, должно ли оповещение разрешаться автоматически. Значение по умолчанию — true. | bool |
критерий | определяет сведения о конкретных критериях оповещения. | MetricAlertCriteria (обязательно) |
description | описание оповещения метрики, которое будет включено в сообщение электронной почты с оповещением. | строка |
Включено | флаг, указывающий, включено ли оповещение метрики. | bool (обязательно) |
evaluationFrequency | как часто оповещение метрики оценивается в формате длительности ISO 8601. | строка (обязательно) |
Области | список идентификаторов ресурсов, к которым относится это оповещение метрики. | string[] (обязательно) |
severity | Серьезность оповещения {0, 1, 2, 3, 4} | int (обязательно) |
targetResourceRegion | регион целевых ресурсов, в которых создается или обновляется оповещение. Обязательно, если область содержит подписку, группу ресурсов или несколько ресурсов. | строка |
targetResourceType | тип ресурса целевых ресурсов, для которых создается или обновляется оповещение. Обязательно, если область содержит подписку, группу ресурсов или несколько ресурсов. | строка |
windowSize | период времени (в формате длительности ISO 8601), который используется для мониторинга активности оповещений на основе порогового значения. | строка (обязательно) |
MetricAlertAction
Имя | Описание | Значение |
---|---|---|
actionGroupId | идентификатор используемой группы действий. | строка |
webHookProperties | Это поле позволяет указать пользовательские свойства, которые будут добавлены в полезные данные оповещения, отправленные в качестве входных данных в веб-перехватчик. | object |
MetricAlertCriteria
Имя | Описание | Значение |
---|---|---|
odata.type | Установка типа объекта | Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria (обязательно) |
MetricAlertMultipleResourceMultipleMetricCriteria
Имя | Описание | Значение |
---|---|---|
odata.type | указывает тип условия оповещения. | Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria (обязательно) |
allOf | список нескольких критериев метрик для этой операции "все". | MultiMetricCriteria[] |
MultiMetricCriteria
Имя | Описание | Значение |
---|---|---|
dimensions | Список условий измерения. | MetricDimension[] |
metricName | Имя метрики. | строка (обязательно) |
metricNamespace | Пространство имен метрики. | строка |
name | Имя условия. | строка (обязательно) |
skipMetricValidation | Это позволяет создать правило генерации оповещений для пользовательской метрики, которая еще не создана, настроив пропуск проверки этой метрики. | bool |
timeAggregation | Типы агрегирования времени условий. | "Среднее" 'Count' "Максимум" "Минимум" "Total" (обязательно) |
тип условия | Установка типа объекта | DynamicThresholdCriterion StaticThresholdCriterion (обязательно) |
MetricDimension
Имя | Описание | Значение |
---|---|---|
name | Имя измерения. | строка (обязательно) |
оператор | оператор измерения. Поддерживаются только "Include" и "Exclude" | строка (обязательно) |
значения | список значений измерения. | string[] (обязательно) |
DynamicMetricCriteria
Имя | Описание | Значение |
---|---|---|
тип условия | Указывает тип пороговых условий. | DynamicThresholdCriterion (обязательно) |
AlertSensitivity | Степень отклонения, необходимая для активации оповещения. Это повлияет на то, насколько жесткое пороговое значение для шаблона рядов метрик. | "Высокий" "Низкий" "Средний" (обязательно) |
failingPeriods | Минимальное количество нарушений, необходимых в течение выбранного периода времени обратного просмотра, необходимого для создания оповещения. | DynamicThresholdFailingPeriods (обязательно) |
ignoreDataBefore | Используйте этот параметр, чтобы задать дату, с которой следует начать изучение исторических данных метрик, и вычислить динамические пороговые значения (в ISO8601 формате). | строка |
оператор | Оператор, используемый для сравнения значения метрики с пороговым значением. | 'GreaterOrLessThan' 'GreaterThan' LessThan (обязательно) |
DynamicThresholdFailingPeriods
Имя | Описание | Значение |
---|---|---|
minFailingPeriodsToAlert | Количество нарушений, которые активируют оповещение. Значение должно быть меньше или равно numberOfEvaluationPeriods. | int (обязательно) |
numberOfEvaluationPeriods | Количество агрегированных точек обратного просмотра. Период времени просмотра рассчитывается на основе степени детализации агрегирования (windowSize) и выбранного количества агрегированных точек. | int (обязательно) |
MetricCriteria
Имя | Описание | Значение |
---|---|---|
тип условия | Указывает тип пороговых условий. | DynamicThresholdCriterion StaticThresholdCriterion (обязательно) |
dimensions | Список условий измерения. | MetricDimension[] |
metricName | Имя метрики. | строка (обязательно) |
metricNamespace | Пространство имен метрики. | строка |
name | Имя условия. | строка (обязательно) |
оператор | оператор условия. | "Равно" 'GreaterThan' 'GreaterThanOrEqual' "LessThan" LessThanOrEqual (обязательно) |
skipMetricValidation | Это позволяет создать правило генерации оповещений для пользовательской метрики, которая еще не создана, настроив пропуск проверки этой метрики. | bool |
threshold | пороговое значение условия, которое активирует оповещение. | int (обязательно) |
timeAggregation | Типы агрегирования времени условий. | "Среднее" 'Count' "Максимум" "Минимум" "Total" (обязательно) |
MetricAlertSingleResourceMultipleMetricCriteria
Имя | Описание | Значение |
---|---|---|
odata.type | указывает тип условия оповещения. | Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria (обязательно) |
allOf | Список критериев метрик для этой операции "все". | MetricCriteria[] |
WebtestLocationAvailabilityCriteria
Имя | Описание | Значение |
---|---|---|
odata.type | указывает тип условия оповещения. | Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria (обязательно) |
componentId | Идентификатор ресурса Application Insights. | строка (обязательно) |
failedLocationCount | Количество неудачных расположений. | int (обязательно) |
webTestId | Идентификатор веб-теста Application Insights. | строка (обязательно) |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
Шаблон | Описание |
---|---|
BrowserBox Azure Edition |
Этот шаблон развертывает BrowserBox на виртуальной машине LVM Azure Ubuntu Server 22.04 LTS, Debian 11 или RHEL 8.7. |
Масштабируемое веб-приложение Umbraco CMS |
Этот шаблон предоставляет простой способ развертывания веб-приложения umbraco CMS на Служба приложений Azure веб-приложения. |
Создание оповещений для Шлюз приложений |
Используйте эти шаблоны для создания важных оповещений о событиях для Шлюз приложений Azure. |
Оповещение для метрики ответа последнего байта серверной части |
Используйте такие шаблоны для создания важных оповещений о событиях для Шлюз приложений Azure. |
Метрика "Оповещение о количестве неработоспособных узлов" |
Используйте такие шаблоны для создания важных оповещений о событиях для Шлюз приложений Azure. |
Enterprise Governance—AppService, SQL Db, AD, OMS, Runbook |
Для внедрения облачных решений для малого или крупного предприятия требуются модели ответственного и эффективного управления, чтобы извлечь выгоду из облачных развертываний. CloudWise (кодовое имя решения) — это составное решение, доступное в кратких руководствах для партнеров Azure. Это средство внедрения для клиентов, системных интеграторов и партнеров, которое предоставляет решение для самообслуживания автоматизированного управления и эксплуатации, ориентированное на оптимизацию затрат, повышение надежности приложений, снижение бизнес-рисков. Решение выделяет основные принципы управления видимостью и контролем. |
Создание динамического веб-теста |
Создайте любое количество веб-тестов App Insights (ping). |
Развертывание Application Insight и создание оповещений в ней |
Этот шаблон позволяет развернуть Application Insight и создать в нем оповещение. |
Правило генерации оповещений метрик с динамическим пороговым значением |
Этот шаблон создает правило генерации оповещений метрики, которое отслеживает метрику процент ЦП виртуальной машины, используя тип условия динамического порога. |
Правило генерации оповещений метрик со статическим пороговым значением |
Этот шаблон создает правило генерации оповещений метрики, которое отслеживает метрику процент ЦП виртуальной машины, используя тип условия статического порога. |
Правило генерации оповещений метрик для теста доступности |
Этот шаблон создает тест доступности Application Insights вместе с правилом генерации оповещений метрик, которое отслеживает его. |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса metricAlerts можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.Insights/metricAlerts, добавьте в шаблон следующую строку Terraform.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Insights/metricAlerts@2018-03-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
actions = [
{
actionGroupId = "string"
webHookProperties = {}
}
]
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"
}
})
}
Объекты MetricAlertCriteria
Задайте свойство odata.type , чтобы указать тип объекта .
Для Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria используйте:
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
}
]
Для Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria используйте:
odata.type = "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"
}
]
Для Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria используйте:
odata.type = "Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria"
componentId = "string"
failedLocationCount = int
webTestId = "string"
Объекты MultiMetricCriteria
Задайте свойство criterionType , чтобы указать тип объекта.
Для DynamicThresholdCriterion используйте:
criterionType = "DynamicThresholdCriterion"
alertSensitivity = "string"
failingPeriods = {
minFailingPeriodsToAlert = int
numberOfEvaluationPeriods = int
}
ignoreDataBefore = "string"
operator = "string"
Для StaticThresholdCriterion используйте:
criterionType = "StaticThresholdCriterion"
operator = "string"
threshold = int
Значения свойств
metricAlerts
Имя | Описание | Значение |
---|---|---|
тип | Тип ресурса | "Microsoft.Insights/metricAlerts@2018-03-01" |
name | имя ресурса. | строка (обязательно) Ограничение символов: 1–260 Допустимые символы: Нельзя использовать: *#&+:<>?@%{}\/ или управляющие символы. Не может заканчиваться пробелом или точкой. |
location | Расположение ресурса | строка (обязательно) |
parent_id | Чтобы выполнить развертывание в группе ресурсов, используйте идентификатор этой группы ресурсов. | строка (обязательно) |
tags | Теги ресурсов | Словарь имен и значений тегов. |
properties | Свойства правила генерации оповещений ресурса. | MetricAlertProperties (обязательно) |
MetricAlertProperties
Имя | Описание | Значение |
---|---|---|
actions | массив действий, выполняемых при активации правила генерации оповещений и при разрешении условия оповещения. | MetricAlertAction[] |
autoMitigate | флаг, указывающий, должно ли оповещение разрешаться автоматически. Значение по умолчанию — true. | bool |
критерий | определяет сведения о конкретных критериях оповещения. | MetricAlertCriteria (обязательно) |
description | описание оповещения метрики, которое будет включено в сообщение электронной почты с оповещением. | строка |
Включено | флаг, указывающий, включено ли оповещение метрики. | bool (обязательно) |
evaluationFrequency | как часто оповещение метрики оценивается в формате длительности ISO 8601. | строка (обязательно) |
Области | список идентификаторов ресурсов, к которым относится это оповещение метрики. | string[] (обязательно) |
severity | Серьезность оповещения {0, 1, 2, 3, 4} | int (обязательно) |
targetResourceRegion | регион целевых ресурсов, в которых создается или обновляется оповещение. Обязательно, если область содержит подписку, группу ресурсов или несколько ресурсов. | строка |
targetResourceType | тип ресурса целевых ресурсов, для которых создается или обновляется оповещение. Обязательно, если область содержит подписку, группу ресурсов или несколько ресурсов. | строка |
windowSize | период времени (в формате длительности ISO 8601), который используется для мониторинга активности оповещений на основе порогового значения. | строка (обязательно) |
MetricAlertAction
Имя | Описание | Значение |
---|---|---|
actionGroupId | идентификатор используемой группы действий. | строка |
webHookProperties | Это поле позволяет указать пользовательские свойства, которые будут добавлены в полезные данные оповещения, отправленные в качестве входных данных в веб-перехватчик. | object |
MetricAlertCriteria
Имя | Описание | Значение |
---|---|---|
odata.type | Установка типа объекта | Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria (обязательно) |
MetricAlertMultipleResourceMultipleMetricCriteria
Имя | Описание | Значение |
---|---|---|
odata.type | указывает тип условия оповещения. | "Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria" (обязательно) |
allOf | список нескольких критериев метрик для этой операции "все". | MultiMetricCriteria[] |
MultiMetricCriteria
Имя | Описание | Значение |
---|---|---|
dimensions | Список условий измерения. | MetricDimension[] |
metricName | Имя метрики. | строка (обязательно) |
metricNamespace | Пространство имен метрики. | строка |
name | Имя условия. | строка (обязательно) |
skipMetricValidation | Это позволяет создать правило генерации оповещений для пользовательской метрики, которая еще не создана, настроив пропуск проверки этой метрики. | bool |
timeAggregation | Типы агрегирования времени условий. | "Среднее" "Count" "Максимум" "Минимум" "Total" (обязательно) |
тип условия | Установка типа объекта | DynamicThresholdCriterion StaticThresholdCriterion (обязательно) |
MetricDimension
Имя | Описание | Значение |
---|---|---|
name | Имя измерения. | строка (обязательно) |
оператор | оператор измерения. Поддерживаются только "Include" и "Exclude" | строка (обязательно) |
значения | список значений измерения. | string[] (обязательно) |
DynamicMetricCriteria
Имя | Описание | Значение |
---|---|---|
тип условия | Указывает тип пороговых условий. | "DynamicThresholdCriterion" (обязательно) |
AlertSensitivity | Степень отклонения, необходимая для активации оповещения. Это повлияет на то, насколько жесткое пороговое значение для шаблона рядов метрик. | "High" "Low" "Средний" (обязательный) |
failingPeriods | Минимальное количество нарушений, необходимых в течение выбранного периода времени обратного просмотра, необходимого для создания оповещения. | DynamicThresholdFailingPeriods (обязательно) |
ignoreDataBefore | Используйте этот параметр, чтобы задать дату, с которой следует начать изучение исторических данных метрик, и вычислить динамические пороговые значения (в ISO8601 формате). | строка |
оператор | Оператор, используемый для сравнения значения метрики с пороговым значением. | "GreaterOrLessThan" "GreaterThan" "LessThan" (обязательно) |
DynamicThresholdFailingPeriods
Имя | Описание | Значение |
---|---|---|
minFailingPeriodsToAlert | Количество нарушений, которые активируют оповещение. Значение должно быть меньше или равно numberOfEvaluationPeriods. | int (обязательно) |
numberOfEvaluationPeriods | Количество агрегированных точек обратного просмотра. Период времени просмотра рассчитывается на основе степени детализации агрегирования (windowSize) и выбранного количества агрегированных точек. | int (обязательно) |
MetricCriteria
Имя | Описание | Значение |
---|---|---|
тип условия | Указывает тип пороговых условий. | "DynamicThresholdCriterion" StaticThresholdCriterion (обязательно) |
dimensions | Список условий измерения. | MetricDimension[] |
metricName | Имя метрики. | строка (обязательно) |
metricNamespace | Пространство имен метрики. | строка |
name | Имя условия. | строка (обязательно) |
оператор | оператор условия. | "Равно" "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" (обязательно) |
skipMetricValidation | Это позволяет создать правило генерации оповещений для пользовательской метрики, которая еще не создана, настроив пропуск проверки этой метрики. | bool |
threshold | пороговое значение условия, которое активирует оповещение. | int (обязательно) |
timeAggregation | Типы агрегирования времени условий. | "Среднее" "Count" "Максимум" "Минимум" "Total" (обязательно) |
MetricAlertSingleResourceMultipleMetricCriteria
Имя | Описание | Значение |
---|---|---|
odata.type | указывает тип условия оповещения. | "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria" (обязательно) |
allOf | Список критериев метрик для этой операции "все". | MetricCriteria[] |
WebtestLocationAvailabilityCriteria
Имя | Описание | Значение |
---|---|---|
odata.type | указывает тип условия оповещения. | "Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria" (обязательно) |
componentId | Идентификатор ресурса Application Insights. | строка (обязательно) |
failedLocationCount | Количество неудачных расположений. | int (обязательно) |
webTestId | Идентификатор веб-теста Application Insights. | строка (обязательно) |
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по