Scheduled Query Rules - Create Or Update
Создает или обновляет правило поиска по журналам.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}?api-version=2018-04-16
Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Имя группы ресурсов. Имя не учитывает регистр. |
|
rule
|
path | True |
string |
Имя правила. |
|
subscription
|
path | True |
string minLength: 1 |
Идентификатор целевой подписки. |
|
api-version
|
query | True |
string minLength: 1 |
Версия API, используемая для этой операции. |
Текст запроса
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| location | True |
string |
Расположение ресурса |
| properties.action | True | Action: |
Необходимо принять меры по выполнению правила. |
| properties.source | True |
Источник данных, в отношении которого правило будет запрашивать данные |
|
| properties.autoMitigate |
boolean |
Флаг, указывающий, следует ли автоматически разрешать оповещение. Значение по умолчанию — false. |
|
| properties.description |
string |
Описание правила поиска по журналам. |
|
| properties.displayName |
string |
Отображаемое имя правила генерации оповещений |
|
| properties.enabled |
Флаг, указывающий, включено ли правило поиска по журналам. Значение должно иметь значение true или false |
||
| properties.schedule |
Расписание (частота, временное окно) для правила. Требуется для типа действия — AlertingAction |
||
| tags |
object |
Теги ресурсов |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
Успешный запрос на обновление правила поиска по журналам |
|
| 201 Created |
Созданное правило генерации оповещени |
|
| Other Status Codes |
Ответ на ошибку, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 Azure Active Directory
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
| Имя | Описание |
|---|---|
| user_impersonation | олицетворения учетной записи пользователя |
Примеры
|
Create or Update rule - Alerting |
|
Create or Update rule - Alerting |
|
Create or Update rule - Log |
Create or Update rule - AlertingAction
Образец запроса
PUT https://management.azure.com/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourcegroups/Rac46PostSwapRG/providers/Microsoft.Insights/scheduledQueryRules/logalertfoo?api-version=2018-04-16
{
"location": "eastus",
"tags": {},
"properties": {
"description": "log alert description",
"enabled": "true",
"source": {
"query": "Heartbeat | summarize AggregatedValue = count() by bin(TimeGenerated, 5m)",
"dataSourceId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.OperationalInsights/workspaces/sampleWorkspace",
"queryType": "ResultCount"
},
"schedule": {
"frequencyInMinutes": 15,
"timeWindowInMinutes": 15
},
"action": {
"odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction",
"severity": "1",
"aznsAction": {
"actionGroup": [],
"emailSubject": "Email Header",
"customWebhookPayload": "{}"
},
"trigger": {
"thresholdOperator": "GreaterThan",
"threshold": 3,
"metricTrigger": {
"thresholdOperator": "GreaterThan",
"threshold": 5,
"metricTriggerType": "Consecutive",
"metricColumn": "Computer"
}
}
}
}
}
Пример ответа
{
"id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/scheduledQueryRules/logalertfoo",
"name": "logalertfoo",
"type": "Microsoft.Insights/scheduledQueryRules",
"location": "eastus",
"tags": {},
"properties": {
"description": "log alert description",
"enabled": "true",
"lastUpdatedTime": "2017-06-23T21:23:52.0221265Z",
"provisioningState": "Succeeded",
"source": {
"query": "Heartbeat | summarize AggregatedValue = count() by bin(TimeGenerated, 5m)",
"dataSourceId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.OperationalInsights/workspaces/sampleWorkspace",
"queryType": "ResultCount"
},
"schedule": {
"frequencyInMinutes": 15,
"timeWindowInMinutes": 15
},
"action": {
"odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction",
"severity": "1",
"aznsAction": {
"actionGroup": [],
"emailSubject": "Email Header",
"customWebhookPayload": "{}"
},
"trigger": {
"thresholdOperator": "GreaterThan",
"threshold": 3,
"metricTrigger": {
"thresholdOperator": "GreaterThan",
"threshold": 5,
"metricTriggerType": "Consecutive",
"metricColumn": "Computer"
}
}
}
}
}
{
"id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/scheduledQueryRules/logalertfoo",
"name": "logalertfoo",
"type": "Microsoft.Insights/scheduledQueryRules",
"location": "eastus",
"tags": {},
"properties": {
"description": "log alert description",
"enabled": "true",
"lastUpdatedTime": "2017-06-23T21:23:52.0221265Z",
"provisioningState": "Succeeded",
"source": {
"query": "Heartbeat",
"queryType": "ResultCount",
"dataSourceId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.OperationalInsights/workspaces/sampleWorkspace"
},
"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": "{}"
}
}
}
}
Create or Update rule - AlertingAction with Cross-Resource
Образец запроса
PUT https://management.azure.com/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourcegroups/Rac46PostSwapRG/providers/Microsoft.Insights/scheduledQueryRules/SampleCrossResourceAlert?api-version=2018-04-16
{
"location": "eastus",
"tags": {},
"properties": {
"description": "Sample Cross Resource alert",
"enabled": "true",
"source": {
"query": "union requests, workspace(\"sampleWorkspace\").Update",
"authorizedResources": [
"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.OperationalInsights/workspaces/sampleWorkspace",
"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/components/sampleAI"
],
"dataSourceId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/components/sampleAI",
"queryType": "ResultCount"
},
"schedule": {
"frequencyInMinutes": 60,
"timeWindowInMinutes": 60
},
"action": {
"severity": "3",
"aznsAction": {
"actionGroup": [
"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/actiongroups/test-ag"
],
"emailSubject": "Cross Resource Mail!!"
},
"trigger": {
"thresholdOperator": "GreaterThan",
"threshold": 5000
},
"odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction"
}
}
}
Пример ответа
{
"id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/scheduledQueryRules/SampleCrossResourceAlert",
"name": "SampleCrossResourceAlert",
"type": "Microsoft.Insights/scheduledQueryRules",
"location": "eastus",
"tags": {},
"properties": {
"description": "Sample Cross Resource alert",
"enabled": "true",
"lastUpdatedTime": "2018-09-04T06:27:58.3892575Z",
"provisioningState": "Succeeded",
"source": {
"query": "union requests, workspace(\"sampleWorkspace\").Update",
"authorizedResources": [
"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.OperationalInsights/workspaces/sampleWorkspace",
"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/components/sampleAI"
],
"dataSourceId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/components/sampleAI",
"queryType": "ResultCount"
},
"schedule": {
"frequencyInMinutes": 60,
"timeWindowInMinutes": 60
},
"action": {
"severity": "3",
"aznsAction": {
"actionGroup": [
"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/actiongroups/test-ag"
],
"emailSubject": "Cross Resource Mail!!"
},
"trigger": {
"thresholdOperator": "GreaterThan",
"threshold": 5000
},
"odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction"
}
}
}
{
"id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/scheduledQueryRules/SampleCrossResourceAlert",
"name": "SampleCrossResourceAlert",
"type": "Microsoft.Insights/scheduledQueryRules",
"location": "eastus",
"tags": {},
"properties": {
"description": "Sample Cross Resource alert",
"enabled": "true",
"lastUpdatedTime": "2018-09-04T06:27:58.3892575Z",
"provisioningState": "Succeeded",
"source": {
"query": "union requests, workspace(\"sampleWorkspace\").Update",
"authorizedResources": [
"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.OperationalInsights/workspaces/sampleWorkspace",
"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/components/sampleAI"
],
"dataSourceId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/components/sampleAI",
"queryType": "ResultCount"
},
"schedule": {
"frequencyInMinutes": 60,
"timeWindowInMinutes": 60
},
"action": {
"severity": "3",
"aznsAction": {
"actionGroup": [
"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/actiongroups/test-ag"
],
"emailSubject": "Cross Resource Mail!!"
},
"trigger": {
"thresholdOperator": "GreaterThan",
"threshold": 5000
},
"odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction"
}
}
}
Create or Update rule - LogToMetricAction
Образец запроса
PUT https://management.azure.com/subscriptions/af52d502-a447-4bc6-8cb7-4780fbb00490/resourcegroups/alertsweu/providers/Microsoft.Insights/scheduledQueryRules/logtometricfoo?api-version=2018-04-16
{
"location": "West Europe",
"tags": {},
"properties": {
"description": "log to metric description",
"enabled": "true",
"source": {
"dataSourceId": "/subscriptions/af52d502-a447-4bc6-8cb7-4780fbb00490/resourceGroups/alertsweu/providers/Microsoft.OperationalInsights/workspaces/alertsweu"
},
"action": {
"criteria": [
{
"metricName": "Average_% Idle Time",
"dimensions": []
}
],
"odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction"
}
}
}
Пример ответа
{
"id": "/subscriptions/af52d502-a447-4bc6-8cb7-4780fbb00490/resourceGroups/alertsweu/providers/microsoft.insights/scheduledqueryrules/logtometricfoo",
"name": "logtometricfoo",
"type": "microsoft.insights/scheduledqueryrules",
"location": "westeurope",
"tags": {},
"properties": {
"description": "log to metric description",
"displayName": "logtometricfoo",
"enabled": "true",
"lastUpdatedTime": "2018-09-04T06:31:56.3737792Z",
"provisioningState": "Succeeded",
"source": {
"query": null,
"dataSourceId": "/subscriptions/af52d502-a447-4bc6-8cb7-4780fbb00490/resourceGroups/alertsweu/providers/Microsoft.OperationalInsights/workspaces/alertsweu"
},
"schedule": null,
"action": {
"criteria": [
{
"metricName": "Average_% Idle Time",
"dimensions": []
}
],
"odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction"
}
}
}
{
"id": "/subscriptions/af52d502-a447-4bc6-8cb7-4780fbb00490/resourceGroups/alertsweu/providers/microsoft.insights/scheduledqueryrules/logtometricfoo",
"name": "logtometricfoo",
"type": "microsoft.insights/scheduledqueryrules",
"location": "westeurope",
"tags": {},
"properties": {
"description": "log to metric description",
"enabled": "true",
"lastUpdatedTime": "2018-09-04T06:27:58.3892575Z",
"provisioningState": "Succeeded",
"source": {
"query": null,
"dataSourceId": "/subscriptions/af52d502-a447-4bc6-8cb7-4780fbb00490/resourceGroups/alertsweu/providers/Microsoft.OperationalInsights/workspaces/alertsweu"
},
"schedule": null,
"action": {
"criteria": [
{
"metricName": "Average_% Idle Time",
"dimensions": []
}
],
"odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction"
}
}
}
Определения
| Имя | Описание |
|---|---|
|
Alerting |
Укажите действие, которое необходимо предпринять, если тип правила — Оповещение |
|
Alert |
Уровень серьезности оповещения |
|
Az |
Группа действий Azure |
|
Conditional |
Критерии оценки условия результата. |
| Criteria |
Указывает критерии преобразования журнала в метрики. |
| Dimension |
Указывает критерии преобразования журнала в метрики. |
| enabled |
Флаг, указывающий, включено ли правило поиска по журналам. Значение должно иметь значение true или false |
|
Error |
Описывает формат ответа на ошибку. |
|
Error |
Описывает формат ответа на ошибку. |
|
Log |
Дескриптор дескриптора метрик журнала. |
|
Log |
Ресурс правила поиска по журналам. |
|
Log |
Укажите действие, которое необходимо предпринять, если тип правила преобразует журнал в метрики |
|
metric |
Тип триггера метрик : "Последовательный" или "Итог" |
| operator |
Оператор для значений измерения |
|
provisioning |
Состояние подготовки правила запланированного запроса |
|
Query |
Задайте для параметра ResultAccount значение "ResultAccount" |
| Schedule |
Определяет частоту выполнения поиска и интервала времени. |
| Source |
Указывает запрос поиска по журналам. |
|
Trigger |
Условие, которое приводит к правилу поиска по журналам. |
AlertingAction
Укажите действие, которое необходимо предпринять, если тип правила — Оповещение
| Имя | Тип | Описание |
|---|---|---|
| aznsAction |
Справочник по группе действий Azure. |
|
| odata.type |
string:
Microsoft. |
Указывает действие. Поддерживаемые значения: AlertingAction, LogToMetricAction |
| severity |
Серьезность оповещения |
|
| throttlingInMin |
integer (int32) |
время (в минутах), для которого должны регулироваться оповещения или подавляться. |
| trigger |
Условие триггера, которое приводит к возникновению правила генерации оповещений. |
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 |
Список измерений для создания метрик |
|
| metricName |
string |
Имя метрики |
Dimension
Указывает критерии преобразования журнала в метрики.
| Имя | Тип | Описание |
|---|---|---|
| name |
string |
Имя измерения |
| operator |
Оператор для значений измерения |
|
| values |
string[] |
Список значений измерения |
enabled
Флаг, указывающий, включено ли правило поиска по журналам. Значение должно иметь значение true или false
| Значение | Описание |
|---|---|
| true | |
| false |
ErrorContract
Описывает формат ответа на ошибку.
| Имя | Тип | Описание |
|---|---|---|
| error |
Сведения об ошибке. |
ErrorResponse
Описывает формат ответа на ошибку.
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
Код ошибки |
| message |
string |
Сообщение об ошибке, указывающее, почему операция завершилась ошибкой. |
LogMetricTrigger
Дескриптор дескриптора метрик журнала.
| Имя | Тип | Default value | Описание |
|---|---|---|---|
| metricColumn |
string |
Оценка метрик для определенного столбца |
|
| metricTriggerType | Consecutive |
Тип триггера метрик : "Последовательный" или "Итог" |
|
| threshold |
number (double) |
Пороговое значение триггера метрик. |
|
| thresholdOperator | 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: |
Необходимо принять меры по выполнению правила. |
|
| properties.autoMitigate |
boolean |
False |
Флаг, указывающий, следует ли автоматически разрешать оповещение. Значение по умолчанию — false. |
| properties.createdWithApiVersion |
string |
Версия API, используемая при создании этого правила генерации оповещений |
|
| properties.description |
string |
Описание правила поиска по журналам. |
|
| properties.displayName |
string |
Отображаемое имя правила генерации оповещений |
|
| properties.enabled |
Флаг, указывающий, включено ли правило поиска по журналам. Значение должно иметь значение true или false |
||
| properties.isLegacyLogAnalyticsRule |
boolean |
Значение true, если правило генерации оповещений является устаревшим правилом Log Analytic |
|
| properties.lastUpdatedTime |
string (date-time) |
При последнем обновлении правила в IS08601 формате. |
|
| properties.provisioningState |
Состояние подготовки правила запланированного запроса |
||
| properties.schedule |
Расписание (частота, временное окно) для правила. Требуется для типа действия — AlertingAction |
||
| properties.source |
Источник данных, в отношении которого правило будет запрашивать данные |
||
| tags |
object |
Теги ресурсов |
|
| type |
string |
Тип ресурса Azure |
LogToMetricAction
Укажите действие, которое необходимо предпринять, если тип правила преобразует журнал в метрики
| Имя | Тип | Описание |
|---|---|---|
| criteria |
Criteria[] |
Критерии метрики |
| odata.type |
string:
Microsoft. |
Указывает действие. Поддерживаемые значения: 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 |
Задайте для параметра ResultCount значение . |
TriggerCondition
Условие, которое приводит к правилу поиска по журналам.
| Имя | Тип | Default value | Описание |
|---|---|---|---|
| metricTrigger |
Условие триггера для правила запроса метрик |
||
| threshold |
number (double) |
Пороговое значение результата или подсчета в зависимости от того, какое правило следует активировать. |
|
| thresholdOperator | GreaterThanOrEqual |
Операция оценки для правила — "GreaterThan" или "LessThan". |