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

Name In Required Type Description
resourceGroupName
path True
  • string

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

ruleName
path True
  • string

Имя правила.

subscriptionId
path True
  • string

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

api-version
query True
  • string

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

Текст запроса

Name Required Type Description
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

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

Ответы

Name Type Description
200 OK

Успешный запрос для обновления правила запланированного запроса

201 Created

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

Other Status Codes

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

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

azure_auth

Flow OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
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

Sample Request

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
  }
}

Sample Response

{
  "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)

Sample Request

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
  }
}

Sample Response

{
  "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

Sample Request

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
  }
}

Sample Response

{
  "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

Действия для вызова при срабатывании оповещения.

AlertSeverity

Серьезность оповещения. Должно быть целым числом между [0–4]. Значение 0 является самым серьезным. Релевантные и обязательные только для правил типа LogAlert.

Condition

Условие правила запланированного запроса.

conditionOperator

Оператор условий. Релевантные и обязательные только для правил типа LogAlert.

createdByType

Тип удостоверения, создавшего ресурс.

Dimension

Определение разделения и фильтрации измерений

dimensionOperator

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

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorContract

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

ErrorResponse

Сообщение об ошибке

FailingPeriods

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

Kind

Указывает тип правила запланированного запроса. Значение по умолчанию — LogAlert.

ScheduledQueryRuleCriteria

Критерии правила, определяющие условия запланированного правила запроса.

ScheduledQueryRuleResource

Ресурс правила запланированного запроса.

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

timeAggregation

Тип агрегирования. Релевантные и обязательные только для правил типа LogAlert.

Actions

Действия для вызова при срабатывании оповещения.

Name Type Description
actionGroups
  • string[]

Идентификаторы ресурсов группы действий для вызова при срабатывании оповещения.

customProperties
  • object

Свойства полезных данных оповещения.

AlertSeverity

Серьезность оповещения. Должно быть целым числом между [0–4]. Значение 0 является самым серьезным. Релевантные и обязательные только для правил типа LogAlert.

Name Type Description
0
  • Integer
1
  • Integer
2
  • Integer
3
  • Integer
4
  • Integer

Condition

Условие правила запланированного запроса.

Name Type Description
dimensions

Список условий измерений

failingPeriods

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

metricMeasureColumn
  • string

Столбец, содержащий номер метрики. Относится только к правилам типа LogAlert.

metricName
  • string

Имя отправляемой метрики. Релевантные и обязательные только для правил типа LogToMetric.

operator

Оператор условий. Релевантные и обязательные только для правил типа LogAlert.

query
  • string

Оповещение запроса к журналу

resourceIdColumn
  • string

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

threshold
  • number

пороговое значение условия, которое активирует оповещение. Релевантные и обязательные только для правил типа LogAlert.

timeAggregation

Тип агрегирования. Релевантные и обязательные только для правил типа LogAlert.

conditionOperator

Оператор условий. Релевантные и обязательные только для правил типа LogAlert.

Name Type Description
Equals
  • string
GreaterThan
  • string
GreaterThanOrEqual
  • string
LessThan
  • string
LessThanOrEqual
  • string

createdByType

Тип удостоверения, создавшего ресурс.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

Dimension

Определение разделения и фильтрации измерений

Name Type Description
name
  • string

Имя измерения

operator

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

values
  • string[]

Список значений измерения

dimensionOperator

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

Name Type Description
Exclude
  • string
Include
  • string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Name Type Description
info
  • object

Дополнительные сведения.

type
  • string

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

ErrorContract

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

Name Type Description
error

Сообщение об ошибке
Сведения об ошибке.

ErrorResponse

Сообщение об ошибке

Name Type Description
additionalInfo

Дополнительные сведения об ошибке.

code
  • string

Код ошибки.

details

Сведения об ошибке.

message
  • string

Сообщение об ошибке.

target
  • string

Целевой объект ошибки.

FailingPeriods

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

Name Type Default Value Description
minFailingPeriodsToAlert
  • integer
1

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

numberOfEvaluationPeriods
  • integer
1

Количество агрегированных точек обратного просмотра. Период времени обратного просмотра вычисляется на основе степени детализации агрегирования (windowSize) и выбранного числа агрегированных точек. Значение по умолчанию — 1.

Kind

Указывает тип правила запланированного запроса. Значение по умолчанию — LogAlert.

Name Type Description
LogAlert
  • string
LogToMetric
  • string

ScheduledQueryRuleCriteria

Критерии правила, определяющие условия запланированного правила запроса.

Name Type Description
allOf

Список условий для оценки по указанным областям

ScheduledQueryRuleResource

Ресурс правила запланированного запроса.

Name Type Description
etag
  • string

Поле etag не является обязательным. Если он указан в тексте ответа, он также должен быть предоставлен в виде заголовка в соответствии с обычным соглашением etag. Теги сущностей используются для сравнения двух или более сущностей из одного запрошенного ресурса. HTTP/1.1 использует теги сущностей в теге (раздел 14.19), If-Match (раздел 14.24), If-None-Match (раздел 14.26) и If-Range (раздел 14.27).

id
  • string

Полный идентификатор ресурса. Ex - /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 of ScheduledQueryRule.

tags
  • object

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

type
  • string

Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft. служба хранилища/storageAccounts"

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Name Type Description
createdAt
  • string

Метка времени создания ресурса (UTC).

createdBy
  • string

Удостоверение, создающее ресурс.

createdByType

Тип удостоверения, создавшего ресурс.

lastModifiedAt
  • string

Метка времени последнего изменения ресурса (UTC)

lastModifiedBy
  • string

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

lastModifiedByType

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

timeAggregation

Тип агрегирования. Релевантные и обязательные только для правил типа LogAlert.

Name Type Description
Average
  • string
Count
  • string
Maximum
  • string
Minimum
  • string
Total
  • string