Microsoft. AlertsManagement prometheusRuleGroups 2021-07-22-preview

  • Article

Définition de ressource Bicep

Le type de ressource prometheusRuleGroups peut être déployé sur :

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 un Microsoft. Ressource AlertsManagement/prometheusRuleGroups, ajoutez le Bicep suivant à votre modèle.

resource symbolicname 'Microsoft.AlertsManagement/prometheusRuleGroups@2021-07-22-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    clusterName: 'string'
    description: 'string'
    enabled: bool
    interval: 'string'
    rules: [
      {
        actions: [
          {
            actionGroupId: 'string'
            actionProperties: {}
          }
        ]
        alert: 'string'
        annotations: {}
        enabled: bool
        expression: 'string'
        for: 'string'
        labels: {}
        record: 'string'
        resolveConfiguration: {
          autoResolved: bool
          timeToResolve: 'string'
        }
        severity: int
      }
    ]
    scopes: [
      'string'
    ]
  }
}

Valeurs de propriétés

prometheusRuleGroups

Nom Description Valeur
name Nom de la ressource chaîne (obligatoire)
location Emplacement géographique où réside la ressource chaîne (obligatoire)
tags Balises de ressource. Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
properties Propriétés du groupe de règles Prometheus de la ressource. PrometheusRuleGroupProperties (obligatoire)

PrometheusRuleGroupProperties

Nom Description Valeur
clusterName nom du cluster de l’évaluation du groupe de règles. string
description description du groupe de règles Prometheus qui sera inclus dans l’e-mail d’alerte. string
enabled indicateur qui indique si le groupe de règles Prometheus est activé. bool
interval intervalle d’exécution du groupe de règles Prometheus représenté au format de durée ISO 8601. Doit être compris entre 1 et 15 minutes string
rules définit les règles du groupe de règles Prometheus. PrometheusRule[] (obligatoire)
étendues la liste des ID de ressource auxquels ce groupe de règles est limité. string[] (obligatoire)

PrometheusRule

Nom Description Valeur
actions Tableau d’actions qui sont effectuées lorsque la règle d’alerte devient active et lorsqu’une condition d’alerte est résolue. Concerne uniquement les alertes. PrometheusRuleGroupAction[]
alerte nom de la règle d’alerte. string
annotations annotations pour le groupe de règles. Concerne uniquement les alertes. object
enabled indicateur qui indique si la règle Prometheus est activée. bool
expression expression à exécuter pour la règle. chaîne (obligatoire)
pour la durée pendant laquelle l’alerte doit être active avant le déclenchement. Concerne uniquement les alertes. string
étiquettes étiquettes pour le groupe de règles. Concerne uniquement les alertes. object
enregistrement nom de la règle d’enregistrement. string
resolveConfiguration définit la configuration pour la résolution des alertes déclenchées. Concerne uniquement les alertes. PrometheusRuleResolveConfiguration
severity gravité des alertes déclenchées par la règle. Concerne uniquement les alertes. int

PrometheusRuleGroupAction

Nom Description Valeur
actionGroupId ID de ressource du groupe d’actions à utiliser. string
actionProperties Propriétés d’un objet de groupe d’actions. object

PrometheusRuleResolveConfiguration

Nom Description Valeur
autoResolved Indicateur qui indique si une alerte déclenchée doit être résolue automatiquement ou non. bool
timeToResolve durée qu’une règle doit évaluer comme étant saine avant que l’alerte déclenchée soit automatiquement résolue, représentée au format de durée ISO 8601. Doit être compris entre 1 et 15 minutes string

Définition de ressources de modèle ARM

Le type de ressource prometheusRuleGroups peut être déployé sur :

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

Format des ressources

Pour créer un Microsoft. Ressource AlertsManagement/prometheusRuleGroups, ajoutez le JSON suivant à votre modèle.

{
  "type": "Microsoft.AlertsManagement/prometheusRuleGroups",
  "apiVersion": "2021-07-22-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "clusterName": "string",
    "description": "string",
    "enabled": "bool",
    "interval": "string",
    "rules": [
      {
        "actions": [
          {
            "actionGroupId": "string",
            "actionProperties": {}
          }
        ],
        "alert": "string",
        "annotations": {},
        "enabled": "bool",
        "expression": "string",
        "for": "string",
        "labels": {},
        "record": "string",
        "resolveConfiguration": {
          "autoResolved": "bool",
          "timeToResolve": "string"
        },
        "severity": "int"
      }
    ],
    "scopes": [ "string" ]
  }
}

Valeurs de propriétés

prometheusRuleGroups

Nom Description Valeur
type Type de ressource Microsoft. AlertsManagement/prometheusRuleGroups'
apiVersion Version de l’API de ressource '2021-07-22-preview'
name Nom de la ressource string (obligatoire)
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 du groupe de règles Prometheus de la ressource. PrometheusRuleGroupProperties (obligatoire)

PrometheusRuleGroupProperties

