Smart Detector Alert Rules - List

Référence

Service:: Monitor

API Version:: 2019-06-01

Répertoriez toutes les règles d’alerte Smart Detector existantes au sein de l’abonnement.

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

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/microsoft.alertsManagement/smartDetectorAlertRules?api-version=2019-06-01&expandDetector={expandDetector}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	Version de l’API cliente.
expandDetector	query		boolean	Indique si Smart Detector doit être développé.

Réponses

Nom	Type	Description
200 OK	AlertRulesList	Demande de liste des règles d’alerte Smart Detector réussie.
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
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Exemples

List Smart Detector alert rules

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "nextLink": null,
  "value": [
    {
      "id": "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/MyAlertRules/providers/microsoft.alertsManagement/smartDetectorAlertRules/MyAlertRule",
      "type": "Microsoft.AlertsManagement/smartDetectorAlertRules",
      "name": "MyAlertRule",
      "location": "global",
      "tags": {},
      "properties": {
        "description": "Sample smart detector alert rule description",
        "state": "Enabled",
        "severity": "Sev3",
        "frequency": "PT5M",
        "detector": {
          "id": "VMMemoryLeak"
        },
        "scope": [
          "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/vms/providers/Microsoft.Compute/virtualMachines/vm1"
        ],
        "actionGroups": [
          {
            "actionGroupId": "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourcegroups/MyActionGroups/providers/microsoft.insights/actionGroups/MyActionGroup"
          }
        ],
        "throttling": {
          "duration": "PT20M"
        }
      }
    },
    {
      "id": "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/MyAlertRules/providers/microsoft.alertsManagement/smartDetectorAlertRules/MySecondAlertRule",
      "type": "Microsoft.AlertsManagement/smartDetectorAlertRules",
      "name": "MySecondAlertRule",
      "location": "global",
      "tags": {},
      "properties": {
        "description": "Sample smart detector alert rule description",
        "state": "Disabled",
        "severity": "Sev2",
        "frequency": "PT15M",
        "detector": {
          "id": "VMMemoryLeak"
        },
        "scope": [
          "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/vms/providers/Microsoft.Compute/virtualMachines/vm2"
        ],
        "actionGroups": [
          {
            "actionGroupId": "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourcegroups/MyActionGroups/providers/microsoft.insights/actionGroups/MyActionGroup"
          }
        ]
      }
    }
  ]
}

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
AlertRulesList	Liste des règles d’alerte smart Detector.
AlertRuleState	État de la règle d’alerte.
Detector	Informations du détecteur. Par défaut, cette option n’est pas renseignée, sauf si elle est spécifiée 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 ressource 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 la 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 la règle d’alerte au format ISO8601. La granularité temporelle 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 de règle d’alerte.
tags	object		Étiquettes de la ressource.
type	string		Type de ressource.

AlertRulesList

Liste des règles d’alerte smart Detector.

Nom	Type	Description
nextLink	string	URL permettant d’obtenir l’ensemble de résultats suivant.
value	AlertRule[]	Liste des règles d’alerte smart Detector.

AlertRuleState

État de la règle d’alerte.

Nom	Type	Description
Disabled	string
Enabled	string

Detector

Informations du détecteur. Par défaut, cette option n’est pas renseignée, sauf si elle est spécifiée dans expandDetector

Nom	Type	Description
description	string	Description du détecteur intelligent. Par défaut, cette option n’est pas renseignée, sauf si elle est spécifiée dans expandDetector
id	string	ID du détecteur.
imagePaths	string[]	Chemin d’accès de l’image Smart Detector. Par défaut, cette option n’est pas renseignée, sauf si elle est spécifiée dans expandDetector
name	string	Nom du détecteur intelligent. Par défaut, cette option n’est pas renseignée, sauf si elle est spécifiée dans expandDetector
parameters	object	Paramètres du détecteur.
supportedResourceTypes	string[]	Types de ressources pris en charge par Smart Detector. Par défaut, cette option n’est pas renseignée, sauf si elle est spécifiée 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) d’attente avant de notifier à nouveau la règle d’alerte. La granularité temporelle doit être en minutes et la valeur minimale est de 0 minutes

Partager via