Metric Alerts - List By Resource Group

  • Ссылка
Service:
Monitor
API Version:
2018-03-01

Получение определений правил генерации оповещений в группе ресурсов.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts?api-version=2018-03-01

Параметры URI

Имя В Обязательно Тип Описание
resourceGroupName
 path True

string

Имя группы ресурсов. Регистр букв в имени не учитывается.
subscriptionId
 path True

string

Идентификатор целевой подписки.
api-version
 query True

string

Версия API, используемая для данной операции.

Ответы

Имя Тип Описание
200 OK

MetricAlertResourceCollection

Успешный запрос списка оповещений метрик
Other Status Codes

ErrorResponse

BadRequest

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

List metric alert rules

Sample Request

GET https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Insights/metricAlerts?api-version=2018-03-01

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/highcpu",
      "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": "CustomMetric_\\Processor(_Total)\\% Processor Time",
              "dimensions": [],
              "operator": "GreaterThan",
              "threshold": 80.5,
              "timeAggregation": "Average"
            }
          ]
        },
        "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/mediumcpu",
      "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": "Med cpu alert",
        "severity": 4,
        "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": "Medium_CPU_50",
              "metricName": "CustomMetric_\\Processor(_Total)\\% Processor Time",
              "dimensions": [],
              "operator": "GreaterThan",
              "threshold": 50.5,
              "timeAggregation": "Average"
            }
          ]
        },
        "actions": [
          {
            "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
            "webHookProperties": {
              "key11": "value11",
              "key12": "value12"
            }
          }
        ]
      }
    }
  ]
}

Определения

Имя Описание
AggregationTypeEnum

Типы агрегирования времени условий.
DynamicMetricCriteria

Критерий динамического порога.
DynamicThresholdFailingPeriods

Минимальное количество нарушений, необходимых в течение выбранного периода времени обратного просмотра, необходимого для создания оповещения.
DynamicThresholdOperator

Оператор, используемый для сравнения значения метрики с пороговым значением.
DynamicThresholdSensitivity

Степень отклонения, необходимая для активации оповещения. Это повлияет на то, насколько жесткое пороговое значение для шаблона рядов метрик.
ErrorResponse

Описывает формат ответа об ошибке.
MetricAlertAction

Действие оповещения.
MetricAlertMultipleResourceMultipleMetricCriteria

Указывает критерии генерации оповещений метрик для нескольких ресурсов, которые имеют несколько критериев метрики.
MetricAlertResource

Ресурс оповещения метрики.
MetricAlertResourceCollection

Представляет коллекцию ресурсов правил генерации оповещений.
MetricAlertSingleResourceMultipleMetricCriteria

Задает критерии оповещения о метриках для одного ресурса с несколькими критериями метрики.
MetricCriteria

Критерий для фильтрации метрик.
MetricDimension

Задает измерение метрики.
Operator

оператор условия.
WebtestLocationAvailabilityCriteria

Задает критерии правила генерации оповещений метрик для ресурса веб-теста.

AggregationTypeEnum

Типы агрегирования времени условий.

Имя Тип Описание
Average

string

Count

string

Maximum

string

Minimum

string

Total

string

DynamicMetricCriteria

Критерий динамического порога.

Имя Тип Описание
alertSensitivity

DynamicThresholdSensitivity

Степень отклонения, необходимая для активации оповещения. Это повлияет на то, насколько жесткое пороговое значение для шаблона рядов метрик.
criterionType string:

DynamicThresholdCriterion

Указывает тип пороговых условий.
dimensions

MetricDimension[]

Список условий измерения.
failingPeriods

DynamicThresholdFailingPeriods

Минимальное количество нарушений, необходимых в течение выбранного периода времени обратного просмотра, необходимого для создания оповещения.
ignoreDataBefore

string

Используйте этот параметр, чтобы задать дату, с которой следует начать изучение исторических данных метрик, и вычислить динамические пороговые значения (в ISO8601 формате).
metricName

string

Имя метрики.
metricNamespace

string

Пространство имен метрики.
name

string

Имя условия.
operator

DynamicThresholdOperator

Оператор, используемый для сравнения значения метрики с пороговым значением.
skipMetricValidation

boolean

Это позволяет создать правило генерации оповещений для пользовательской метрики, которая еще не создана, настроив пропуск проверки этой метрики.
timeAggregation

AggregationTypeEnum

Типы агрегирования времени условий.

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.Azure.Monitor.MultipleResourceMultipleMetricCriteria

указывает тип условия оповещения.

MetricAlertResource

Ресурс оповещения метрики.

Имя Тип Описание
id

string

Идентификатор ресурса Azure
location

string

Расположение ресурса
name

string

Имя ресурса Azure
properties.actions

MetricAlertAction[]

массив действий, выполняемых при активации правила генерации оповещений и при разрешении условия оповещения.
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

MetricAlertResourceCollection

Представляет коллекцию ресурсов правил генерации оповещений.

Имя Тип Описание
value

MetricAlertResource[]

значения для ресурсов правила генерации оповещений.

MetricAlertSingleResourceMultipleMetricCriteria

Задает критерии оповещения о метриках для одного ресурса с несколькими критериями метрики.

Имя Тип Описание
allOf

MetricCriteria[]

Список критериев метрик для этой операции "все".
odata.type string:

Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria

указывает тип условия оповещения.

MetricCriteria

Критерий для фильтрации метрик.

Имя Тип Описание
criterionType string:

StaticThresholdCriterion

Указывает тип пороговых условий.
dimensions

MetricDimension[]

Список условий измерения.
metricName

string

Имя метрики.
metricNamespace

string

Пространство имен метрики.
name

string

Имя условия.
operator

Operator

оператор условия.
skipMetricValidation

boolean

Это позволяет создать правило генерации оповещений для пользовательской метрики, которая еще не создана, настроив пропуск проверки этой метрики.
threshold

number

пороговое значение условия, которое активирует оповещение.
timeAggregation

AggregationTypeEnum

Типы агрегирования времени условий.

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.Azure.Monitor.WebtestLocationAvailabilityCriteria

указывает тип условия оповещения.
webTestId

string

Идентификатор веб-теста Application Insights.