Nom Description Valeur
clusterName nom du cluster de l’évaluation du groupe de règles. string
description description du groupe de règles Prometheus qui sera inclus dans l’e-mail d’alerte. string
enabled Indicateur qui indique si le groupe de règles Prometheus est activé. bool
interval intervalle d’exécution du groupe de règles Prometheus représenté au format de durée ISO 8601. Doit être compris entre 1 et 15 minutes string
rules définit les règles dans le groupe de règles Prometheus. PrometheusRule[] (obligatoire)
étendues liste des ID de ressource auxquels ce groupe de règles est limité. string[] (obligatoire)

PrometheusRule

Nom Description Valeur
actions Tableau des actions effectuées lorsque la règle d’alerte devient active et lorsqu’une condition d’alerte est résolue. Concerne uniquement les alertes. PrometheusRuleGroupAction[]
alerte nom de la règle d’alerte. string
annotations annotations pour le groupe de règles. Concerne uniquement les alertes. object
enabled Indicateur qui indique si la règle Prometheus est activée. bool
expression expression à exécuter pour la règle. string (obligatoire)
pour la durée pendant laquelle l’alerte doit être active avant le déclenchement. Concerne uniquement les alertes. string
étiquettes étiquettes pour le groupe de règles. Concerne uniquement les alertes. object
enregistrement nom de la règle d’enregistrement. string
resolveConfiguration définit la configuration pour la résolution des alertes déclenchées. Concerne uniquement les alertes. PrometheusRuleResolveConfiguration
severity gravité des alertes déclenchées par la règle. Concerne uniquement les alertes. int

PrometheusRuleGroupAction

Nom Description Valeur
actionGroupId ID de ressource du groupe d’actions à utiliser. string
actionProperties Propriétés d’un objet de groupe d’actions. object

PrometheusRuleResolveConfiguration

Nom Description Valeur
résolution automatique indicateur qui indique s’il faut ou non résoudre automatiquement une alerte déclenchée. bool
timeToResolve durée qu’une règle doit évaluer comme saine avant que l’alerte déclenchée ne soit automatiquement résolue, représentée au format de durée ISO 8601. Doit être compris entre 1 et 15 minutes string

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource prometheusRuleGroups peut être déployé sur :

  • 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 un Microsoft. AlertsManagement/prometheusRuleGroups, ajoutez le Terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AlertsManagement/prometheusRuleGroups@2021-07-22-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      clusterName = "string"
      description = "string"
      enabled = bool
      interval = "string"
      rules = [
        {
          actions = [
            {
              actionGroupId = "string"
              actionProperties = {}
            }
          ]
          alert = "string"
          annotations = {}
          enabled = bool
          expression = "string"
          for = "string"
          labels = {}
          record = "string"
          resolveConfiguration = {
            autoResolved = bool
            timeToResolve = "string"
          }
          severity = int
        }
      ]
      scopes = [
        "string"
      ]
    }
  })
}

Valeurs de propriétés

prometheusRuleGroups

Nom Description Valeur
type Type de ressource « Microsoft. AlertsManagement/prometheusRuleGroups@2021-07-22-preview »
name Nom de la ressource chaîne (obligatoire)
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 du groupe de règles Prometheus de la ressource. PrometheusRuleGroupProperties (obligatoire)

PrometheusRuleGroupProperties

Nom Description Valeur
clusterName nom du cluster de l’évaluation du groupe de règles. string
description description du groupe de règles Prometheus qui sera inclus dans l’e-mail d’alerte. string
enabled indicateur qui indique si le groupe de règles Prometheus est activé. bool
interval intervalle d’exécution du groupe de règles Prometheus représenté au format de durée ISO 8601. Doit être compris entre 1 et 15 minutes string
rules définit les règles du groupe de règles Prometheus. PrometheusRule[] (obligatoire)
étendues la liste des ID de ressource auxquels ce groupe de règles est limité. string[] (obligatoire)

PrometheusRule

Nom Description Valeur
actions Tableau d’actions qui sont effectuées lorsque la règle d’alerte devient active et lorsqu’une condition d’alerte est résolue. Concerne uniquement les alertes. PrometheusRuleGroupAction[]
alerte nom de la règle d’alerte. string
annotations annotations pour le groupe de règles. Concerne uniquement les alertes. object
enabled indicateur qui indique si la règle Prometheus est activée. bool
expression expression à exécuter pour la règle. chaîne (obligatoire)
pour la durée pendant laquelle l’alerte doit être active avant le déclenchement. Concerne uniquement les alertes. string
étiquettes étiquettes pour le groupe de règles. Concerne uniquement les alertes. object
enregistrement nom de la règle d’enregistrement. string
resolveConfiguration définit la configuration pour la résolution des alertes déclenchées. Concerne uniquement les alertes. PrometheusRuleResolveConfiguration
severity gravité des alertes déclenchées par la règle. Concerne uniquement les alertes. int

PrometheusRuleGroupAction

Nom Description Valeur
actionGroupId ID de ressource du groupe d’actions à utiliser. string
actionProperties Propriétés d’un objet de groupe d’actions. object

PrometheusRuleResolveConfiguration

Nom Description Valeur
résolution automatique indicateur qui indique s’il faut ou non résoudre automatiquement une alerte déclenchée. bool
timeToResolve durée qu’une règle doit évaluer comme saine avant que l’alerte déclenchée ne soit automatiquement résolue, représentée au format de durée ISO 8601. Doit être compris entre 1 et 15 minutes string