Scheduled Query Rules - Create Or Update
Создает или обновляет запланированное правило запроса.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}?api-version=2021-08-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
resource
|
path | True |
string |
Имя группы ресурсов. Регистр букв в имени не учитывается. |
rule
|
path | True |
string |
Имя правила. |
subscription
|
path | True |
string |
Идентификатор целевой подписки. |
api-version
|
query | True |
string |
Версия API, используемая для данной операции. |
Текст запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
location | True |
string |
Географическое расположение, в котором находится ресурс |
properties.criteria | True |
Критерии правила, определяющие условия правила запланированного запроса. |
|
properties.enabled | True |
boolean |
Флаг, указывающий, включено ли это запланированное правило запроса. Значение должно быть true или false |
properties.scopes | True |
string[] |
Список идентификаторов ресурсов, на которые распространяется это запланированное правило запроса. |
kind |
Указывает тип правила запланированного запроса. Значение по умолчанию — LogAlert. |
||
properties.actions |
Действия для вызова при срабатывании оповещения. |
||
properties.autoMitigate |
boolean |
Флаг, указывающий, следует ли автоматически разрешать оповещение. Значение по умолчанию — true. Применимо только для правил типа LogAlert. |
|
properties.checkWorkspaceAlertsStorageConfigured |
boolean |
Флаг, указывающий, должно ли это запланированное правило запроса храниться в хранилище клиента. Значение по умолчанию — false. Применимо только для правил типа LogAlert. |
|
properties.description |
string |
Описание правила запланированного запроса. |
|
properties.displayName |
string |
Отображаемое имя правила генерации оповещений |
|
properties.evaluationFrequency |
string |
Частота оценки правила запланированного запроса в формате длительности ISO 8601. Применимо и требуется только для правил типа LogAlert. |
|
properties.muteActionsDuration |
string |
Отключение звука для выбранного периода времени (в формате длительности ISO 8601) после срабатывания оповещения. Применимо только для правил типа LogAlert. |
|
properties.overrideQueryTimeRange |
string |
Если указано, переопределяет диапазон времени запроса (по умолчанию — WindowSize*NumberOfEvaluationPeriods). Применимо только для правил типа LogAlert. |
|
properties.severity |
Серьезность оповещения. Должно быть целым числом в диапазоне от [0 до 4]. Значение 0 является самым серьезным. Применимо и требуется только для правил типа LogAlert. |
||
properties.skipQueryValidation |
boolean |
Флаг, указывающий, следует ли проверять предоставленный запрос. Значение по умолчанию — false. Применимо только для правил типа LogAlert. |
|
properties.targetResourceTypes |
string[] |
Список типов ресурсов целевых ресурсов, для которых создается или обновляется оповещение. Например, если область является группой ресурсов, а targetResourceTypes — Microsoft.Compute/virtualMachines, то для каждой виртуальной машины в группе ресурсов будет срабатывает другое оповещение, соответствующее критериям оповещения. Относится только к правилам типа LogAlert |
|
properties.windowSize |
string |
Период времени (в формате длительности ISO 8601), в течение которого будет выполняться запрос оповещения (размер ячейки). Применимо и требуется только для правил типа LogAlert. |
|
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 a scheduled query rule for Single Resource |
Create or update a scheduled query rule on Resource group(s) |
Create or update a scheduled query rule on Subscription |
Create or update a scheduled query rule for Single Resource
Образец запроса
PUT https://management.azure.com/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourceGroups/QueryResourceGroupName/providers/Microsoft.Insights/scheduledQueryRules/perf?api-version=2021-08-01
{
"location": "eastus",
"properties": {
"description": "Performance rule",
"severity": 4,
"enabled": true,
"evaluationFrequency": "PT5M",
"scopes": [
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1/providers/Microsoft.Compute/virtualMachines/vm1"
],
"windowSize": "PT10M",
"criteria": {
"allOf": [
{
"query": "Perf | where ObjectName == \"Processor\"",
"timeAggregation": "Average",
"metricMeasureColumn": "% Processor Time",
"resourceIdColumn": "resourceId",
"dimensions": [
{
"name": "ComputerIp",
"operator": "Exclude",
"values": [
"192.168.1.1"
]
},
{
"name": "OSType",
"operator": "Include",
"values": [
"*"
]
}
],
"operator": "GreaterThan",
"threshold": 70,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
}
}
]
},
"muteActionsDuration": "PT30M",
"actions": {
"actionGroups": [
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
],
"customProperties": {
"key11": "value11",
"key12": "value12"
}
},
"autoMitigate": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
Пример ответа
{
"id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf",
"name": "perf",
"type": "microsoft.insights/scheduledqueryrules",
"location": "eastus",
"tags": {},
"properties": {
"description": "Performance rule",
"severity": 4,
"enabled": true,
"evaluationFrequency": "PT5M",
"scopes": [
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1/providers/Microsoft.Compute/virtualMachines/vm1"
],
"windowSize": "PT10M",
"criteria": {
"allOf": [
{
"query": "Perf | where ObjectName == \"Processor\"",
"timeAggregation": "Average",
"metricMeasureColumn": "% Processor Time",
"resourceIdColumn": "resourceId",
"dimensions": [
{
"name": "ComputerIp",
"operator": "Exclude",
"values": [
"192.168.1.1"
]
},
{
"name": "OSType",
"operator": "Include",
"values": [
"*"
]
}
],
"operator": "GreaterThan",
"threshold": 70,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
}
}
]
},
"muteActionsDuration": "PT30M",
"actions": {
"actionGroups": [
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
],
"customProperties": {
"key11": "value11",
"key12": "value12"
}
},
"autoMitigate": true,
"isWorkspaceAlertsStorageConfigured": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
{
"id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf",
"name": "perf",
"type": "microsoft.insights/scheduledqueryrules",
"location": "eastus",
"tags": {},
"properties": {
"description": "Performance rule",
"severity": 4,
"enabled": true,
"evaluationFrequency": "PT5M",
"scopes": [
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1/providers/Microsoft.Compute/virtualMachines/vm1"
],
"windowSize": "PT10M",
"criteria": {
"allOf": [
{
"query": "Perf | where ObjectName == \"Processor\"",
"timeAggregation": "Average",
"metricMeasureColumn": "% Processor Time",
"resourceIdColumn": "resourceId",
"dimensions": [
{
"name": "ComputerIp",
"operator": "Exclude",
"values": [
"192.168.1.1"
]
},
{
"name": "OSType",
"operator": "Include",
"values": [
"*"
]
}
],
"operator": "GreaterThan",
"threshold": 70,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
}
}
]
},
"muteActionsDuration": "PT30M",
"actions": {
"actionGroups": [
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
],
"customProperties": {
"key11": "value11",
"key12": "value12"
}
},
"autoMitigate": true,
"isWorkspaceAlertsStorageConfigured": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
Create or update a scheduled query rule on Resource group(s)
Образец запроса
PUT https://management.azure.com/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourceGroups/QueryResourceGroupName/providers/Microsoft.Insights/scheduledQueryRules/heartbeat?api-version=2021-08-01
{
"location": "eastus",
"properties": {
"description": "Health check rule",
"severity": 4,
"enabled": true,
"evaluationFrequency": "PT5M",
"scopes": [
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1"
],
"targetResourceTypes": [
"Microsoft.Compute/virtualMachines"
],
"windowSize": "PT10M",
"criteria": {
"allOf": [
{
"query": "Heartbeat",
"timeAggregation": "Count",
"dimensions": [],
"operator": "GreaterThan",
"threshold": 360,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
}
}
]
},
"muteActionsDuration": "PT30M",
"actions": {
"actionGroups": [
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
],
"customProperties": {
"key11": "value11",
"key12": "value12"
}
},
"autoMitigate": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
Пример ответа
{
"id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/heartbeat",
"name": "heartbeat",
"type": "microsoft.insights/scheduledqueryrules",
"location": "eastus",
"tags": {},
"properties": {
"description": "Health check rule",
"severity": 4,
"enabled": true,
"evaluationFrequency": "PT5M",
"scopes": [
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1"
],
"targetResourceTypes": [
"Microsoft.Compute/virtualMachines"
],
"windowSize": "PT10M",
"criteria": {
"allOf": [
{
"query": "Heartbeat",
"timeAggregation": "Count",
"dimensions": [],
"operator": "GreaterThan",
"threshold": 360,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
}
}
]
},
"muteActionsDuration": "PT30M",
"actions": {
"actionGroups": [
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
],
"customProperties": {
"key11": "value11",
"key12": "value12"
}
},
"autoMitigate": true,
"isWorkspaceAlertsStorageConfigured": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
{
"id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/heartbeat",
"name": "heartbeat",
"type": "microsoft.insights/scheduledqueryrules",
"location": "eastus",
"tags": {},
"properties": {
"description": "Health check rule",
"severity": 4,
"enabled": true,
"evaluationFrequency": "PT5M",
"scopes": [
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1"
],
"targetResourceTypes": [
"Microsoft.Compute/virtualMachines"
],
"windowSize": "PT10M",
"criteria": {
"allOf": [
{
"query": "Heartbeat",
"timeAggregation": "Count",
"dimensions": [],
"operator": "GreaterThan",
"threshold": 360,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
}
}
]
},
"muteActionsDuration": "PT30M",
"actions": {
"actionGroups": [
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
],
"customProperties": {
"key11": "value11",
"key12": "value12"
}
},
"autoMitigate": true,
"isWorkspaceAlertsStorageConfigured": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
Create or update a scheduled query rule on Subscription
Образец запроса
PUT https://management.azure.com/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourceGroups/QueryResourceGroupName/providers/Microsoft.Insights/scheduledQueryRules/perf?api-version=2021-08-01
{
"location": "eastus",
"properties": {
"description": "Performance rule",
"severity": 4,
"enabled": true,
"evaluationFrequency": "PT5M",
"scopes": [
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147"
],
"targetResourceTypes": [
"Microsoft.Compute/virtualMachines"
],
"windowSize": "PT10M",
"criteria": {
"allOf": [
{
"query": "Perf | where ObjectName == \"Processor\"",
"timeAggregation": "Average",
"metricMeasureColumn": "% Processor Time",
"resourceIdColumn": "resourceId",
"dimensions": [
{
"name": "ComputerIp",
"operator": "Exclude",
"values": [
"192.168.1.1"
]
},
{
"name": "OSType",
"operator": "Include",
"values": [
"*"
]
}
],
"operator": "GreaterThan",
"threshold": 70,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
}
}
]
},
"muteActionsDuration": "PT30M",
"actions": {
"actionGroups": [
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
],
"customProperties": {
"key11": "value11",
"key12": "value12"
}
},
"autoMitigate": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
Пример ответа
{
"id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf",
"name": "perf",
"type": "microsoft.insights/scheduledqueryrules",
"location": "eastus",
"tags": {},
"properties": {
"description": "Performance rule",
"severity": 4,
"enabled": true,
"evaluationFrequency": "PT5M",
"scopes": [
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147"
],
"targetResourceTypes": [
"Microsoft.Compute/virtualMachines"
],
"windowSize": "PT10M",
"criteria": {
"allOf": [
{
"query": "Perf | where ObjectName == \"Processor\"",
"timeAggregation": "Average",
"metricMeasureColumn": "% Processor Time",
"resourceIdColumn": "resourceId",
"dimensions": [
{
"name": "ComputerIp",
"operator": "Exclude",
"values": [
"192.168.1.1"
]
},
{
"name": "OSType",
"operator": "Include",
"values": [
"*"
]
}
],
"operator": "GreaterThan",
"threshold": 70,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
}
}
]
},
"muteActionsDuration": "PT30M",
"actions": {
"actionGroups": [
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
],
"customProperties": {
"key11": "value11",
"key12": "value12"
}
},
"autoMitigate": true,
"isWorkspaceAlertsStorageConfigured": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
{
"id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf",
"name": "perf",
"type": "microsoft.insights/scheduledqueryrules",
"location": "eastus",
"tags": {},
"properties": {
"description": "Performance rule",
"severity": 4,
"enabled": true,
"evaluationFrequency": "PT5M",
"scopes": [
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147"
],
"targetResourceTypes": [
"Microsoft.Compute/virtualMachines"
],
"windowSize": "PT10M",
"criteria": {
"allOf": [
{
"query": "Perf | where ObjectName == \"Processor\"",
"timeAggregation": "Average",
"metricMeasureColumn": "% Processor Time",
"resourceIdColumn": "resourceId",
"dimensions": [
{
"name": "ComputerIp",
"operator": "Exclude",
"values": [
"192.168.1.1"
]
},
{
"name": "OSType",
"operator": "Include",
"values": [
"*"
]
}
],
"operator": "GreaterThan",
"threshold": 70,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
}
}
]
},
"muteActionsDuration": "PT30M",
"actions": {
"actionGroups": [
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
],
"customProperties": {
"key11": "value11",
"key12": "value12"
}
},
"autoMitigate": true,
"isWorkspaceAlertsStorageConfigured": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
Определения
Имя | Описание |
---|---|
Actions |
Действия для вызова при срабатывании оповещения. |
Alert |
Серьезность оповещения. Должно быть целым числом от [0 до 4]. Значение 0 является самым строгим. Применимо и требуется только для правил типа LogAlert. |
Condition |
Условие правила запланированного запроса. |
condition |
Оператор условия. Применимо и требуется только для правил типа LogAlert. |
created |
Тип удостоверения, создавшего ресурс. |
Dimension |
Определение разделения и фильтрации измерений |
dimension |
Оператор для значений измерений |
Error |
Дополнительные сведения об ошибке управления ресурсами. |
Error |
Описывает формат ответа об ошибке. |
Error |
Сообщение об ошибке |
Failing |
Минимальное количество нарушений, необходимых в течение выбранного периода времени обратного просмотра, необходимого для создания оповещения. Применимо только для правил типа LogAlert. |
Kind |
Указывает тип правила запланированного запроса. Значение по умолчанию — LogAlert. |
Scheduled |
Критерии правила, определяющие условия правила запланированного запроса. |
Scheduled |
Ресурс правила запроса по расписанию. |
system |
Метаданные, относящиеся к созданию и последнему изменению ресурса. |
time |
Тип агрегирования. Применимо и требуется только для правил типа LogAlert. |
Actions
Действия для вызова при срабатывании оповещения.
Имя | Тип | Описание |
---|---|---|
actionGroups |
string[] |
Идентификаторы ресурсов группы действий для вызова при срабатывании оповещения. |
customProperties |
object |
Свойства полезных данных оповещения. |
AlertSeverity
Серьезность оповещения. Должно быть целым числом от [0 до 4]. Значение 0 является самым строгим. Применимо и требуется только для правил типа LogAlert.
Имя | Тип | Описание |
---|---|---|
0 |
Integer |
|
1 |
Integer |
|
2 |
Integer |
|
3 |
Integer |
|
4 |
Integer |
Condition
Условие правила запланированного запроса.
Имя | Тип | Описание |
---|---|---|
dimensions |
Список условий измерений |
|
failingPeriods |
Минимальное количество нарушений, необходимых в течение выбранного периода времени обратного просмотра, необходимого для создания оповещения. Относится только к правилам типа LogAlert. |
|
metricMeasureColumn |
string |
Столбец, содержащий номер метрики. Относится только к правилам типа LogAlert. |
metricName |
string |
Имя отправляемой метрики. Применимо и требуется только для правил типа LogToMetric. |
operator |
Оператор условий. Применимо и требуется только для правил типа LogAlert. |
|
query |
string |
Оповещение о запросе к журналу |
resourceIdColumn |
string |
Столбец, содержащий идентификатор ресурса. Содержимое столбца должно быть URI в формате идентификатора ресурса. Относится только к правилам типа LogAlert. |
threshold |
number |
пороговое значение условия, которое активирует оповещение. Применимо и требуется только для правил типа LogAlert. |
timeAggregation |
Тип агрегирования. Применимо и требуется только для правил типа LogAlert. |
conditionOperator
Оператор условия. Применимо и требуется только для правил типа LogAlert.
Имя | Тип | Описание |
---|---|---|
Equals |
string |
|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
createdByType
Тип удостоверения, создавшего ресурс.
Имя | Тип | Описание |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
Dimension
Определение разделения и фильтрации измерений
Имя | Тип | Описание |
---|---|---|
name |
string |
Имя измерения |
operator |
Оператор для значений измерений |
|
values |
string[] |
Список значений измерений |
dimensionOperator
Оператор для значений измерений
Имя | Тип | Описание |
---|---|---|
Exclude |
string |
|
Include |
string |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
Имя | Тип | Описание |
---|---|---|
info |
object |
Дополнительные сведения. |
type |
string |
Тип дополнительных сведений. |
ErrorContract
Описывает формат ответа об ошибке.
Имя | Тип | Описание |
---|---|---|
error |
Сообщение об ошибке |
ErrorResponse
Сообщение об ошибке
Имя | Тип | Описание |
---|---|---|
additionalInfo |
Дополнительные сведения об ошибке. |
|
code |
string |
Код ошибки. |
details |
Сведения об ошибке. |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект ошибки. |
FailingPeriods
Минимальное количество нарушений, необходимых в течение выбранного периода времени обратного просмотра, необходимого для создания оповещения. Применимо только для правил типа LogAlert.
Имя | Тип | Default value | Описание |
---|---|---|---|
minFailingPeriodsToAlert |
integer |
1 |
Количество нарушений, которые активируют оповещение. Значение должно быть меньше или равно numberOfEvaluationPeriods. Значение по умолчанию — 1. |
numberOfEvaluationPeriods |
integer |
1 |
Количество агрегированных точек обратного просмотра. Период времени просмотра рассчитывается на основе степени детализации агрегирования (windowSize) и выбранного количества агрегированных точек. Значение по умолчанию — 1. |
Kind
Указывает тип правила запланированного запроса. Значение по умолчанию — LogAlert.
Имя | Тип | Описание |
---|---|---|
LogAlert |
string |
|
LogToMetric |
string |
ScheduledQueryRuleCriteria
Критерии правила, определяющие условия правила запланированного запроса.
Имя | Тип | Описание |
---|---|---|
allOf |
Список условий для оценки в указанных областях |
ScheduledQueryRuleResource
Ресурс правила запроса по расписанию.
Имя | Тип | Описание |
---|---|---|
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 |
Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
kind |
Указывает тип правила запланированного запроса. Значение по умолчанию — LogAlert. |
|
location |
string |
Географическое расположение, в котором находится ресурс |
name |
string |
Имя ресурса. |
properties.actions |
Действия для вызова при срабатывании оповещения. |
|
properties.autoMitigate |
boolean |
Флаг, указывающий, следует ли автоматически разрешать оповещение. Значение по умолчанию — true. Относится только к правилам типа LogAlert. |
properties.checkWorkspaceAlertsStorageConfigured |
boolean |
Флаг, указывающий, должно ли это запланированное правило запроса храниться в хранилище клиента. Значение по умолчанию — false. Относится только к правилам типа LogAlert. |
properties.createdWithApiVersion |
string |
Версия API, используемая при создании этого правила генерации оповещений |
properties.criteria |
Критерии правила, определяющие условия правила запланированного запроса. |
|
properties.description |
string |
Описание правила запланированного запроса. |
properties.displayName |
string |
Отображаемое имя правила генерации оповещений |
properties.enabled |
boolean |
Флаг, указывающий, включено ли это запланированное правило запроса. Значение должно быть true или false |
properties.evaluationFrequency |
string |
Как часто правило запланированного запроса оценивается в формате длительности ISO 8601. Применимо и требуется только для правил типа LogAlert. |
properties.isLegacyLogAnalyticsRule |
boolean |
True, если правило генерации оповещений является устаревшим правилом Log Analytic |
properties.isWorkspaceAlertsStorageConfigured |
boolean |
Флаг, указывающий, настроено ли это запланированное правило запроса для хранения в хранилище клиента. Значение по умолчанию — false. |
properties.muteActionsDuration |
string |
Отключение звука действий в течение выбранного периода времени (в формате длительности ISO 8601) после срабатывания оповещения. Относится только к правилам типа LogAlert. |
properties.overrideQueryTimeRange |
string |
Если этот параметр указан, переопределяет диапазон времени запроса (по умолчанию — WindowSize*NumberOfEvaluationPeriods). Относится только к правилам типа LogAlert. |
properties.scopes |
string[] |
Список идентификаторов ресурса, к которым применяется это запланированное правило запроса. |
properties.severity |
Серьезность оповещения. Должно быть целым числом от [0 до 4]. Значение 0 является самым строгим. Применимо и требуется только для правил типа LogAlert. |
|
properties.skipQueryValidation |
boolean |
Флаг, указывающий, следует ли проверять предоставленный запрос. Значение по умолчанию — false. Относится только к правилам типа LogAlert. |
properties.targetResourceTypes |
string[] |
Список типов ресурсов целевых ресурсов, для которых создается или обновляется оповещение. Например, если область является группой ресурсов, а targetResourceTypes — Microsoft.Compute/virtualMachines, то для каждой виртуальной машины в группе ресурсов, удовлетворяющей условиям оповещения, будет срабано другое оповещение. Относится только к правилам типа LogAlert |
properties.windowSize |
string |
Период времени (в формате длительности ISO 8601), в течение которого будет выполняться запрос оповещения (размер ячейки). Применимо и требуется только для правил типа LogAlert. |
systemData |
SystemData объекта ScheduledQueryRule. |
|
tags |
object |
Теги ресурсов. |
type |
string |
Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts" |
systemData
Метаданные, относящиеся к созданию и последнему изменению ресурса.
Имя | Тип | Описание |
---|---|---|
createdAt |
string |
Метка времени создания ресурса (UTC). |
createdBy |
string |
Удостоверение, создающее ресурс. |
createdByType |
Тип удостоверения, создавшего ресурс. |
|
lastModifiedAt |
string |
Метка времени последнего изменения ресурса (UTC) |
lastModifiedBy |
string |
Удостоверение, которое в последний раз изменял ресурс. |
lastModifiedByType |
Тип удостоверения, изменяющего ресурс в последний раз. |
timeAggregation
Тип агрегирования. Применимо и требуется только для правил типа LogAlert.
Имя | Тип | Описание |
---|---|---|
Average |
string |
|
Count |
string |
|
Maximum |
string |
|
Minimum |
string |
|
Total |
string |