Metric Alerts - Update
Обновление определения оповещения метрики.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}?api-version=2018-03-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
resource
|
path | True |
string |
Имя группы ресурсов. Регистр букв в имени не учитывается. |
rule
|
path | True |
string |
Имя правила. |
subscription
|
path | True |
string |
Идентификатор целевой подписки. |
api-version
|
query | True |
string |
Версия API, используемая для данной операции. |
Текст запроса
Имя | Тип | Описание |
---|---|---|
properties.actions |
массив действий, выполняемых при активации правила генерации оповещений и при разрешении условия оповещения. |
|
properties.autoMitigate |
boolean |
флаг, указывающий, должно ли оповещение разрешаться автоматически. Значение по умолчанию — true. |
properties.criteria | MetricAlertCriteria: |
определяет сведения о конкретных критериях оповещения. |
properties.description |
string |
описание оповещения метрики, которое будет включено в сообщение электронной почты с оповещением. |
properties.enabled |
boolean |
флаг, указывающий, включено ли оповещение метрики. |
properties.evaluationFrequency |
string |
как часто оповещение метрики оценивается в формате длительности ISO 8601. |
properties.scopes |
string[] |
список идентификаторов ресурсов, к которым относится это оповещение метрики. |
properties.severity |
integer |
Серьезность оповещения {0, 1, 2, 3, 4} |
properties.targetResourceRegion |
string |
регион целевых ресурсов, в которых создается или обновляется оповещение. Обязательный для MultipleResourceMultipleMetricCriteria. |
properties.targetResourceType |
string |
тип ресурса целевых ресурсов, для которых создается или обновляется оповещение. Обязательный для MultipleResourceMultipleMetricCriteria. |
properties.windowSize |
string |
период времени (в формате длительности ISO 8601), который используется для мониторинга активности оповещений на основе порогового значения. |
tags |
object |
Теги ресурсов |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
ОК |
|
Other Status Codes |
BadRequest |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
Create or update an alert rule
Образец запроса
PATCH https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Insights/metricAlerts/chiricutin?api-version=2018-03-01
{
"tags": {},
"properties": {
"description": "This is the description of the rule1",
"severity": 3,
"enabled": true,
"scopes": [
"/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
],
"evaluationFrequency": "Pt1m",
"windowSize": "Pt15m",
"criteria": {
"odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria",
"allOf": [
{
"criterionType": "StaticThresholdCriterion",
"name": "High_CPU_80",
"metricName": "\\Processor(_Total)\\% Processor Time",
"dimensions": [],
"operator": "GreaterThan",
"threshold": 80.5,
"timeAggregation": "Average"
}
]
},
"autoMitigate": true,
"actions": [
{
"actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
"webHookProperties": {
"key11": "value11",
"key12": "value12"
}
}
]
}
}
Пример ответа
{
"id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/chiricutin",
"type": "Microsoft.Insights/metricAlerts",
"location": "global",
"tags": {
"hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
},
"properties": {
"description": "This is the description of the rule1",
"severity": 3,
"enabled": true,
"scopes": [
"/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
],
"evaluationFrequency": "Pt1m",
"windowSize": "Pt15m",
"criteria": {
"odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria",
"allOf": [
{
"criterionType": "StaticThresholdCriterion",
"name": "High_CPU_80",
"metricName": "\\Processor(_Total)\\% Processor Time",
"dimensions": [],
"operator": "GreaterThan",
"threshold": 80.5,
"timeAggregation": "Average"
}
]
},
"autoMitigate": true,
"actions": [
{
"actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
"webHookProperties": {
"key11": "value11",
"key12": "value12"
}
}
]
}
}
Определения
Имя | Описание |
---|---|
Aggregation |
типы агрегирования времени условий. |
Dynamic |
Критерий динамического порога. |
Dynamic |
Минимальное количество нарушений, необходимых в течение выбранного периода времени обратного просмотра, необходимого для создания оповещения. |
Dynamic |
Оператор, используемый для сравнения значения метрики с пороговым значением. |
Dynamic |
Степень отклонения, необходимая для активации оповещения. Это повлияет на то, насколько жестким является пороговое значение для шаблона рядов метрик. |
Error |
Описывает формат ответа об ошибке. |
Metric |
Действие оповещения. |
Metric |
Указывает критерии генерации оповещений метрики для нескольких ресурсов, которые имеют несколько критериев метрики. |
Metric |
Ресурс оповещений метрик. |
Metric |
Ресурс оповещений метрик для операций исправления. |
Metric |
Задает критерии генерации оповещений метрик для одного ресурса, имеющего несколько критериев метрики. |
Metric |
Критерий для фильтрации метрик. |
Metric |
Задает измерение метрики. |
Operator |
оператор условий. |
Webtest |
Задает критерии правила генерации оповещений метрики для ресурса веб-теста. |
AggregationTypeEnum
типы агрегирования времени условий.
Имя | Тип | Описание |
---|---|---|
Average |
string |
|
Count |
string |
|
Maximum |
string |
|
Minimum |
string |
|
Total |
string |
DynamicMetricCriteria
Критерий динамического порога.
Имя | Тип | Описание |
---|---|---|
alertSensitivity |
Степень отклонения, необходимая для активации оповещения. Это повлияет на то, насколько жестким является пороговое значение для шаблона рядов метрик. |
|
criterionType |
string:
Dynamic |
Указывает тип пороговых критериев |
dimensions |
Список условий измерения. |
|
failingPeriods |
Минимальное количество нарушений, необходимых в течение выбранного периода времени обратного просмотра, необходимого для создания оповещения. |
|
ignoreDataBefore |
string |
Используйте этот параметр, чтобы задать дату, с которой следует начать изучение исторических данных метрик и вычислить динамические пороговые значения (в ISO8601 формате). |
metricName |
string |
Имя метрики. |
metricNamespace |
string |
Пространство имен метрики. |
name |
string |
Имя условия. |
operator |
Оператор, используемый для сравнения значения метрики с пороговым значением. |
|
skipMetricValidation |
boolean |
Это позволяет создать правило генерации оповещений для пользовательской метрики, которая еще не создана, настроив пропуск проверки этой метрики. |
timeAggregation |
типы агрегирования времени условий. |
DynamicThresholdFailingPeriods
Минимальное количество нарушений, необходимых в течение выбранного периода времени обратного просмотра, необходимого для создания оповещения.
Имя | Тип | Описание |
---|---|---|
minFailingPeriodsToAlert |
number |
Количество нарушений, инициируемых оповещением. Значение должно быть меньше или равно numberOfEvaluationPeriods. |
numberOfEvaluationPeriods |
number |
Количество агрегированных точек обратного просмотра. Окно времени обратного просмотра вычисляется на основе степени детализации агрегирования (windowSize) и выбранного количества агрегированных точек. |
DynamicThresholdOperator
Оператор, используемый для сравнения значения метрики с пороговым значением.
Имя | Тип | Описание |
---|---|---|
GreaterOrLessThan |
string |
|
GreaterThan |
string |
|
LessThan |
string |
DynamicThresholdSensitivity
Степень отклонения, необходимая для активации оповещения. Это повлияет на то, насколько жестким является пороговое значение для шаблона рядов метрик.
Имя | Тип | Описание |
---|---|---|
High |
string |
|
Low |
string |
|
Medium |
string |
ErrorResponse
Описывает формат ответа об ошибке.
Имя | Тип | Описание |
---|---|---|
code |
string |
Код ошибки |
message |
string |
Сообщение об ошибке, указывающее, почему операция завершилась сбоем. |
MetricAlertAction
Действие оповещения.
Имя | Тип | Описание |
---|---|---|
actionGroupId |
string |
идентификатор используемой группы действий. |
webHookProperties |
object |
Это поле позволяет указать пользовательские свойства, которые будут добавлены к полезным данным оповещения, отправленным в качестве входных данных в веб-перехватчик. |
MetricAlertMultipleResourceMultipleMetricCriteria
Указывает критерии генерации оповещений метрики для нескольких ресурсов, которые имеют несколько критериев метрики.
Имя | Тип | Описание |
---|---|---|
allOf | MultiMetricCriteria[]: |
список нескольких критериев метрик для этой операции "все". |
odata.type |
string:
Microsoft. |
указывает тип условий оповещения. |
MetricAlertResource
Ресурс оповещений метрик.
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор ресурса Azure |
location |
string |
Расположение ресурса |
name |
string |
Имя ресурса Azure |
properties.actions |
массив действий, выполняемых при активации правила генерации оповещений и при разрешении условия оповещения. |
|
properties.autoMitigate |
boolean |
флаг, указывающий, должно ли оповещение разрешаться автоматически. Значение по умолчанию — true. |
properties.criteria | MetricAlertCriteria: |
определяет сведения о конкретных критериях генерации оповещений. |
properties.description |
string |
описание оповещения метрики, которое будет включено в сообщение электронной почты с оповещением. |
properties.enabled |
boolean |
флаг, указывающий, включено ли оповещение метрики. |
properties.evaluationFrequency |
string |
как часто оповещение метрики оценивается в формате длительности ISO 8601. |
properties.isMigrated |
boolean |
значение, указывающее, переносится ли это правило генерации оповещений. |
properties.lastUpdatedTime |
string |
Время последнего обновления правила в формате ISO8601. |
properties.scopes |
string[] |
список идентификаторов ресурса, к которым относится это оповещение метрики. |
properties.severity |
integer |
Серьезность оповещения {0, 1, 2, 3, 4} |
properties.targetResourceRegion |
string |
регион целевых ресурсов, в которых создается или обновляется оповещение. Обязательно, если область содержит подписку, группу ресурсов или несколько ресурсов. |
properties.targetResourceType |
string |
тип ресурса целевых ресурсов, для которых создается или обновляется оповещение. Обязательно, если область содержит подписку, группу ресурсов или несколько ресурсов. |
properties.windowSize |
string |
период времени (в формате длительности ISO 8601), который используется для мониторинга действий оповещений на основе порогового значения. |
tags |
object |
Теги ресурсов |
type |
string |
Тип ресурса Azure |
MetricAlertResourcePatch
Ресурс оповещений метрик для операций исправления.
Имя | Тип | Описание |
---|---|---|
properties.actions |
массив действий, выполняемых при активации правила генерации оповещений и при разрешении условия оповещения. |
|
properties.autoMitigate |
boolean |
флаг, указывающий, должно ли оповещение разрешаться автоматически. Значение по умолчанию — true. |
properties.criteria | MetricAlertCriteria: |
определяет сведения о конкретных критериях генерации оповещений. |
properties.description |
string |
описание оповещения метрики, которое будет включено в сообщение электронной почты с оповещением. |
properties.enabled |
boolean |
флаг, указывающий, включено ли оповещение метрики. |
properties.evaluationFrequency |
string |
как часто оповещение метрики оценивается в формате длительности ISO 8601. |
properties.isMigrated |
boolean |
значение, указывающее, переносится ли это правило генерации оповещений. |
properties.lastUpdatedTime |
string |
Время последнего обновления правила в формате ISO8601. |
properties.scopes |
string[] |
список идентификаторов ресурса, к которым относится это оповещение метрики. |
properties.severity |
integer |
Серьезность оповещения {0, 1, 2, 3, 4} |
properties.targetResourceRegion |
string |
регион целевых ресурсов, в которых создается или обновляется оповещение. Обязательный для MultipleResourceMultipleMetricCriteria. |
properties.targetResourceType |
string |
тип ресурса целевых ресурсов, для которых создается или обновляется оповещение. Обязательный для MultipleResourceMultipleMetricCriteria. |
properties.windowSize |
string |
период времени (в формате длительности ISO 8601), который используется для мониторинга действий оповещений на основе порогового значения. |
tags |
object |
Теги ресурсов |
MetricAlertSingleResourceMultipleMetricCriteria
Задает критерии генерации оповещений метрик для одного ресурса, имеющего несколько критериев метрики.
Имя | Тип | Описание |
---|---|---|
allOf |
Список критериев метрик для этой операции "все". |
|
odata.type |
string:
Microsoft. |
указывает тип условий оповещения. |
MetricCriteria
Критерий для фильтрации метрик.
Имя | Тип | Описание |
---|---|---|
criterionType |
string:
Static |
Указывает тип пороговых критериев |
dimensions |
Список условий измерения. |
|
metricName |
string |
Имя метрики. |
metricNamespace |
string |
Пространство имен метрики. |
name |
string |
Имя условия. |
operator |
оператор условий. |
|
skipMetricValidation |
boolean |
Это позволяет создать правило генерации оповещений для пользовательской метрики, которая еще не создана, настроив пропуск проверки этой метрики. |
threshold |
number |
пороговое значение условия, которое активирует оповещение. |
timeAggregation |
типы агрегирования времени условий. |
MetricDimension
Задает измерение метрики.
Имя | Тип | Описание |
---|---|---|
name |
string |
Имя измерения. |
operator |
string |
оператор измерения. Поддерживаются только "Include" и "Exclude" |
values |
string[] |
список значений измерений. |
Operator
оператор условий.
Имя | Тип | Описание |
---|---|---|
Equals |
string |
|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
WebtestLocationAvailabilityCriteria
Задает критерии правила генерации оповещений метрики для ресурса веб-теста.
Имя | Тип | Описание |
---|---|---|
componentId |
string |
Идентификатор ресурса Application Insights. |
failedLocationCount |
number |
Количество неудачных расположений. |
odata.type |
string:
Microsoft. |
указывает тип условий оповещения. |
webTestId |
string |
Идентификатор веб-теста Application Insights. |