Scheduled Query Rules - List By Subscription

Ссылка

Служба:: Monitor

Версия API:: 2021-08-01

Получение определений правил запланированного запроса в подписке.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/scheduledQueryRules?api-version=2021-08-01

Параметры URI

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

Ответы

Имя	Тип	Описание
200 OK	ScheduledQueryRuleResourceCollection	Успешный запрос для списка правил запланированного запроса
Other Status Codes	ErrorContract	Неверный запрос

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

azure_auth

Поток OAuth2 Azure Active Directory

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

Области

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

Примеры

List scheduled query rules by subscription

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

HTTP

GET https://management.azure.com/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/providers/Microsoft.Insights/scheduledQueryRules?api-version=2021-08-01

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

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

{
  "value": [
    {
      "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/MyResourceGroupName2/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"
        ],
        "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
      }
    }
  ]
}

Определения

Имя	Описание
Actions	Действия для вызова при срабатывании оповещения.
AlertSeverity	Серьезность оповещения. Должно быть целым числом между [0–4]. Значение 0 является самым серьезным. Релевантные и обязательные только для правил типа LogAlert.
Condition	Условие запланированного правила запроса.
conditionOperator	Оператор условий. Релевантные и обязательные только для правил типа LogAlert.
createdByType	Тип удостоверения, создавшего ресурс.
Dimension	Определение разделения измерений и фильтрации
dimensionOperator	Оператор для значений измерения
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorContract	Описывает формат ответа на ошибку.
ErrorResponse	Ответ на ошибку
FailingPeriods	Минимальное количество нарушений, необходимых в выбранном окне времени обратного просмотра, необходимое для создания оповещения. Относится только к правилам типа LogAlert.
Kind	Указывает тип правила запланированного запроса. Значение по умолчанию — LogAlert.
ScheduledQueryRuleCriteria	Критерии правила, определяющие условия запланированного правила запроса.
ScheduledQueryRuleResource	Ресурс правила запланированного запроса.
ScheduledQueryRuleResourceCollection	Представляет коллекцию ресурсов правил запланированных запросов.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
timeAggregation	Тип агрегирования. Релевантные и обязательные только для правил типа LogAlert.

Actions

Object

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

Имя	Тип	Описание
actionGroups	string[]	Идентификаторы ресурсов группы действий для вызова при срабатывании оповещения.
customProperties	object	Свойства полезных данных оповещения.

AlertSeverity

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

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

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

Condition

Object

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

Имя	Тип	Описание
dimensions	Dimension[]	Список условий измерений
failingPeriods	FailingPeriods	Минимальное количество нарушений, необходимых в выбранном окне времени обратного просмотра, необходимое для создания оповещения. Относится только к правилам типа LogAlert.
metricMeasureColumn	string	Столбец, содержащий номер метрики. Относится только к правилам типа LogAlert.
metricName	string	Имя отправляемой метрики. Релевантные и обязательные только для правил типа LogToMetric.
operator	conditionOperator	Оператор условий. Релевантные и обязательные только для правил типа LogAlert.
query	string	Оповещение запроса журнала
resourceIdColumn	string	Столбец, содержащий идентификатор ресурса. Содержимое столбца должно иметь формат URI в виде идентификатора ресурса. Относится только к правилам типа LogAlert.
threshold	number (double)	пороговое значение условия, которое активирует оповещение. Релевантные и обязательные только для правил типа LogAlert.
timeAggregation	timeAggregation	Тип агрегирования. Релевантные и обязательные только для правил типа LogAlert.

conditionOperator

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

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

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

createdByType

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

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

Значение	Описание
Application
Key
ManagedIdentity
User

Dimension

Object

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

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

dimensionOperator

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

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

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

ErrorAdditionalInfo

Object

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

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorContract

