Microsoft.Insights scheduledQueryRules 2020-05-01-preview

Article
09/19/2023

Définition de ressource Bicep

Le type de ressource scheduledQueryRules peut être déployé avec des opérations qui ciblent :

Groupes de ressources - Voir commandes de déploiement de groupe de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Notes

Pour obtenir des conseils sur le déploiement de solutions de supervision, consultez Créer des ressources de supervision à l’aide de Bicep.

Format des ressources

Pour créer une ressource Microsoft.Insights/scheduledQueryRules, ajoutez le Bicep suivant à votre modèle.

resource symbolicname 'Microsoft.Insights/scheduledQueryRules@2020-05-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    actions: [
      {
        actionGroupId: 'string'
        webHookProperties: {}
      }
    ]
    criteria: {
      allOf: [
        {
          dimensions: [
            {
              name: 'string'
              operator: 'string'
              values: [
                'string'
              ]
            }
          ]
          failingPeriods: {
            minFailingPeriodsToAlert: int
            numberOfEvaluationPeriods: int
          }
          metricMeasureColumn: 'string'
          operator: 'string'
          query: 'string'
          resourceIdColumn: 'string'
          threshold: int
          timeAggregation: 'string'
        }
      ]
    }
    description: 'string'
    displayName: 'string'
    enabled: bool
    evaluationFrequency: 'string'
    muteActionsDuration: 'string'
    overrideQueryTimeRange: 'string'
    scopes: [
      'string'
    ]
    severity: int
    targetResourceTypes: [
      'string'
    ]
    windowSize: 'string'
  }
}

Valeurs de propriétés

scheduledQueryRules

Nom	Description	Valeur
name	Nom de la ressource	string (obligatoire) Limite de caractères : 1-260 Caractères valides : Impossibilité d’utiliser : `*<>%{}&:\\?/#` ou des caractères de contrôle. Ne peut pas se terminer par un espace ou un point.
location	Emplacement géographique où réside la ressource	string (obligatoire)
tags	Balises de ressource.	Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
properties	Propriétés de règle de la ressource.	ScheduledQueryRuleProperties (obligatoire)

ScheduledQueryRuleProperties

Nom	Description	Valeur
actions		Action[]
criteria	Critères de règle qui définissent les conditions de la règle de requête planifiée.	ScheduledQueryRuleCriteria
description	Description de la règle de requête planifiée.	string
displayName	Nom complet de la règle d’alerte	string
enabled	Indicateur qui indique si cette règle de requête planifiée est activée. La valeur doit être true ou false	bool
evaluationFrequency	Fréquence d’évaluation de la règle de requête planifiée représentée au format de durée ISO 8601.	string
muteActionsDuration	Désactivez les actions pour la période de temps choisie (au format de durée ISO 8601) après le déclenchement de l’alerte.	string
overrideQueryTimeRange	S’il est spécifié, remplace l’intervalle de temps de requête (la valeur par défaut est WindowSize*NumberOfEvaluationPeriods)	string
étendues	Liste des ID de ressource auxquels cette règle de requête planifiée est délimitée.	string[]
severity	Gravité de l’alerte. Doit être un entier compris entre [0-4]. La valeur 0 est la plus grave	int
targetResourceTypes	Liste du type de ressource de la ou 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	string[]
windowSize	Période (au format de durée ISO 8601) sur laquelle la requête d’alerte sera exécutée (taille du bac).	string

Action

Nom	Description	Valeur
actionGroupId	ID de ressource du groupe d’actions à appeler lorsque l’alerte se déclenche.	string
webHookProperties	Propriétés d’un objet webhook.	object

ScheduledQueryRuleCriteria

Nom	Description	Valeur
allOf	Liste des conditions à évaluer par rapport aux étendues spécifiées	Condition[]

Condition

