Scheduled Query Rules - Get

Служба:: Monitor

Версия API:: 2018-04-16

Возвращает правило поиска по журналам

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}?api-version=2018-04-16

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
ruleName	path	True	string	Имя правила.
subscriptionId	path	True	string minLength: 1	Идентификатор целевой подписки.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	LogSearchRuleResource	Успешный запрос для получения правила поиска по журналам
Other Status Codes	ErrorContract	Ответ на ошибку, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 Azure Active Directory

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

Области

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

Примеры

Get rule

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

HTTP

GET https://management.azure.com/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourcegroups/Rac46PostSwapRG/providers/Microsoft.Insights/scheduledQueryRules/logalertfoo?api-version=2018-04-16

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

Код состояния:: 200

{
  "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/scheduledQueryRules/logalertfoo",
  "name": "logalertfoo",
  "type": "Microsoft.Insights/scheduledQueryRules",
  "location": "West US",
  "tags": {},
  "properties": {
    "description": "log alert description",
    "enabled": "true",
    "lastUpdatedTime": "2017-06-23T21:23:52.0221265Z",
    "provisioningState": "Succeeded",
    "source": {
      "query": "requests",
      "queryType": "ResultCount",
      "dataSourceId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/components/sampleAI"
    },
    "schedule": {
      "frequencyInMinutes": 15,
      "timeWindowInMinutes": 15
    },
    "action": {
      "odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction",
      "severity": "1",
      "trigger": {
        "thresholdOperator": "GreaterThan",
        "threshold": 3
      },
      "aznsAction": {
        "actionGroup": [],
        "emailSubject": "Email Header",
        "customWebhookPayload": "{}"
      }
    }
  }
}

Определения

Имя	Описание
AlertingAction	Укажите действие, которое необходимо предпринять, если тип правила — Оповещение
AlertSeverity	Уровень серьезности оповещения
AzNsActionGroup	Группа действий Azure
ConditionalOperator	Критерии оценки условия результата.
Criteria	Указывает критерии преобразования журнала в метрики.
Dimension	Указывает критерии преобразования журнала в метрики.
enabled	Флаг, указывающий, включено ли правило поиска по журналам. Значение должно иметь значение true или false
ErrorContract	Описывает формат ответа на ошибку.
ErrorResponse	Описывает формат ответа на ошибку.
LogMetricTrigger	Дескриптор дескриптора метрик журнала.
LogSearchRuleResource	Ресурс правила поиска по журналам.
LogToMetricAction	Укажите действие, которое необходимо предпринять, если тип правила преобразует журнал в метрики
metricTriggerType	Тип триггера метрик : "Последовательный" или "Итог"
operator	Оператор для значений измерения
provisioningState	Состояние подготовки правила запланированного запроса
QueryType	Задайте для параметра ResultAccount значение "ResultAccount"
Schedule	Определяет частоту выполнения поиска и интервала времени.
Source	Указывает запрос поиска по журналам.
TriggerCondition	Условие, которое приводит к правилу поиска по журналам.

AlertingAction

Объект

Укажите действие, которое необходимо предпринять, если тип правила — Оповещение

Имя	Тип	Описание
aznsAction	AzNsActionGroup	Справочник по группе действий Azure.
odata.type	string: Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction	Указывает действие. Поддерживаемые значения: AlertingAction, LogToMetricAction
severity	AlertSeverity	Серьезность оповещения
throttlingInMin	integer (int32)	время (в минутах), для которого должны регулироваться оповещения или подавляться.
trigger	TriggerCondition	Условие триггера, которое приводит к возникновению правила генерации оповещений.

AlertSeverity

Перечисление

Уровень серьезности оповещения

Значение	Описание
0
1
2
3
4

AzNsActionGroup

Объект

Группа действий Azure

Имя	Тип	Описание
actionGroup	string[]	Справочник по группе действий Azure.
customWebhookPayload	string	Пользовательские полезные данные для отправки всех универсальных кодов ресурса (URI) веб-перехватчика в группе действий Azure
emailSubject	string	Переопределение настраиваемого субъекта для всех идентификаторов электронной почты в группе действий Azure

ConditionalOperator

Перечисление

Критерии оценки условия результата.

Значение	Описание
GreaterThanOrEqual
LessThanOrEqual
GreaterThan
LessThan
Equal

Criteria

Объект

Указывает критерии преобразования журнала в метрики.

Имя	Тип	Описание
dimensions	Dimension[]	Список измерений для создания метрик
metricName	string	Имя метрики

Dimension

Объект

Указывает критерии преобразования журнала в метрики.

Имя	Тип	Описание
name	string	Имя измерения
operator	operator	Оператор для значений измерения
values	string[]	Список значений измерения

enabled

Перечисление

Флаг, указывающий, включено ли правило поиска по журналам. Значение должно иметь значение true или false

Значение	Описание
true
false

