Partager via


Microsoft.AlertsAction de gestionRègles 2021-08-08-preview

Définition de ressource Bicep

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

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

Format de ressource

Pour créer une ressource Microsoft.AlertsManagement/actionRules, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.AlertsManagement/actionRules@2021-08-08-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    actions: [
      {
        actionType: 'string'
        // For remaining properties, see Action objects
      }
    ]
    conditions: [
      {
        field: 'string'
        operator: 'string'
        values: [
          'string'
        ]
      }
    ]
    description: 'string'
    enabled: bool
    schedule: {
      effectiveFrom: 'string'
      effectiveUntil: 'string'
      recurrences: [
        {
          endTime: 'string'
          startTime: 'string'
          recurrenceType: 'string'
          // For remaining properties, see Recurrence objects
        }
      ]
      timeZone: 'string'
    }
    scopes: [
      'string'
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

Objets d’action

Définissez la propriété actionType pour spécifier le type d’objet.

Pour AddActionGroups, utilisez :

{
  actionGroupIds: [
    'string'
  ]
  actionType: 'AddActionGroups'
}

Pour RemoveAllActionGroups, utilisez :

{
  actionType: 'RemoveAllActionGroups'
}

Objets de périodicité

Définissez la propriété recurrenceType pour spécifier le type d’objet.

Pour quotidien, utilisez :

{
  recurrenceType: 'Daily'
}

Pour mensuel, utilisez :

{
  daysOfMonth: [
    int
  ]
  recurrenceType: 'Monthly'
}

Pour hebdomadaire, utilisez :

{
  daysOfWeek: [
    'string'
  ]
  recurrenceType: 'Weekly'
}

Valeurs de propriété

Microsoft.AlertsGestion/actionRègles

Nom Descriptif Valeur
lieu Emplacement des ressources chaîne (obligatoire)
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés de la règle de traitement des alertes. AlertProcessingRuleProperties
étiquettes Balises de ressources Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

Action

Nom Descriptif Valeur
type d'action Défini sur « AddActionGroups » pour le type AddActionGroups. Défini sur « RemoveAllActionGroups » pour type RemoveAllActionGroups. 'AddActionGroups'
'RemoveAllActionGroups' (obligatoire)

AddActionGroups

Nom Descriptif Valeur
actionGroupIds Liste des ID de groupe d’actions à ajouter à la règle de traitement des alertes. string[] (obligatoire)
type d'action Action à appliquer. 'AddActionGroups' (obligatoire)

AlertProcessingRuleProperties

Nom Descriptif Valeur
Actions Actions à appliquer. action[] (obligatoire)
conditions Conditions sur lesquelles les alertes seront filtrées. condition[]
descriptif Description de la règle de traitement des alertes. ficelle
Activé Indique si la règle de traitement des alertes donnée est activée ou désactivée. Bool
calendrier Planification de la règle de traitement des alertes. Planification
Étendues Étendues sur lesquelles la règle de traitement des alertes s’applique. string[] (obligatoire)

État

Nom Descriptif Valeur
champ Champ pour une condition donnée. 'AlertContext'
'AlertRuleId'
'AlertRuleName'
'Descriptif'
'MonitorCondition'
'MonitorService'
'Gravité'
'Type de signal'
'RessourceCible'
'TargetResourceGroup'
'TargetResourceType'
opérateur Opérateur pour une condition donnée. 'Contient'
'Ne contient pas'
« Égaux »
'Pas égal'
Valeurs Liste des valeurs à mettre en correspondance pour une condition donnée. chaîne[]

Récurrence quotidienne

Nom Descriptif Valeur
récurrenceType Spécifie quand la périodicité doit être appliquée. 'Quotidien' (obligatoire)

ManagedResourceTags

Nom Descriptif Valeur

MensuelRécurrence

Nom Descriptif Valeur
joursdumois Spécifie les valeurs du modèle de périodicité mensuelle. int[] (obligatoire)
récurrenceType Spécifie quand la périodicité doit être appliquée. 'Mensuel' (obligatoire)

Répétition

Nom Descriptif Valeur
endTime Heure de fin de la périodicité. ficelle
récurrenceType Défini sur « Daily » pour le type DailyRecurrence. Défini sur « Mensuel » pour le type MonthlyRecurrence. Défini sur « Weekly » pour type WeeklyRecurrence. 'Quotidien'
'Mensuel'
'Hebdomadaire' (obligatoire)
heure de début Heure de début de la périodicité. ficelle

RemoveAllActionGroups

Nom Descriptif Valeur
type d'action Action à appliquer. 'RemoveAllActionGroups' (obligatoire)

Calendrier

Nom Descriptif Valeur
effectÀ partir de Planification effective à partir du moment. Date-Time au format ISO-8601 sans suffixe de fuseau horaire. chaîne

Contraintes:
Modèle = ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$
effectifJusqu’à ce que Planification effective jusqu’au moment. Date-Time au format ISO-8601 sans suffixe de fuseau horaire. chaîne

Contraintes:
Modèle = ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$
Récidives Liste des périodicités. Périodicité[]
fuseau horaire Fuseau horaire de planification. ficelle

HebdomadaireRécurrence

Nom Descriptif Valeur
joursDeSemaine Spécifie les valeurs du modèle de périodicité hebdomadaire. Tableau de chaînes contenant l’un des éléments suivants :
'Vendredi'
'Lundi'
'Samedi'
'Dimanche'
'jeudi'
'Mardi'
'Mercredi' (obligatoire)
récurrenceType Spécifie quand la périodicité doit être appliquée. 'Hebdomadaire' (obligatoire)

Exemples d’utilisation

Modules vérifiés Azure

Les modules vérifiés Azure suivants peuvent être utilisés pour déployer ce type de ressource.

Module Descriptif
Règles d’action Module de ressources AVM pour les règles d’action

Exemples de démarrage rapide Azure

Les modèles de démarrage rapide Azure suivants contiennent des exemples Bicep pour le déploiement de ce type de ressource.

Fichier Bicep Descriptif
notifications d’installation de pour les alertes de sauvegarde à l’aide d’Azure Monitor Ce modèle vous permet de configurer des notifications par e-mail pour vos coffres Recovery Services à l’aide d’Azure Monitor, en déployant une règle de traitement des alertes et un groupe d’actions

Définition de ressource de modèle ARM

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

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

Format de ressource

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

{
  "type": "Microsoft.AlertsManagement/actionRules",
  "apiVersion": "2021-08-08-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "actions": [ {
      "actionType": "string"
      // For remaining properties, see Action objects
    } ],
    "conditions": [
      {
        "field": "string",
        "operator": "string",
        "values": [ "string" ]
      }
    ],
    "description": "string",
    "enabled": "bool",
    "schedule": {
      "effectiveFrom": "string",
      "effectiveUntil": "string",
      "recurrences": [ {
        "endTime": "string",
        "startTime": "string",
        "recurrenceType": "string"
        // For remaining properties, see Recurrence objects
      } ],
      "timeZone": "string"
    },
    "scopes": [ "string" ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

Objets d’action

Définissez la propriété actionType pour spécifier le type d’objet.

Pour AddActionGroups, utilisez :

{
  "actionGroupIds": [ "string" ],
  "actionType": "AddActionGroups"
}

Pour RemoveAllActionGroups, utilisez :

{
  "actionType": "RemoveAllActionGroups"
}

Objets de périodicité

Définissez la propriété recurrenceType pour spécifier le type d’objet.

Pour quotidien, utilisez :

{
  "recurrenceType": "Daily"
}

Pour mensuel, utilisez :

{
  "daysOfMonth": [ "int" ],
  "recurrenceType": "Monthly"
}

Pour hebdomadaire, utilisez :

{
  "daysOfWeek": [ "string" ],
  "recurrenceType": "Weekly"
}

Valeurs de propriété

Microsoft.AlertsGestion/actionRègles

Nom Descriptif Valeur
apiVersion Version de l’API '2021-08-08-preview'
lieu Emplacement des ressources chaîne (obligatoire)
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés de la règle de traitement des alertes. AlertProcessingRuleProperties
étiquettes Balises de ressources Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.AlertsManagement/actionRules'

Action

Nom Descriptif Valeur
type d'action Défini sur « AddActionGroups » pour le type AddActionGroups. Défini sur « RemoveAllActionGroups » pour type RemoveAllActionGroups. 'AddActionGroups'
'RemoveAllActionGroups' (obligatoire)

AddActionGroups

Nom Descriptif Valeur
actionGroupIds Liste des ID de groupe d’actions à ajouter à la règle de traitement des alertes. string[] (obligatoire)
type d'action Action à appliquer. 'AddActionGroups' (obligatoire)

AlertProcessingRuleProperties

Nom Descriptif Valeur
Actions Actions à appliquer. action[] (obligatoire)
conditions Conditions sur lesquelles les alertes seront filtrées. condition[]
descriptif Description de la règle de traitement des alertes. ficelle
Activé Indique si la règle de traitement des alertes donnée est activée ou désactivée. Bool
calendrier Planification de la règle de traitement des alertes. Planification
Étendues Étendues sur lesquelles la règle de traitement des alertes s’applique. string[] (obligatoire)

État

Nom Descriptif Valeur
champ Champ pour une condition donnée. 'AlertContext'
'AlertRuleId'
'AlertRuleName'
'Descriptif'
'MonitorCondition'
'MonitorService'
'Gravité'
'Type de signal'
'RessourceCible'
'TargetResourceGroup'
'TargetResourceType'
opérateur Opérateur pour une condition donnée. 'Contient'
'Ne contient pas'
« Égaux »
'Pas égal'
Valeurs Liste des valeurs à mettre en correspondance pour une condition donnée. chaîne[]

Récurrence quotidienne

Nom Descriptif Valeur
récurrenceType Spécifie quand la périodicité doit être appliquée. 'Quotidien' (obligatoire)

ManagedResourceTags

Nom Descriptif Valeur

MensuelRécurrence

Nom Descriptif Valeur
joursdumois Spécifie les valeurs du modèle de périodicité mensuelle. int[] (obligatoire)
récurrenceType Spécifie quand la périodicité doit être appliquée. 'Mensuel' (obligatoire)

Répétition

Nom Descriptif Valeur
endTime Heure de fin de la périodicité. ficelle
récurrenceType Défini sur « Daily » pour le type DailyRecurrence. Défini sur « Mensuel » pour le type MonthlyRecurrence. Défini sur « Weekly » pour type WeeklyRecurrence. 'Quotidien'
'Mensuel'
'Hebdomadaire' (obligatoire)
heure de début Heure de début de la périodicité. ficelle

RemoveAllActionGroups

Nom Descriptif Valeur
type d'action Action à appliquer. 'RemoveAllActionGroups' (obligatoire)

Calendrier

Nom Descriptif Valeur
effectÀ partir de Planification effective à partir du moment. Date-Time au format ISO-8601 sans suffixe de fuseau horaire. chaîne

Contraintes:
Modèle = ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$
effectifJusqu’à ce que Planification effective jusqu’au moment. Date-Time au format ISO-8601 sans suffixe de fuseau horaire. chaîne

Contraintes:
Modèle = ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$
Récidives Liste des périodicités. Périodicité[]
fuseau horaire Fuseau horaire de planification. ficelle

HebdomadaireRécurrence

Nom Descriptif Valeur
joursDeSemaine Spécifie les valeurs du modèle de périodicité hebdomadaire. Tableau de chaînes contenant l’un des éléments suivants :
'Vendredi'
'Lundi'
'Samedi'
'Dimanche'
'jeudi'
'Mardi'
'Mercredi' (obligatoire)
récurrenceType Spécifie quand la périodicité doit être appliquée. 'Hebdomadaire' (obligatoire)

Exemples d’utilisation

Modèles de démarrage rapide Azure

Les modèles de démarrage rapide Azure suivants déployer ce type de ressource.

Modèle Descriptif
notifications d’installation de pour les alertes de sauvegarde à l’aide d’Azure Monitor

Déployer sur Azure
Ce modèle vous permet de configurer des notifications par e-mail pour vos coffres Recovery Services à l’aide d’Azure Monitor, en déployant une règle de traitement des alertes et un groupe d’actions

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource actionRules 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 de ressource

Pour créer une ressource Microsoft.AlertsManagement/actionRules, ajoutez le terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AlertsManagement/actionRules@2021-08-08-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      actions = [
        {
          actionType = "string"
          // For remaining properties, see Action objects
        }
      ]
      conditions = [
        {
          field = "string"
          operator = "string"
          values = [
            "string"
          ]
        }
      ]
      description = "string"
      enabled = bool
      schedule = {
        effectiveFrom = "string"
        effectiveUntil = "string"
        recurrences = [
          {
            endTime = "string"
            startTime = "string"
            recurrenceType = "string"
            // For remaining properties, see Recurrence objects
          }
        ]
        timeZone = "string"
      }
      scopes = [
        "string"
      ]
    }
  }
}

