Smart Detector Alert Rules - Patch

Référence

Service:: Monitor

Version d'API:: 2019-06-01

Corriger une règle d’alerte Smart Detector spécifique.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.alertsManagement/smartDetectorAlertRules/{alertRuleName}?api-version=2019-06-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
alertRuleName	path	True	string	Nom de la règle d'alerte.
resourceGroupName	path	True	string	Nom du groupe de ressources.
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	Version de l’API cliente.

Corps de la demande

Nom	Type	Description
properties.actionGroups	ActionGroupsInformation	Actions de règle d’alerte.
properties.description	string	Description de la règle d’alerte.
properties.frequency	string	Fréquence de règle d’alerte au format ISO8601. La granularité du temps doit être en minutes et la valeur minimale est de 5 minutes.
properties.severity	Severity	Gravité de la règle d’alerte.
properties.state	AlertRuleState	État de la règle d’alerte.
properties.throttling	ThrottlingInformation	Informations de limitation des règles d’alerte.
tags	object	Étiquettes de la ressource.

Réponses

Nom	Type	Description
200 OK	AlertRule	Demande de mise à jour corrective de la règle d’alerte Smart Detector.
Other Status Codes	SmartDetectorErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

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

Patch alert rules

Exemple de requête

HTTP

PATCH https://management.azure.com/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/MyAlertRules/providers/microsoft.alertsManagement/smartDetectorAlertRules/MyAlertRule?api-version=2019-06-01

{
  "tags": {
    "newKey": "newVal"
  },
  "properties": {
    "description": "New description for patching",
    "frequency": "PT1M"
  }
}

Exemple de réponse

Code d’état:: 200

{
  "id": "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/MyAlertRules/providers/microsoft.alertsManagement/smartDetectorAlertRules/MyAlertRule",
  "type": "Microsoft.AlertsManagement/smartDetectorAlertRules",
  "name": "MyAlertRule",
  "location": "global",
  "tags": {
    "newKey": "newVal"
  },
  "properties": {
    "description": "New description for patching",
    "state": "Enabled",
    "severity": "Sev3",
    "frequency": "PT1M",
    "detector": {
      "id": "VMMemoryLeak"
    },
    "scope": [
      "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/MyVms/providers/Microsoft.Compute/virtualMachines/vm1"
    ],
    "actionGroups": [
      {
        "actionGroupId": "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourcegroups/actionGroups/providers/microsoft.insights/actiongroups/MyActionGroup"
      }
    ],
    "throttling": {
      "duration": "PT20M"
    }
  }
}

Définitions

Nom	Description
ActionGroupsInformation	Informations des groupes d’actions, utilisées par la règle d’alerte.
AlertRule	Informations sur la règle d’alerte
AlertRulePatchObject	Informations sur le correctif de règle d’alerte
AlertRuleState	État de la règle d’alerte.
Detector	Informations du détecteur. Par défaut, ce n’est pas renseigné, sauf s’il est spécifié dans expandDetector
Severity	Gravité de la règle d’alerte.
SmartDetectorErrorResponse	Décrire le format d’une réponse d’erreur.
ThrottlingInformation	Informations de limitation facultatives pour la règle d’alerte.

ActionGroupsInformation

Informations des groupes d’actions, utilisées par la règle d’alerte.

Nom	Type	Description
customEmailSubject	string	Objet d’e-mail personnalisé facultatif à utiliser dans Notifications par e-mail.
customWebhookPayload	string	Charge utile de web-hook personnalisée facultative à utiliser dans les notifications de web-hook.
groupIds	string[]	ID de ressources du groupe d’actions.

AlertRule

Informations sur la règle d’alerte

Nom	Type	Valeur par défaut	Description
id	string		ID de la ressource.
location	string	global	Emplacement de la ressource.
name	string		Nom de la ressource.
properties.actionGroups	ActionGroupsInformation		Actions de règle d’alerte.
properties.description	string		Description de la règle d’alerte.
properties.detector	Detector		Détecteur de la règle d’alerte.
properties.frequency	string		Fréquence de règle d’alerte au format ISO8601. La granularité du temps doit être en minutes et la valeur minimale est de 5 minutes.
properties.scope	string[]		Étendue des ressources de la règle d’alerte.
properties.severity	Severity		Gravité de la règle d’alerte.
properties.state	AlertRuleState		État de la règle d’alerte.
properties.throttling	ThrottlingInformation		Informations de limitation des règles d’alerte.
tags	object		Étiquettes de la ressource.
type	string		Type de ressource.

AlertRulePatchObject

Informations sur le correctif de règle d’alerte

Nom	Type	Description
id	string	ID de la ressource.
name	string	Nom de la ressource.
properties.actionGroups	ActionGroupsInformation	Actions de règle d’alerte.
properties.description	string	Description de la règle d’alerte.
properties.frequency	string	Fréquence de règle d’alerte au format ISO8601. La granularité du temps doit être en minutes et la valeur minimale est de 5 minutes.
properties.severity	Severity	Gravité de la règle d’alerte.
properties.state	AlertRuleState	État de la règle d’alerte.
properties.throttling	ThrottlingInformation	Informations de limitation des règles d’alerte.
tags	object	Étiquettes de la ressource.
type	string	Type de ressource.

AlertRuleState

État de la règle d’alerte.

Nom	Type	Description
Disabled	string
Enabled	string

Detector

Informations du détecteur. Par défaut, ce n’est pas renseigné, sauf s’il est spécifié dans expandDetector

Nom	Type	Description
description	string	Description du détecteur intelligent. Par défaut, ce n’est pas renseigné, sauf s’il est spécifié dans expandDetector
id	string	ID du détecteur.
imagePaths	string[]	Chemin d’accès à l’image Smart Detector. Par défaut, ce n’est pas renseigné, sauf s’il est spécifié dans expandDetector
name	string	Nom du détecteur intelligent. Par défaut, ce n’est pas renseigné, sauf s’il est spécifié dans expandDetector
parameters	object	Paramètres du détecteur.
supportedResourceTypes	string[]	Smart Detector a pris en charge les types de ressources. Par défaut, ce n’est pas renseigné, sauf s’il est spécifié dans expandDetector

Severity

Gravité de la règle d’alerte.

Nom	Type	Description
Sev0	string
Sev1	string
Sev2	string
Sev3	string
Sev4	string

SmartDetectorErrorResponse

Décrire le format d’une réponse d’erreur.

Nom	Type	Description
code	string	Code d'erreur
message	string	Message d’erreur indiquant la raison de l’échec de l’opération.

ThrottlingInformation

Informations de limitation facultatives pour la règle d’alerte.

Nom	Type	Description
duration	string	Durée requise (au format ISO8601) pour attendre avant de notifier à nouveau la règle d’alerte. La granularité du temps doit être en minutes et la valeur minimale est de 0 minutes

Partager via