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

Metric Alerts - List By Subscription

  • Ссылка
Служба:
Monitor
Версия API:
2018-03-01

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

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

Параметры URI

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

string

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

string

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

Ответы

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

MetricAlertResourceCollection

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

ErrorResponse

BadRequest

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

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

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

Примеры

List metric alert rules

Образец запроса

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

Пример ответа

Код состояния:
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"
            }
          }
        ]
      }
    }
  ]
}

Определения

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

Массив объектов со свойствами type и info. Схема info зависит от строки типа, зависящей от службы.
AggregationTypeEnum

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

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

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

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

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

Описание сведений об ответе на ошибку.
ErrorResponse

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

Действие генерации оповещений.
MetricAlertMultipleResourceMultipleMetricCriteria

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

Ресурс генерации оповещений метрик.
MetricAlertResourceCollection

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

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

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

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

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

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

AdditionalInfo

Массив объектов со свойствами type и info. Схема info зависит от строки типа, зависящей от службы.

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

object

Дополнительные сведения, относящиеся к типу.
type

string

Тип дополнительных сведений.

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

Количество нарушений для активации оповещения. Должно быть меньше или равно числуOfEvaluationPeriods.
numberOfEvaluationPeriods

number

Количество агрегированных точек обратного просмотра. Окно времени обратного просмотра вычисляется на основе детализации агрегирования (windowSize) и выбранного числа агрегированных точек.

DynamicThresholdOperator

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

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

string

GreaterThan

string

LessThan

string

DynamicThresholdSensitivity

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

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

string

Low

string

Medium

string

Error

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

AdditionalInfo[]

Массив объектов со свойствами type и info. Схема info зависит от строки типа, зависящей от службы.
code

string

Нелокализованная строка, которую можно использовать для программной идентификации ошибки.
details

ErrorDetail[]

Массив дополнительных вложенных объектов сведений об ответе на ошибки, как описано в этом контракте.
message

string

Подробно описывает ошибку и предоставляет сведения об отладке. Если Accept-Language задано в запросе, его необходимо локализовать на этом языке.
target

string

Целевой объект конкретной ошибки (например, имя свойства в ошибке).

ErrorDetail

Описание сведений об ответе на ошибку.

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

AdditionalInfo[]

Массив объектов со свойствами type и info. Схема info зависит от строки типа, зависящей от службы.
code

string

Нелокализованная строка, которую можно использовать для программной идентификации ошибки.
message

string

Подробно описывает ошибку и предоставляет сведения об отладке.
target

string

Целевой объект конкретной ошибки (например, имя свойства в ошибке).

ErrorResponse

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

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

Error

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

оператор измерения. Поддерживаются только "Включить" и "Исключить"
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.