Partager via


Activity Log Alerts - Create Or Update

Créez une règle d’alerte de journal d’activité ou mettez à jour une règle existante.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/activityLogAlerts/{activityLogAlertName}?api-version=2020-10-01

Paramètres URI

Nom Dans Obligatoire Type Description
activityLogAlertName
path True

string

Nom de la règle d’alerte du journal d’activité.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nom du groupe de ressources. Le nom ne respecte pas la casse.

subscriptionId
path True

string

minLength: 1

ID de l’abonnement cible.

api-version
query True

string

minLength: 1

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

Corps de la demande

Nom Obligatoire Type Description
properties.actions True

ActionList

Actions qui s’activent lorsque la condition est remplie.

properties.condition True

AlertRuleAllOfCondition

Condition qui entraînera l’activation de cette alerte.

properties.scopes True

string[]

Liste des ID de ressource qui seront utilisés comme préfixes. L’alerte s’applique uniquement aux événements du journal d’activité avec des ID de ressource qui se trouvent sous l’un de ces préfixes. Cette liste doit inclure au moins un élément.

location

string

Emplacement de la ressource. Les règles d’alerte du journal d’activité Azure sont prises en charge dans les régions Global, Europe Ouest et Europe Nord.

properties.description

string

Description de cette règle d’alerte de journal d’activité.

properties.enabled

boolean

Indique si cette règle d’alerte de journal d’activité est activée. Si une règle d’alerte de journal d’activité n’est pas activée, aucune de ses actions n’est activée.

tags

object

Balises de la ressource.

Réponses

Nom Type Description
200 OK

ActivityLogAlertResource

Une règle d’alerte de journal d’activité existante a été mise à jour.

201 Created

ActivityLogAlertResource

Une nouvelle règle d’alerte de journal d’activité a été créée avec succès.

Other Status Codes

ErrorResponse

Une erreur s’est produite et la règle d’alerte du journal d’activité n’a pas pu être créée ou mise à jour.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Exemples

Create or update an Activity Log Alert rule
Create or update an Activity Log Alert rule with 'anyOf' condition
Create or update an Activity Log Alert rule with 'containsAny'

Create or update an Activity Log Alert rule

Exemple de requête

PUT https://management.azure.com/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/activityLogAlerts/SampleActivityLogAlertRule?api-version=2020-10-01

{
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "/subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "Administrative"
        },
        {
          "field": "level",
          "equals": "Error"
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": true,
    "description": "Description of sample Activity Log Alert rule."
  }
}

Exemple de réponse

{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRule",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRule",
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "Category",
          "equals": "Administrative"
        },
        {
          "field": "Level",
          "equals": "Error"
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": true,
    "description": "Description of sample Activity Log Alert rule."
  }
}
{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRule",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRule",
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "Category",
          "equals": "Administrative"
        },
        {
          "field": "Level",
          "equals": "Error"
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": true,
    "description": "Description of sample Activity Log Alert rule."
  }
}

Create or update an Activity Log Alert rule with 'anyOf' condition

Exemple de requête

PUT https://management.azure.com/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/activityLogAlerts/SampleActivityLogAlertRuleWithAnyOfCondition?api-version=2020-10-01

{
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "ServiceHealth"
        },
        {
          "anyOf": [
            {
              "field": "properties.incidentType",
              "equals": "Incident"
            },
            {
              "field": "properties.incidentType",
              "equals": "Maintenance"
            }
          ]
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": true,
    "description": "Description of sample Activity Log Alert rule with 'anyOf' condition."
  }
}

Exemple de réponse

{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRuleWithAnyOfCondition",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRuleWithAnyOfCondition",
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "ServiceHealth"
        },
        {
          "anyOf": [
            {
              "field": "properties.incidentType",
              "equals": "Incident"
            },
            {
              "field": "properties.incidentType",
              "equals": "Maintenance"
            }
          ]
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": true,
    "description": "Description of sample Activity Log Alert rule with 'anyOf' condition."
  }
}
{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRuleWithAnyOfCondition",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRuleWithAnyOfCondition",
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "ServiceHealth"
        },
        {
          "anyOf": [
            {
              "field": "properties.incidentType",
              "equals": "Incident"
            },
            {
              "field": "properties.incidentType",
              "equals": "Maintenance"
            }
          ]
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": true,
    "description": "Description of sample Activity Log Alert rule with 'anyOf' condition."
  }
}

Create or update an Activity Log Alert rule with 'containsAny'

Exemple de requête

PUT https://management.azure.com/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/activityLogAlerts/SampleActivityLogAlertRuleWithContainsAny?api-version=2020-10-01

{
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "ServiceHealth"
        },
        {
          "field": "properties.impactedServices[*].ImpactedRegions[*].RegionName",
          "containsAny": [
            "North Europe",
            "West Europe"
          ]
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": true,
    "description": "Description of sample Activity Log Alert rule with 'containsAny'."
  }
}

Exemple de réponse

{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRuleWithContainsAny",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRuleWithContainsAny",
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "ServiceHealth"
        },
        {
          "field": "properties.impactedServices[*].ImpactedRegions[*].RegionName",
          "containsAny": [
            "North Europe",
            "West Europe"
          ]
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": true,
    "description": "Description of sample Activity Log Alert rule with 'containsAny'."
  }
}
{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRuleWithContainsAny",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRuleWithContainsAny",
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "ServiceHealth"
        },
        {
          "field": "properties.impactedServices[*].ImpactedRegions[*].RegionName",
          "containsAny": [
            "North Europe",
            "West Europe"
          ]
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": true,
    "description": "Description of sample Activity Log Alert rule with 'containsAny'."
  }
}