Objets d’action

Définissez la propriété actionType pour spécifier le type d’objet.

Pour AddActionGroups, utilisez :

{
  actionGroupIds = [
    "string"
  ]
  actionType = "AddActionGroups"
}

Pour RemoveAllActionGroups, utilisez :

{
  actionType = "RemoveAllActionGroups"
}

Objets de périodicité

Définissez la propriété recurrenceType pour spécifier le type d’objet.

Pour quotidien, utilisez :

{
  recurrenceType = "Daily"
}

Pour mensuel, utilisez :

{
  daysOfMonth = [
    int
  ]
  recurrenceType = "Monthly"
}

Pour hebdomadaire, utilisez :

{
  daysOfWeek = [
    "string"
  ]
  recurrenceType = "Weekly"
}

Valeurs de propriété

Microsoft.AlertsGestion/actionRègles

Nom Descriptif Valeur
lieu Emplacement des ressources chaîne (obligatoire)
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés de la règle de traitement des alertes. AlertProcessingRuleProperties
étiquettes Balises de ressources Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.AlertsManagement/actionRules@2021-08-08-preview »

Action

Nom Descriptif Valeur
type d'action Défini sur « AddActionGroups » pour le type AddActionGroups. Défini sur « RemoveAllActionGroups » pour type RemoveAllActionGroups. 'AddActionGroups'
'RemoveAllActionGroups' (obligatoire)