ErrorContract

Объект

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

Имя	Тип	Описание
error	ErrorResponse	Сведения об ошибке.

ErrorResponse

Объект

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

Имя	Тип	Описание
code	string	Код ошибки
message	string	Сообщение об ошибке, указывающее, почему операция завершилась ошибкой.

LogMetricTrigger

Объект

Дескриптор дескриптора метрик журнала.

Имя	Тип	Default value	Описание
metricColumn	string		Оценка метрик для определенного столбца
metricTriggerType	metricTriggerType	Consecutive	Тип триггера метрик : "Последовательный" или "Итог"
threshold	number (double)		Пороговое значение триггера метрик.
thresholdOperator	ConditionalOperator	GreaterThanOrEqual	Операция оценки для метрики -'GreaterThan' или "LessThan" или "Equal".

LogSearchRuleResource

Объект

Ресурс правила поиска по журналам.

Имя	Тип	Default value	Описание
etag	string		Поле etag не требуется. Если он указан в тексте ответа, он также должен быть предоставлен в качестве заголовка для обычного соглашения etag. Теги сущностей используются для сравнения двух или нескольких сущностей из одного запрошенного ресурса. HTTP/1.1 использует теги сущностей в etag (раздел 14.19), If-Match (раздел 14.24), If-None-Match (раздел 14.26) и If-Range (раздел 14.27).
id	string		Идентификатор ресурса Azure
kind	string		Метаданные, используемые порталом или инструментом/т. д., для отображения различных интерфейсов взаимодействия с ресурсами одного типа; Например, ApiApps — это тип Microsoft.Web/sites. При поддержке поставщик ресурсов должен проверить и сохранить это значение.
location	string		Расположение ресурса
name	string		Имя ресурса Azure
properties.action	Action: AlertingAction LogToMetricAction		Необходимо принять меры по выполнению правила.
properties.autoMitigate	boolean	False	Флаг, указывающий, следует ли автоматически разрешать оповещение. Значение по умолчанию — false.
properties.createdWithApiVersion	string		Версия API, используемая при создании этого правила генерации оповещений
properties.description	string		Описание правила поиска по журналам.
properties.displayName	string		Отображаемое имя правила генерации оповещений
properties.enabled	enabled		Флаг, указывающий, включено ли правило поиска по журналам. Значение должно иметь значение true или false
properties.isLegacyLogAnalyticsRule	boolean		Значение true, если правило генерации оповещений является устаревшим правилом Log Analytic
properties.lastUpdatedTime	string (date-time)		При последнем обновлении правила в IS08601 формате.
properties.provisioningState	provisioningState		Состояние подготовки правила запланированного запроса
properties.schedule	Schedule		Расписание (частота, временное окно) для правила. Требуется для типа действия — AlertingAction
properties.source	Source		Источник данных, в отношении которого правило будет запрашивать данные
tags	object		Теги ресурсов
type	string		Тип ресурса Azure

LogToMetricAction

Объект

Укажите действие, которое необходимо предпринять, если тип правила преобразует журнал в метрики

Имя	Тип	Описание
criteria	Criteria[]	Критерии метрики
odata.type	string: Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction	Указывает действие. Поддерживаемые значения: AlertingAction, LogToMetricAction

metricTriggerType

Перечисление

Тип триггера метрик : "Последовательный" или "Итог"

Значение	Описание
Consecutive
Total

operator

Перечисление

Оператор для значений измерения

Значение	Описание
Include

provisioningState

Перечисление

Состояние подготовки правила запланированного запроса

Значение	Описание
Succeeded
Deploying
Canceled
Failed

QueryType

Перечисление

Задайте для параметра ResultAccount значение "ResultAccount"

Значение	Описание
ResultCount

Schedule

Объект

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

Имя	Тип	Описание
frequencyInMinutes	integer (int32)	частота (в минутах), с которой должно оцениваться условие правила.
timeWindowInMinutes	integer (int32)	Период времени, для которого данные должны быть возвращены для запроса (должно быть больше или равно частотеInMinutes).

Source

Объект

Указывает запрос поиска по журналам.

Имя	Тип	Описание
authorizedResources	string[]	Список ресурсов, на который ссылается запрос
dataSourceId	string	URI ресурса, по которому выполняется запрос поиска по журналам.
query	string	Запрос поиска по журналам. Требуется для типа действия — AlertingAction
queryType	QueryType	Задайте для параметра ResultCount значение .

TriggerCondition

Объект

Условие, которое приводит к правилу поиска по журналам.

Имя	Тип	Default value	Описание
metricTrigger	LogMetricTrigger		Условие триггера для правила запроса метрик
threshold	number (double)		Пороговое значение результата или подсчета в зависимости от того, какое правило следует активировать.
thresholdOperator	ConditionalOperator	GreaterThanOrEqual	Операция оценки для правила — "GreaterThan" или "LessThan".