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


Alert Rules - Get

Возвращает классическое правило генерации оповещений метрик.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/alertrules/{ruleName}?api-version=2016-03-01

Параметры URI

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

string

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

ruleName
path True

string

Имя правила.

subscriptionId
path True

string

Идентификатор целевой подписки.

api-version
query True

string

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

Ответы

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

AlertRuleResource

Успешный запрос на получение правила генерации оповещений

Other Status Codes

ErrorResponse

Ответ об ошибке, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 в Azure Active Directory

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

Области

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

Примеры

Get an alert rule

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

GET https://management.azure.com/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourcegroups/Rac46PostSwapRG/providers/Microsoft.Insights/alertrules/chiricutin?api-version=2016-03-01

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

{
  "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/chiricutin",
  "name": "chiricutin",
  "type": "Microsoft.Insights/alertRules",
  "location": "West US",
  "tags": {
    "$type": "Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage",
    "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
  },
  "properties": {
    "name": "chiricutin",
    "description": "Pura Vida",
    "isEnabled": true,
    "condition": {
      "odata.type": "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition",
      "dataSource": {
        "odata.type": "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource",
        "resourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest",
        "metricName": "Requests"
      },
      "operator": "GreaterThan",
      "threshold": 3,
      "windowSize": "PT5M",
      "timeAggregation": "Total"
    },
    "lastUpdatedTime": "2016-11-23T21:23:52.0221265Z",
    "actions": []
  }
}

Определения

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

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

ConditionOperator

Операторы, разрешенные в условии правила.

ErrorResponse

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

LocationThresholdRuleCondition

Условие правила, основанное на определенном количестве расположений, при которых произошел сбой.

ManagementEventAggregationCondition

Порядок объединения данных, собранных за определенный период.

ManagementEventRuleCondition

Условие правила события управления.

RuleEmailAction

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

RuleManagementEventClaimsDataSource

Утверждения для источника данных события управления правилами.

RuleManagementEventDataSource

Источник данных события управления правилами. В этом случае дискриминатор всегда имеет значение RuleManagementEventDataSource.

RuleMetricDataSource

Источник данных метрик правила. В этом случае дискриминатор всегда имеет значение RuleMetricDataSource.

RuleWebhookAction

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

ThresholdRuleCondition

Условие правила, основанное на пересечении порогового значения метрики.

TimeAggregationOperator

Операторы агрегирования, разрешенные в правиле.

AlertRuleResource

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

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

string

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

location

string

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

name

string

Имя ресурса Azure

properties.action RuleAction:

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

properties.actions RuleAction[]:

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

properties.condition RuleCondition:

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

properties.description

string

описание правила генерации оповещений, которое будет включено в оповещение по электронной почте.

properties.isEnabled

boolean

флаг, указывающий, включено ли правило генерации оповещений.

properties.lastUpdatedTime

string

Время последнего обновления правила в формате ISO8601.

properties.name

string

имя правила генерации оповещений.

properties.provisioningState

string

состояние подготовки.

tags

object

Теги ресурсов

type

string

Тип ресурса Azure

ConditionOperator

Операторы, разрешенные в условии правила.

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

string

GreaterThanOrEqual

string

LessThan

string

LessThanOrEqual

string

ErrorResponse

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

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

string

Код ошибки

message

string

Сообщение об ошибке, указывающее, почему операция завершилась сбоем.

LocationThresholdRuleCondition

Условие правила, основанное на определенном количестве расположений, при которых произошел сбой.

Имя Тип Описание
dataSource RuleDataSource:

ресурс, из которого правило собирает свои данные. Для этого типа dataSource всегда будет иметь тип RuleMetricDataSource.

failedLocationCount

integer

количество расположений, которые не должны активировать оповещение.

odata.type string:

Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition

указывает тип условия. Это может быть один из трех типов: ManagementEventRuleCondition (вхождения событий управления), LocationThresholdRuleCondition (на основе количества сбоев веб-теста) и ThresholdRuleCondition (на основе порогового значения метрики).

windowSize

string

период времени (в формате длительности ISO 8601), который используется для мониторинга действий оповещений на основе порогового значения. Если этот параметр указан, он должен находиться в диапазоне от 5 минут до 1 дня.

ManagementEventAggregationCondition

Порядок объединения данных, собранных за определенный период.

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

ConditionOperator

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

threshold

number

Пороговое значение, которое активирует оповещение.

windowSize

string

период времени (в формате длительности ISO 8601), который используется для мониторинга действий оповещений на основе порогового значения. Если этот параметр указан, он должен находиться в диапазоне от 5 минут до 1 дня.

ManagementEventRuleCondition

Условие правила события управления.

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

ManagementEventAggregationCondition