Object

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

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

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorResponse[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

FailingPeriods

Object

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

Имя	Тип	Default value	Описание
minFailingPeriodsToAlert	integer (int64)	1	Количество нарушений для активации оповещения. Должно быть меньше или равно числуOfEvaluationPeriods. Значение по умолчанию — 1
numberOfEvaluationPeriods	integer (int64)	1	Количество агрегированных точек обратного просмотра. Окно времени обратного просмотра вычисляется на основе детализации агрегирования (windowSize) и выбранного числа агрегированных точек. Значение по умолчанию — 1

Kind

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

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

Значение	Описание
LogAlert
LogToMetric

ScheduledQueryRuleCriteria

Object

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

Имя	Тип	Описание
allOf	Condition[]	Список условий для оценки по указанным областям

ScheduledQueryRuleResource

Object

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

Имя	Тип	Описание
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	Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	Kind	Указывает тип правила запланированного запроса. Значение по умолчанию — LogAlert.
location	string	Географическое расположение, в котором находится ресурс
name	string	Имя ресурса
properties.actions	Actions	Действия для вызова при срабатывании оповещения.
properties.autoMitigate	boolean	Флаг, указывающий, следует ли автоматически разрешать оповещение. Значение по умолчанию — true. Относится только к правилам типа LogAlert.
properties.checkWorkspaceAlertsStorageConfigured	boolean	Флаг, указывающий, следует ли хранить это правило запланированного запроса в хранилище клиента. Значение по умолчанию — false. Относится только к правилам типа LogAlert.
properties.createdWithApiVersion	string	Версия API, используемая при создании этого правила генерации оповещений
properties.criteria	ScheduledQueryRuleCriteria	Критерии правила, определяющие условия запланированного правила запроса.
properties.description	string	Описание правила запланированного запроса.
properties.displayName	string	Отображаемое имя правила генерации оповещений
properties.enabled	boolean	Флаг, указывающий, включено ли это правило запланированного запроса. Значение должно иметь значение true или false
properties.evaluationFrequency	string (duration)	Как часто правило запланированного запроса оценивается в формате длительности ISO 8601. Релевантные и обязательные только для правил типа LogAlert.
properties.isLegacyLogAnalyticsRule	boolean	Значение true, если правило генерации оповещений является устаревшим правилом Log Analytic
properties.isWorkspaceAlertsStorageConfigured	boolean	Флаг, указывающий, настроено ли это запланированное правило запроса для хранения в хранилище клиента. Значение по умолчанию — false.
properties.muteActionsDuration	string (duration)	Отключение действий в течение выбранного периода времени (в формате длительности ISO 8601) после запуска оповещения. Относится только к правилам типа LogAlert.
properties.overrideQueryTimeRange	string (duration)	Если задано, переопределяет диапазон времени запроса (по умолчанию — WindowSize*NumberOfEvaluationPeriods). Относится только к правилам типа LogAlert.
properties.scopes	string[]	Список идентификаторов ресурса, к которым применяется это правило запланированного запроса.
properties.severity	AlertSeverity (int64)	Серьезность оповещения. Должно быть целым числом между [0–4]. Значение 0 является самым серьезным. Релевантные и обязательные только для правил типа LogAlert.
properties.skipQueryValidation	boolean	Флаг, указывающий, следует ли проверять предоставленный запрос. Значение по умолчанию — false. Относится только к правилам типа LogAlert.
properties.targetResourceTypes	string[]	Список типов ресурсов целевого ресурса, на котором создается или обновляется оповещение. Например, если область — это группа ресурсов и targetResourceTypes — Microsoft.Compute/virtualMachines, то для каждой виртуальной машины в группе ресурсов будет запущено другое оповещение. Применимо только для правил типа LogAlert
properties.windowSize	string (duration)	Период времени (в формате длительности ISO 8601), в котором будет выполняться запрос генерации оповещений (размер ячейки). Релевантные и обязательные только для правил типа LogAlert.
systemData	systemData	SystemData of ScheduledQueryRule.
tags	object	Теги ресурсов.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

ScheduledQueryRuleResourceCollection

Object

Представляет коллекцию ресурсов правил запланированных запросов.

Имя	Тип	Описание
nextLink	string	Предоставляет ссылку для получения следующего набора элементов.
value	ScheduledQueryRuleResource[]	Значения для ресурсов правил запланированного запроса.

systemData

Object

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

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

timeAggregation

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

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

Значение	Описание
Average
Count
Maximum
Minimum
Total

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

Scheduled Query Rules - List By Subscription

Параметры URI

Ответы

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

azure_auth

Области

Примеры

List scheduled query rules by subscription

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

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

Определения

Actions

AlertSeverity

Condition

conditionOperator

createdByType

Dimension

dimensionOperator

ErrorAdditionalInfo

ErrorContract

ErrorResponse

FailingPeriods

Kind

ScheduledQueryRuleCriteria

ScheduledQueryRuleResource

ScheduledQueryRuleResourceCollection

systemData

timeAggregation

Дополнительные ресурсы