Définitions

Nom Description
ActionGroup

Pointeur vers un groupe d’actions Azure.

ActionList

Liste des actions de règle d’alerte du journal d’activité.

ActivityLogAlertResource

Ressource de règle d’alerte du journal d’activité.

AlertRuleAllOfCondition

Condition de règle d’alerte du journal d’activité remplie lorsque toutes ses conditions membres sont remplies.

AlertRuleAnyOfOrLeafCondition

Condition de règle d’alerte du journal d’activité remplie lorsque toutes ses conditions membres sont remplies. Chaque condition peut être de l’un des types suivants : important : chaque type a son sous-ensemble unique de propriétés. Les propriétés de différents types NE PEUVENT pas exister dans une seule condition.

  • condition feuille - doit contenir 'field' et 'equals' ou 'containsAny'. Remarque : « anyOf » ne doit pas être défini dans une condition feuille.
  • condition AnyOf : doit contenir uniquement 'anyOf' (qui est un tableau de conditions feuilles). Remarque : « field », « equals » et « containsAny » doivent pas être définies dans une condition AnyOf.
AlertRuleLeafCondition

Condition de règle d’alerte du journal d’activité remplie en comparant le champ et la valeur d’un événement de journal d’activité. Cette condition doit contenir 'field' et 'equals' ou 'containsAny'.

ErrorResponse

Réponse d’erreur.

ActionGroup

Pointeur vers un groupe d’actions Azure.

Nom Type Description
actionGroupId

string

ID de ressource du groupe d’actions. Cela ne peut pas être null ou vide.

webhookProperties

object

dictionnaire de propriétés personnalisées à inclure avec l’opération de publication. Ces données sont ajoutées à la charge utile du webhook.

ActionList

Liste des actions de règle d’alerte du journal d’activité.

Nom Type Description
actionGroups

ActionGroup[]

Liste des groupes d’actions.

ActivityLogAlertResource

Ressource de règle d’alerte du journal d’activité.

Nom Type Valeur par défaut Description
id

string

ID de ressource.

location

string

global

Emplacement de la ressource. Les règles d’alerte du journal d’activité Azure sont prises en charge dans les régions Global, Europe Ouest et Europe Nord.

name

string

Nom de la ressource.

properties.actions

ActionList

Actions qui s’activent lorsque la condition est remplie.

properties.condition

AlertRuleAllOfCondition

Condition qui entraînera l’activation de cette alerte.

properties.description

string

Description de cette règle d’alerte de journal d’activité.

properties.enabled

boolean

True

Indique si cette règle d’alerte de journal d’activité est activée. Si une règle d’alerte de journal d’activité n’est pas activée, aucune de ses actions n’est activée.

properties.scopes

string[]

Liste des ID de ressource qui seront utilisés comme préfixes. L’alerte s’applique uniquement aux événements du journal d’activité avec des ID de ressource qui se trouvent sous l’un de ces préfixes. Cette liste doit inclure au moins un élément.

tags

object

Balises de la ressource.

type

string

Type de la ressource.

AlertRuleAllOfCondition

Condition de règle d’alerte du journal d’activité remplie lorsque toutes ses conditions membres sont remplies.

Nom Type Description
allOf

AlertRuleAnyOfOrLeafCondition[]

Liste des conditions de règle d’alerte du journal d’activité.

AlertRuleAnyOfOrLeafCondition

Condition de règle d’alerte du journal d’activité remplie lorsque toutes ses conditions membres sont remplies. Chaque condition peut être de l’un des types suivants : important : chaque type a son sous-ensemble unique de propriétés. Les propriétés de différents types NE PEUVENT pas exister dans une seule condition.

  • condition feuille - doit contenir 'field' et 'equals' ou 'containsAny'. Remarque : « anyOf » ne doit pas être défini dans une condition feuille.
  • condition AnyOf : doit contenir uniquement 'anyOf' (qui est un tableau de conditions feuilles). Remarque : « field », « equals » et « containsAny » doivent pas être définies dans une condition AnyOf.
Nom Type Description
anyOf

AlertRuleLeafCondition[]

Une règle d’alerte du journal d’activité « anyOf ».
Condition de règle d’alerte du journal d’activité remplie lorsque au moins l’une de ses conditions feuilles membres est remplie.

containsAny

string[]

La valeur du champ de l’événement est comparée aux valeurs de ce tableau (sans respect de la casse) pour déterminer si la condition est remplie.

equals

string

La valeur du champ de l’événement est comparée à cette valeur (sans respect de la casse) pour déterminer si la condition est remplie.

field

string

Nom du champ de l’événement Journal d’activité que cette condition examine. Les valeurs possibles pour ce champ sont (sans respect de la casse) : 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', ou tout ce qui commence par 'properties'.

AlertRuleLeafCondition

Condition de règle d’alerte du journal d’activité remplie en comparant le champ et la valeur d’un événement de journal d’activité. Cette condition doit contenir 'field' et 'equals' ou 'containsAny'.

Nom Type Description
containsAny

string[]

La valeur du champ de l’événement est comparée aux valeurs de ce tableau (sans respect de la casse) pour déterminer si la condition est remplie.

equals

string

La valeur du champ de l’événement est comparée à cette valeur (sans respect de la casse) pour déterminer si la condition est remplie.

field

string

Nom du champ de l’événement Journal d’activité que cette condition examine. Les valeurs possibles pour ce champ sont (sans respect de la casse) : 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', ou tout ce qui commence par 'properties'.

ErrorResponse

Réponse d’erreur.

Nom Type Description
code

string

Code d’erreur.

message

string

Message d’erreur indiquant pourquoi l’opération a échoué.