Nom	Description	Valeur
dimensions	Liste des conditions de dimensions	Dimension[]
failingPeriods	Nombre minimal de violations requises dans la fenêtre de temps de recherche sélectionnée pour déclencher une alerte.	ConditionFailingPeriods
metricMeasureColumn	Colonne contenant le numéro de mesure de la métrique.	string
operator	Opérateur de critères.	'Égal à' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' (obligatoire)
query	Alerte de requête de journal	string
resourceIdColumn	Colonne contenant l’ID de ressource. Le contenu de la colonne doit être un URI au format ID de ressource	string
threshold	valeur de seuil de critère qui active l’alerte.	int (obligatoire)
timeAggregation	Type d’agrégation	'Moyenne' 'Count' 'Maximum' 'Minimum' 'Total' (obligatoire)

Dimension

Nom	Description	Valeur
name	Nom de la dimension	string (obligatoire)
operator	Opérateur pour les valeurs de dimension	'Exclure' 'Include' (obligatoire)
values	Liste des valeurs de dimension	string[] (obligatoire)

ConditionFailingPeriods

Nom	Description	Valeur
minFailingPeriodsToAlert	Nombre de violations à déclencher une alerte. Doit être plus petit ou égal à numberOfEvaluationPeriods. La valeur par défaut est 1	int
numberOfEvaluationPeriods	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	int

Définition de ressources de modèle ARM

Le type de ressource scheduledQueryRules peut être déployé avec des opérations qui ciblent :

Groupes de ressources - Voir commandes de déploiement de groupe de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Notes

Pour obtenir des conseils sur le déploiement de solutions de supervision, consultez Créer des ressources de supervision à l’aide de Bicep.

Format des ressources

Pour créer une ressource Microsoft.Insights/scheduledQueryRules, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.Insights/scheduledQueryRules",
  "apiVersion": "2020-05-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "actions": [
      {
        "actionGroupId": "string",
        "webHookProperties": {}
      }
    ],
    "criteria": {
      "allOf": [
        {
          "dimensions": [
            {
              "name": "string",
              "operator": "string",
              "values": [ "string" ]
            }
          ],
          "failingPeriods": {
            "minFailingPeriodsToAlert": "int",
            "numberOfEvaluationPeriods": "int"
          },
          "metricMeasureColumn": "string",
          "operator": "string",
          "query": "string",
          "resourceIdColumn": "string",
          "threshold": "int",
          "timeAggregation": "string"
        }
      ]
    },
    "description": "string",
    "displayName": "string",
    "enabled": "bool",
    "evaluationFrequency": "string",
    "muteActionsDuration": "string",
    "overrideQueryTimeRange": "string",
    "scopes": [ "string" ],
    "severity": "int",
    "targetResourceTypes": [ "string" ],
    "windowSize": "string"
  }
}

Valeurs de propriétés

scheduledQueryRules

Nom	Description	Valeur
type	Type de ressource	'Microsoft.Insights/scheduledQueryRules'
apiVersion	Version de l’API de ressource	'2020-05-01-preview'
name	Nom de la ressource	string (obligatoire) Limite de caractères : 1-260 Caractères valides : Impossibilité d’utiliser : `*<>%{}&:\\?/#` ou des caractères de contrôle. Ne peut pas se terminer par un espace ou un point.
location	Emplacement géographique où réside la ressource	string (obligatoire)
tags	Balises de ressource.	Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
properties	Propriétés de règle de la ressource.	ScheduledQueryRuleProperties (obligatoire)

ScheduledQueryRuleProperties

Nom	Description	Valeur
actions		Action[]
criteria	Critères de règle qui définissent les conditions de la règle de requête planifiée.	ScheduledQueryRuleCriteria
description	Description de la règle de requête planifiée.	string
displayName	Nom complet de la règle d’alerte	string
enabled	Indicateur qui indique si cette règle de requête planifiée est activée. La valeur doit être true ou false	bool
evaluationFrequency	Fréquence d’évaluation de la règle de requête planifiée représentée au format de durée ISO 8601.	string
muteActionsDuration	Désactivez les actions pour la période de temps choisie (au format de durée ISO 8601) après le déclenchement de l’alerte.	string
overrideQueryTimeRange	S’il est spécifié, remplace l’intervalle de temps de requête (la valeur par défaut est WindowSize*NumberOfEvaluationPeriods)	string
étendues	Liste des ID de ressource auxquels cette règle de requête planifiée est délimitée.	string[]
severity	Gravité de l’alerte. Doit être un entier compris entre [0-4]. La valeur 0 est la plus grave	int
targetResourceTypes	Liste du type de ressource de la ou 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	string[]
windowSize	Période (au format de durée ISO 8601) sur laquelle la requête d’alerte sera exécutée (taille du bac).	string