AddActionGroups

Nom Descriptif Valeur
actionGroupIds Liste des ID de groupe d’actions à ajouter à la règle de traitement des alertes. string[] (obligatoire)
type d'action Action à appliquer. 'AddActionGroups' (obligatoire)

AlertProcessingRuleProperties

Nom Descriptif Valeur
Actions Actions à appliquer. action[] (obligatoire)
conditions Conditions sur lesquelles les alertes seront filtrées. condition[]
descriptif Description de la règle de traitement des alertes. ficelle
Activé Indique si la règle de traitement des alertes donnée est activée ou désactivée. Bool
calendrier Planification de la règle de traitement des alertes. Planification
Étendues Étendues sur lesquelles la règle de traitement des alertes s’applique. string[] (obligatoire)

État

Nom Descriptif Valeur
champ Champ pour une condition donnée. 'AlertContext'
'AlertRuleId'
'AlertRuleName'
'Descriptif'
'MonitorCondition'
'MonitorService'
'Gravité'
'Type de signal'
'RessourceCible'
'TargetResourceGroup'
'TargetResourceType'
opérateur Opérateur pour une condition donnée. 'Contient'
'Ne contient pas'
« Égaux »
'Pas égal'
Valeurs Liste des valeurs à mettre en correspondance pour une condition donnée. chaîne[]

