Scheduled Query Rules - List By Subscription

  • Référence
Service:
Monitor
API Version:
2021-08-01

Récupérez une définition de règle de requête planifiée dans un abonnement.

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

Paramètres URI

Nom Dans Obligatoire Type Description
subscriptionId
 path True

string

ID de l’abonnement cible.
api-version
 query True

string

Version de l’API à utiliser pour cette opération.

Réponses

Nom Type Description
200 OK

ScheduledQueryRuleResourceCollection

Demande réussie pour une liste de règles de requête planifiées
Other Status Codes

ErrorContract

BadRequest

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

List scheduled query rules by subscription

Sample Request

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

Sample Response

Status code:
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
      }
    }
  ]
}

Définitions

Nom Description
Actions

Actions à appeler lorsque l’alerte se déclenche.
AlertSeverity

Gravité de l’alerte. Doit être un entier compris entre [0-4]. La valeur 0 est la plus grave. Pertinent et requis uniquement pour les règles du type LogAlert.
Condition

Condition de la règle de requête planifiée.
conditionOperator

Opérateur de critères. Pertinent et requis uniquement pour les règles du type LogAlert.
createdByType

Type d’identité qui a créé la ressource.
Dimension

Définition de fractionnement et de filtrage de dimension
dimensionOperator

Opérateur pour les valeurs de dimension
ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorContract

Décrit le format de réponse d’erreur.
ErrorResponse

Réponse d’erreur
FailingPeriods

Nombre minimal de violations requises dans la fenêtre de temps de recherche sélectionnée pour déclencher une alerte. Concerne uniquement les règles du type LogAlert.
Kind

Indique le type de règle de requête planifiée. La valeur par défaut est LogAlert.
ScheduledQueryRuleCriteria

Critères de règle qui définissent les conditions de la règle de requête planifiée.
ScheduledQueryRuleResource

Ressource de règle de requête planifiée.
ScheduledQueryRuleResourceCollection

Représente une collection de ressources de règle de requête planifiée.
systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.
timeAggregation

Type d’agrégation. Pertinent et requis uniquement pour les règles du type LogAlert.

Actions

Actions à appeler lorsque l’alerte se déclenche.

Nom Type Description
actionGroups

string[]

ID de ressource du groupe d’actions à appeler lorsque l’alerte se déclenche.
customProperties

object

Propriétés d’une charge utile d’alerte.

AlertSeverity

Gravité de l’alerte. Doit être un entier compris entre [0-4]. La valeur 0 est la plus grave. Pertinent et requis uniquement pour les règles du type LogAlert.

Nom Type Description
0

Integer

1

Integer

2

Integer

3

Integer

4

Integer

Condition

Condition de la règle de requête planifiée.

Nom Type Description
dimensions

Dimension[]

Liste des conditions de dimensions
failingPeriods

FailingPeriods

Nombre minimal de violations requises dans la fenêtre de recherche sélectionnée pour déclencher une alerte. Applicable uniquement aux règles du type LogAlert.
metricMeasureColumn

string

Colonne contenant le numéro de mesure de métrique. Applicable uniquement aux règles du type LogAlert.
metricName

string

Nom de la métrique à envoyer. Pertinent et requis uniquement pour les règles du type LogToMetric.
operator

conditionOperator

Opérateur critères. Pertinent et requis uniquement pour les règles du type LogAlert.
query

string

Alerte de requête de journal
resourceIdColumn

string

Colonne contenant l’ID de ressource. Le contenu de la colonne doit être un URI au format ID de ressource. Applicable uniquement aux règles du type LogAlert.
threshold

number

valeur de seuil des critères qui active l’alerte. Pertinent et requis uniquement pour les règles du type LogAlert.
timeAggregation

timeAggregation

Type d’agrégation. Pertinent et requis uniquement pour les règles du type LogAlert.

conditionOperator

Opérateur de critères. Pertinent et requis uniquement pour les règles du type LogAlert.

Nom Type Description
Equals

string

GreaterThan

string

GreaterThanOrEqual

string

LessThan

string

LessThanOrEqual

string

createdByType

Type d’identité qui a créé la ressource.

Nom Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

Dimension

Définition de fractionnement et de filtrage de dimension

Nom Type Description
name

string

Nom de la dimension
operator

dimensionOperator

Opérateur pour les valeurs de dimension
values

string[]

Liste des valeurs de dimension

dimensionOperator

Opérateur pour les valeurs de dimension

Nom Type Description
Exclude

string

Include

string

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires
type

string

Type d’informations supplémentaires.

ErrorContract

Décrit le format de réponse d’erreur.

Nom Type Description
error

ErrorResponse

Réponse d’erreur
Détails de l’erreur.

ErrorResponse

Réponse d’erreur

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.
code

string

Code d'erreur.
details

ErrorResponse[]

Détails de l’erreur.
message

string

Message d’erreur.
target

string

Cible d’erreur.

FailingPeriods

Nombre minimal de violations requises dans la fenêtre de temps de recherche sélectionnée pour déclencher une alerte. Concerne uniquement les règles du type LogAlert.

Nom Type Valeur par défaut Description
minFailingPeriodsToAlert

integer

1

Nombre de violations à déclencher une alerte. Doit être plus petit ou égal à numberOfEvaluationPeriods. La valeur par défaut est 1
numberOfEvaluationPeriods