Action

Nom	Description	Valeur
actionGroupId	ID de ressource du groupe d’actions à appeler lorsque l’alerte se déclenche.	string
webHookProperties	Propriétés d’un objet webhook.	object

ScheduledQueryRuleCriteria

Nom	Description	Valeur
allOf	Liste des conditions à évaluer par rapport aux étendues spécifiées	Condition[]

Condition

Nom	Description	Valeur
dimensions	Liste des conditions de dimensions	Dimension[]
failingPeriods	Nombre minimal de violations requises dans la fenêtre de temps de recherche sélectionnée pour déclencher une alerte.	ConditionFailingPeriods
metricMeasureColumn	Colonne contenant le numéro de mesure de la métrique.	string
operator	Opérateur de critères.	'Égal à' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' (obligatoire)
query	Alerte de requête de journal	string
resourceIdColumn	Colonne contenant l’ID de ressource. Le contenu de la colonne doit être un URI au format ID de ressource	string
threshold	valeur de seuil de critère qui active l’alerte.	int (obligatoire)
timeAggregation	Type d’agrégation	'Moyenne' 'Count' 'Maximum' 'Minimum' 'Total' (obligatoire)

Dimension

Nom	Description	Valeur
name	Nom de la dimension	chaîne (obligatoire)
operator	Opérateur pour les valeurs de dimension	'Exclure' 'Include' (obligatoire)
values	Liste des valeurs de dimension	string[] (obligatoire)

ConditionFailingPeriods

Nom	Description	Valeur
minFailingPeriodsToAlert	Nombre de violations pour déclencher une alerte. Doit être plus petit ou égal à numberOfEvaluationPeriods. La valeur par défaut est 1	int
numberOfEvaluationPeriods	Nombre de points de recherche agrégés. La fenêtre de temps de recherche en arrière est calculée en fonction de la granularité de l’agrégation (windowSize) et du nombre sélectionné de points agrégés. La valeur par défaut est 1	int

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource scheduledQueryRules peut être déployé avec des opérations qui ciblent :

Groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.Insights/scheduledQueryRules, ajoutez le Terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/scheduledQueryRules@2020-05-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      actions = [
        {
          actionGroupId = "string"
          webHookProperties = {}
        }
      ]
      criteria = {
        allOf = [
          {
            dimensions = [
              {
                name = "string"
                operator = "string"
                values = [
                  "string"
                ]
              }
            ]
            failingPeriods = {
              minFailingPeriodsToAlert = int
              numberOfEvaluationPeriods = int
            }
            metricMeasureColumn = "string"
            operator = "string"
            query = "string"
            resourceIdColumn = "string"
            threshold = int
            timeAggregation = "string"
          }
        ]
      }
      description = "string"
      displayName = "string"
      enabled = bool
      evaluationFrequency = "string"
      muteActionsDuration = "string"
      overrideQueryTimeRange = "string"
      scopes = [
        "string"
      ]
      severity = int
      targetResourceTypes = [
        "string"
      ]
      windowSize = "string"
    }
  })
}

Valeurs de propriétés

scheduledQueryRules

Nom	Description	Valeur
type	Type de ressource	« Microsoft.Insights/scheduledQueryRules@2020-05-01-preview »
name	Nom de la ressource	chaîne (obligatoire) Limite de caractères : 1-260 Caractères valides : Impossibilité d’utiliser : `*<>%{}&:\\?/#` ou des caractères de contrôle. Ne peut pas se terminer par un espace ou un point.
location	Emplacement géographique où réside la ressource	chaîne (obligatoire)
parent_id	Pour effectuer un déploiement sur un groupe de ressources, utilisez l’ID de ce groupe de ressources.	chaîne (obligatoire)
tags	Balises de ressource.	Dictionnaire de noms et de valeurs d’étiquettes.
properties	Propriétés de règle de la ressource.	ScheduledQueryRuleProperties (obligatoire)