Как собираемые данные должны объединяться с течением времени и когда будет активировано оповещение. Примечание. Агрегирование оповещений событий управления не обязательно. Если оно не выполняется, любое событие будет вызывать активацию оповещений.

dataSource RuleDataSource:

ресурс, из которого правило собирает свои данные. Для этого типа dataSource всегда будет иметь тип RuleMetricDataSource.

odata.type string:

Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition

указывает тип условия. Это может быть один из трех типов: ManagementEventRuleCondition (вхождения событий управления), LocationThresholdRuleCondition (на основе количества сбоев веб-теста) и ThresholdRuleCondition (на основе порогового значения метрики).

RuleEmailAction

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

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

string[]

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

odata.type string:

Microsoft.Azure.Management.Insights.Models.RuleEmailAction

указывает тип действия. Существует два типа действий: RuleEmailAction и RuleWebhookAction.

sendToServiceOwners

boolean

Следует ли уведомить администраторов (службы и соадминистраторов) об активации оповещения.

RuleManagementEventClaimsDataSource

Утверждения для источника данных события управления правилами.

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

string

адрес электронной почты.

RuleManagementEventDataSource

Источник данных события управления правилами. В этом случае дискриминатор всегда имеет значение RuleManagementEventDataSource.

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

RuleManagementEventClaimsDataSource

утверждения.

eventName

string

имя события.

eventSource

string

источник события.

legacyResourceId

string

устаревший идентификатор ресурса, отслеживаемого правилом. ПРИМЕЧАНИЕ. Это свойство не может быть обновлено для существующего правила.

level

string

уровень .

metricNamespace

string

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

odata.type string:

Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource

указывает тип источника данных. Существует два типа источников данных правил: RuleMetricDataSource и RuleManagementEventDataSource.

operationName

string

Имя операции, которое необходимо проверить. Если имя не указано, будет соответствовать любая операция.

resourceGroupName

string

имя группы ресурсов.

resourceLocation

string

расположение ресурса.

resourceProviderName

string

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

resourceUri

string

идентификатор ресурса, отслеживаемого правилом. ПРИМЕЧАНИЕ. Это свойство не может быть обновлено для существующего правила.

status

string

Состояние операции, которое необходимо проверять. Если состояние не указано, будет соответствовать любое состояние.

subStatus

string

подсостояние.

RuleMetricDataSource

Источник данных метрик правила. В этом случае дискриминатор всегда имеет значение RuleMetricDataSource.

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

string

устаревший идентификатор ресурса, отслеживаемого правилом. ПРИМЕЧАНИЕ. Это свойство не может быть обновлено для существующего правила.

metricName

string

имя метрики, определяющей, что отслеживает правило.

metricNamespace

string

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

odata.type string:

Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource

указывает тип источника данных. Существует два типа источников данных правил: RuleMetricDataSource и RuleManagementEventDataSource.

resourceLocation

string

расположение ресурса.

resourceUri

string

идентификатор ресурса, отслеживаемого правилом. ПРИМЕЧАНИЕ. Это свойство не может быть обновлено для существующего правила.

RuleWebhookAction

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

Имя Тип Описание
odata.type string:

Microsoft.Azure.Management.Insights.Models.RuleWebhookAction

указывает тип действия. Существует два типа действий: RuleEmailAction и RuleWebhookAction.

properties

object

словарь настраиваемых свойств, включаемых в после операции. Эти данные добавляются в полезные данные веб-перехватчика.

serviceUri

string

универсальный код ресурса (URI) службы для отправки уведомления при активации или разрешении оповещения.

ThresholdRuleCondition

Условие правила, основанное на пересечении порогового значения метрики.

Имя Тип Описание
dataSource RuleDataSource:

ресурс, из которого правило собирает свои данные. Для этого типа dataSource всегда будет иметь тип RuleMetricDataSource.

odata.type string:

Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition

указывает тип условия. Это может быть один из трех типов: ManagementEventRuleCondition (вхождения событий управления), LocationThresholdRuleCondition (на основе количества сбоев веб-теста) и ThresholdRuleCondition (на основе порогового значения метрики).

operator

ConditionOperator

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

threshold

number

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

timeAggregation

TimeAggregationOperator

оператор агрегирования времени. Способ объединения собираемых данных с течением времени. Значение по умолчанию — PrimaryAggregationType метрики.

windowSize

string

период времени (в формате длительности ISO 8601), который используется для мониторинга действий оповещений на основе порогового значения. Если этот параметр указан, он должен находиться в диапазоне от 5 минут до 1 дня.

TimeAggregationOperator

Операторы агрегирования, разрешенные в правиле.

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

string

Last

string

Maximum

string

Minimum

string

Total

string