integer

1

Nombre de points de recherche en arrière agrégés. La fenêtre de temps de recherche en arrière est calculée en fonction de la granularité d’agrégation (windowSize) et du nombre sélectionné de points agrégés. La valeur par défaut est 1

Kind

Indique le type de règle de requête planifiée. La valeur par défaut est LogAlert.

Nom Type Description
LogAlert

string

LogToMetric

string

ScheduledQueryRuleCriteria

Critères de règle qui définissent les conditions de la règle de requête planifiée.

Nom Type Description
allOf

Condition[]

Liste des conditions à évaluer par rapport aux étendues spécifiées

ScheduledQueryRuleResource

Ressource de règle de requête planifiée.

Nom Type Description
etag

string

Le champ etag n’est pas obligatoire. S’il est fourni dans le corps de la réponse, il doit également être fourni en tant qu’en-tête conformément à la convention etag normale. Les balises d’entité sont utilisées pour comparer au moins deux entités de la même ressource demandée. HTTP/1.1 utilise des balises d’entité dans les champs d’en-tête etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26) et If-Range (section 14.27).
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind

Kind

Indique le type de règle de requête planifiée. La valeur par défaut est LogAlert.
location

string

Emplacement géographique où réside la ressource
name

string

nom de la ressource.
properties.actions

Actions

Actions à appeler lorsque l’alerte se déclenche.
properties.autoMitigate

boolean

Indicateur qui indique si l’alerte doit être résolue automatiquement ou non. La valeur par défaut est true. Applicable uniquement aux règles du type LogAlert.
properties.checkWorkspaceAlertsStorageConfigured

boolean

Indicateur qui indique si cette règle de requête planifiée doit être stockée dans le stockage du client. La valeur par défaut est false. Applicable uniquement aux règles du type LogAlert.
properties.createdWithApiVersion

string

Version de l’api utilisée lors de la création de cette règle d’alerte
properties.criteria

ScheduledQueryRuleCriteria

Critères de règle qui définissent les conditions de la règle de requête planifiée.
properties.description

string

Description de la règle de requête planifiée.
properties.displayName

string

Nom d’affichage de la règle d’alerte
properties.enabled

boolean

Indicateur qui indique si cette règle de requête planifiée est activée. La valeur doit être true ou false
properties.evaluationFrequency

string

Fréquence d’évaluation de la règle de requête planifiée représentée au format de durée ISO 8601. Pertinent et requis uniquement pour les règles du type LogAlert.
properties.isLegacyLogAnalyticsRule

boolean

True si la règle d’alerte est une règle Log Analytics héritée
properties.isWorkspaceAlertsStorageConfigured

boolean

Indicateur qui indique si cette règle de requête planifiée a été configurée pour être stockée dans le stockage du client. La valeur par défaut est false.
properties.muteActionsDuration

string

Désactivez les actions pour la période de temps choisie (au format durée ISO 8601) après le déclenchement de l’alerte. Applicable uniquement aux règles du type LogAlert.
properties.overrideQueryTimeRange

string

S’il est spécifié, remplace l’intervalle de temps de requête (la valeur par défaut est WindowSize*NumberOfEvaluationPeriods). Applicable uniquement aux règles du type LogAlert.
properties.scopes

string[]

La liste de l’ID de ressource est définie sur laquelle cette règle de requête planifiée est limitée.
properties.severity

AlertSeverity

Gravité de l’alerte. Doit être un entier compris entre [0-4]. La valeur 0 est la plus grave. Pertinent et requis uniquement pour les règles du type LogAlert.
properties.skipQueryValidation

boolean

Indicateur qui indique si la requête fournie doit être validée ou non. La valeur par défaut est false. Applicable uniquement aux règles du type LogAlert.
properties.targetResourceTypes

string[]

Liste du type de ressource des ressources cibles sur lesquelles l’alerte est créée/mise à jour. Par exemple, si l’étendue est un groupe de ressources et que targetResourceTypes est Microsoft.Compute/virtualMachines, une autre alerte est déclenchée pour chaque machine virtuelle du groupe de ressources qui répond aux critères d’alerte. Applicable uniquement pour les règles du type LogAlert
properties.windowSize

string

Période (au format de durée ISO 8601) pendant laquelle la requête Alerte sera exécutée (taille du bac). Pertinent et requis uniquement pour les règles du type LogAlert.
systemData

systemData

SystemData de ScheduledQueryRule.
tags

object

Balises de ressource.
type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

ScheduledQueryRuleResourceCollection

Représente une collection de ressources de règle de requête planifiée.

Nom Type Description
nextLink

string

Fournit le lien pour récupérer l’ensemble d’éléments suivant.
value

ScheduledQueryRuleResource[]

Valeurs pour les ressources de règle de requête planifiée.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string

Horodatage de la création de ressources (UTC).
createdBy

string

Identité qui a créé la ressource.
createdByType

createdByType

Type d’identité qui a créé la ressource.
lastModifiedAt

string

Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy

string

Identité qui a modifié la dernière ressource.
lastModifiedByType

createdByType

Type d’identité qui a modifié la dernière ressource.

timeAggregation

Type d’agrégation. Pertinent et requis uniquement pour les règles du type LogAlert.

Nom Type Description
Average

string

Count

string

Maximum

string

Minimum

string

Total

string