ScheduledQueryRuleProperties

Nom	Description	Valeur
actions		Action[]
criteria	Critères de règle qui définissent les conditions de la règle de requête planifiée.	ScheduledQueryRuleCriteria
description	Description de la règle de requête planifiée.	string
displayName	Nom d’affichage de la règle d’alerte	string
enabled	Indicateur qui indique si cette règle de requête planifiée est activée. La valeur doit être true ou false	bool
evaluationFrequency	Fréquence d’évaluation de la règle de requête planifiée représentée au format de durée ISO 8601.	string
muteActionsDuration	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.	string
overrideQueryTimeRange	S’il est spécifié, remplace l’intervalle de temps de requête (la valeur par défaut est WindowSize*NumberOfEvaluationPeriods)	string
étendues	La liste de l’ID de ressource est définie sur laquelle cette règle de requête planifiée est limitée.	string[]
severity	Gravité de l’alerte. Doit être un entier compris entre [0-4]. La valeur 0 est la plus grave	int
targetResourceTypes	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	string[]
windowSize	Période (au format de durée ISO 8601) pendant laquelle la requête Alerte sera exécutée (taille du bac).	string

Action

Nom	Description	Valeur
actionGroupId	ID de ressource du groupe d’actions à appeler lorsque l’alerte se déclenche.	string
webHookProperties	Propriétés d’un objet webhook.	object

ScheduledQueryRuleCriteria

Nom	Description	Valeur
allOf	Liste des conditions à évaluer par rapport aux étendues spécifiées	Condition[]

Condition

Nom	Description	Valeur
dimensions	Liste des conditions de dimensions	Dimension[]
failingPeriods	Nombre minimal de violations requises dans la fenêtre de recherche sélectionnée pour déclencher une alerte.	ConditionFailingPeriods
metricMeasureColumn	Colonne contenant le numéro de mesure de métrique.	string
operator	Opérateur critères.	« Égal » « GreaterThan » « GreaterThanOrEqual » « LessThan » « LessThanOrEqual » (obligatoire)
query	Alerte de requête de journal	string
resourceIdColumn	Colonne contenant l’ID de ressource. Le contenu de la colonne doit être un URI au format ID de ressource	string
threshold	valeur de seuil des critères qui active l’alerte.	int (obligatoire)
timeAggregation	Type d’agrégation	« Moyenne » « Nombre » « Maximum » « Minimum » « Total » (obligatoire)

Dimension

Nom	Description	Valeur
name	Nom de la dimension	chaîne (obligatoire)
operator	Opérateur pour les valeurs de dimension	« Exclure » « Include » (obligatoire)
values	Liste des valeurs de dimension	string[] (obligatoire)

ConditionFailingPeriods

Nom	Description	Valeur
minFailingPeriodsToAlert	Nombre de violations pour déclencher une alerte. Doit être plus petit ou égal à numberOfEvaluationPeriods. La valeur par défaut est 1	int
numberOfEvaluationPeriods	Nombre de points de recherche agrégés. La fenêtre de temps de recherche en arrière est calculée en fonction de la granularité de l’agrégation (windowSize) et du nombre sélectionné de points agrégés. La valeur par défaut est 1	int

Share via

Microsoft.Insights scheduledQueryRules 2020-05-01-preview

Définition de ressource Bicep

Notes

Format des ressources

Valeurs de propriétés

scheduledQueryRules

ScheduledQueryRuleProperties

Action

ScheduledQueryRuleCriteria

Condition

Dimension

ConditionFailingPeriods

Définition de ressources de modèle ARM

Notes

Format des ressources

Valeurs de propriétés

scheduledQueryRules

ScheduledQueryRuleProperties

Action

ScheduledQueryRuleCriteria

Condition

Dimension

ConditionFailingPeriods

Définition de ressource Terraform (fournisseur AzAPI)

Format des ressources

Valeurs de propriétés

scheduledQueryRules

ScheduledQueryRuleProperties

Action

ScheduledQueryRuleCriteria

Condition

Dimension

ConditionFailingPeriods

Commentaires

Commentaires

Ressources supplémentaires