Récurrence quotidienne

Nom Descriptif Valeur
récurrenceType Spécifie quand la périodicité doit être appliquée. 'Quotidien' (obligatoire)

ManagedResourceTags

Nom Descriptif Valeur

MensuelRécurrence

Nom Descriptif Valeur
joursdumois Spécifie les valeurs du modèle de périodicité mensuelle. int[] (obligatoire)
récurrenceType Spécifie quand la périodicité doit être appliquée. 'Mensuel' (obligatoire)

Répétition

Nom Descriptif Valeur
endTime Heure de fin de la périodicité. ficelle
récurrenceType Défini sur « Daily » pour le type DailyRecurrence. Défini sur « Mensuel » pour le type MonthlyRecurrence. Défini sur « Weekly » pour type WeeklyRecurrence. 'Quotidien'
'Mensuel'
'Hebdomadaire' (obligatoire)
heure de début Heure de début de la périodicité. ficelle

RemoveAllActionGroups

Nom Descriptif Valeur
type d'action Action à appliquer. 'RemoveAllActionGroups' (obligatoire)

Calendrier

Nom Descriptif Valeur
effectÀ partir de Planification effective à partir du moment. Date-Time au format ISO-8601 sans suffixe de fuseau horaire. chaîne

Contraintes:
Modèle = ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$
effectifJusqu’à ce que Planification effective jusqu’au moment. Date-Time au format ISO-8601 sans suffixe de fuseau horaire. chaîne

Contraintes:
Modèle = ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$
Récidives Liste des périodicités. Périodicité[]
fuseau horaire Fuseau horaire de planification. ficelle

HebdomadaireRécurrence

Nom Descriptif Valeur
joursDeSemaine Spécifie les valeurs du modèle de périodicité hebdomadaire. Tableau de chaînes contenant l’un des éléments suivants :
'Vendredi'
'Lundi'
'Samedi'
'Dimanche'
'jeudi'
'Mardi'
'Mercredi' (obligatoire)
récurrenceType Spécifie quand la périodicité doit être appliquée. 'Hebdomadaire' (obligatoire)