Partager via


Metric Alerts - List By Subscription

Récupérez les définitions de règle d’alerte dans un abonnement.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/metricAlerts?api-version=2018-03-01

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 à utiliser pour cette opération.

Réponses

Nom Type Description
200 OK

MetricAlertResourceCollection

Demande réussie d’une liste d’alertes de métriques

Other Status Codes

ErrorResponse

BadRequest

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

List metric alert rules

Exemple de requête

GET https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/providers/Microsoft.Insights/metricAlerts?api-version=2018-03-01

Exemple de réponse

{
  "value": [
    {
      "id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/highcpu",
      "type": "Microsoft.Insights/metricAlerts",
      "location": "global",
      "tags": {
        "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
      },
      "properties": {
        "description": "This is the description of the rule1",
        "severity": 3,
        "enabled": true,
        "scopes": [
          "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
        ],
        "evaluationFrequency": "PT1M",
        "windowSize": "PT15M",
        "criteria": {
          "odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria",
          "allOf": [
            {
              "criterionType": "StaticThresholdCriterion",
              "name": "High_CPU_80",
              "metricName": "CustomMetric_\\Processor(_Total)\\% Processor Time",
              "dimensions": [],
              "operator": "GreaterThan",
              "threshold": 80.5,
              "timeAggregation": "Average"
            }
          ]
        },
        "actions": [
          {
            "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
            "webHookProperties": {
              "key11": "value11",
              "key12": "value12"
            }
          }
        ]
      }
    },
    {
      "id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/mediumcpu",
      "type": "Microsoft.Insights/metricAlerts",
      "location": "global",
      "tags": {
        "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
      },
      "properties": {
        "description": "Med cpu alert",
        "severity": 4,
        "enabled": true,
        "scopes": [
          "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
        ],
        "evaluationFrequency": "PT1M",
        "windowSize": "PT15M",
        "criteria": {
          "odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria",
          "allOf": [
            {
              "criterionType": "StaticThresholdCriterion",
              "name": "Medium_CPU_50",
              "metricName": "CustomMetric_\\Processor(_Total)\\% Processor Time",
              "dimensions": [],
              "operator": "GreaterThan",
              "threshold": 50.5,
              "timeAggregation": "Average"
            }
          ]
        },
        "actions": [
          {
            "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
            "webHookProperties": {
              "key11": "value11",
              "key12": "value12"
            }
          }
        ]
      }
    }
  ]
}

Définitions

Nom Description
AdditionalInfo

Tableau d’objets avec les propriétés « type » et « info ». Le schéma de « info » est propre au service et dépend de la chaîne « type ».

AggregationTypeEnum

les types d’agrégation de temps des critères.

DynamicMetricCriteria

Critère de seuil dynamique.

DynamicThresholdFailingPeriods

Nombre minimal de violations requises dans la fenêtre de temps de recherche sélectionnée requise pour déclencher une alerte.

DynamicThresholdOperator

Opérateur utilisé pour comparer la valeur de métrique au seuil.

DynamicThresholdSensitivity

Étendue de l’écart requis pour déclencher une alerte. Cela aura une incidence sur la limite du seuil au modèle de série de métriques.

Error
ErrorDetail

Décrit les détails d’une réponse d’erreur.

ErrorResponse

Décrit le format de la réponse d’erreur.

MetricAlertAction

Action d’alerte.

MetricAlertMultipleResourceMultipleMetricCriteria

Spécifie les critères d’alerte de métrique pour plusieurs ressources qui ont plusieurs critères de métrique.

MetricAlertResource

Ressource d’alerte de métrique.

MetricAlertResourceCollection

Représente une collection de ressources de règle d’alerte.

MetricAlertSingleResourceMultipleMetricCriteria

Spécifie les critères d’alerte de métrique pour une seule ressource qui a plusieurs critères de métrique.

MetricCriteria

Critère pour filtrer les métriques.

MetricDimension

Spécifie une dimension de métrique.

Operator

opérateur de critères.

WebtestLocationAvailabilityCriteria

Spécifie les critères de règle d’alerte de métrique pour une ressource de test web.

AdditionalInfo

Tableau d’objets avec les propriétés « type » et « info ». Le schéma de « info » est propre au service et dépend de la chaîne « type ».

Nom Type Description
info

object

Informations supplémentaires spécifiques au type.

type

string

Type d’informations supplémentaires.

AggregationTypeEnum

les types d’agrégation de temps des critères.

Nom Type Description
Average

string

Count

string

Maximum

string

Minimum

string

Total

string

DynamicMetricCriteria

Critère de seuil dynamique.

Nom Type Description
alertSensitivity

DynamicThresholdSensitivity

Étendue de l’écart requis pour déclencher une alerte. Cela aura une incidence sur la limite du seuil au modèle de série de métriques.

criterionType string:

DynamicThresholdCriterion

Spécifie le type de critères de seuil

dimensions

MetricDimension[]

Liste des conditions de dimension.

failingPeriods

DynamicThresholdFailingPeriods

Nombre minimal de violations requises dans la fenêtre de temps de recherche sélectionnée requise pour déclencher une alerte.

ignoreDataBefore

string

Utilisez cette option pour définir la date à partir de laquelle commencer à apprendre les données historiques des métriques et calculer les seuils dynamiques (au format ISO8601)

metricName

string

Nom de la métrique.

metricNamespace

string

Espace de noms de la métrique.

name

string

Nom des critères.

operator

DynamicThresholdOperator

Opérateur utilisé pour comparer la valeur de métrique au seuil.

skipMetricValidation

boolean

Permet de créer une règle d’alerte sur une métrique personnalisée qui n’est pas encore émise, en provoquant l’omission de la validation de la métrique.

timeAggregation

AggregationTypeEnum

les types d’agrégation de temps des critères.

DynamicThresholdFailingPeriods

Nombre minimal de violations requises dans la fenêtre de temps de recherche sélectionnée requise pour déclencher une alerte.

Nom Type Description
minFailingPeriodsToAlert

number

Nombre de violations à déclencher une alerte. Doit être inférieur ou égal à numberOfEvaluationPeriods.

numberOfEvaluationPeriods

number

Nombre de points de recherche agrégés. La fenêtre de temps de recherche est calculée en fonction de la granularité d’agrégation (windowSize) et du nombre sélectionné de points agrégés.

DynamicThresholdOperator

Opérateur utilisé pour comparer la valeur de métrique au seuil.

Nom Type Description
GreaterOrLessThan

string

GreaterThan

string

LessThan

string

DynamicThresholdSensitivity

Étendue de l’écart requis pour déclencher une alerte. Cela aura une incidence sur la limite du seuil au modèle de série de métriques.

Nom Type Description
High

string

Low

string

Medium

string

Error

Nom Type Description
additionalInfo

AdditionalInfo[]

Tableau d’objets avec les propriétés « type » et « info ». Le schéma de « info » est propre au service et dépend de la chaîne « type ».

code

string

Chaîne non localisée qui peut être utilisée pour identifier l’erreur par programmation.

details

ErrorDetail[]

Tableau d’objets d’informations de réponse d’erreur imbriqués supplémentaires, comme décrit par ce contrat.

message

string

Décrit l’erreur en détail et fournit des informations de débogage. Si Accept-Language est défini dans la requête, elle doit être localisée dans cette langue.

target

string

Cible de l’erreur particulière (par exemple, le nom de la propriété en erreur).

ErrorDetail

Décrit les détails d’une réponse d’erreur.

Nom Type Description
additionalInfo

AdditionalInfo[]

Tableau d’objets avec les propriétés « type » et « info ». Le schéma de « info » est propre au service et dépend de la chaîne « type ».

code

string

Chaîne non localisée qui peut être utilisée pour identifier l’erreur par programmation.

message

string

Décrit l’erreur en détail et fournit des informations de débogage.

target

string

Cible de l’erreur particulière (par exemple, le nom de la propriété en erreur).

ErrorResponse

Décrit le format de la réponse d’erreur.

Nom Type Description
error

Error

MetricAlertAction

Action d’alerte.

Nom Type Description
actionGroupId

string

ID du groupe d’actions à utiliser.

webHookProperties

object

Ce champ permet de spécifier des propriétés personnalisées, qui seraient ajoutées à la charge utile d’alerte envoyée en tant qu’entrée au webhook.

MetricAlertMultipleResourceMultipleMetricCriteria

Spécifie les critères d’alerte de métrique pour plusieurs ressources qui ont plusieurs critères de métrique.

Nom Type Description
allOf MultiMetricCriteria[]:

liste de plusieurs critères de métrique pour cette opération « tout ».

odata.type string:

Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria

spécifie le type des critères d’alerte.

MetricAlertResource

Ressource d’alerte de métrique.

Nom Type Description
id

string

ID de ressource Azure

location

string

Emplacement des ressources

name

string

Nom de la ressource Azure

properties.actions

MetricAlertAction[]

tableau d’actions effectuées lorsque la règle d’alerte devient active et lorsqu’une condition d’alerte est résolue.

properties.autoMitigate

boolean

indicateur qui indique si l’alerte doit être résolue automatiquement ou non. La valeur par défaut est true.

properties.criteria MetricAlertCriteria:

définit les informations de critères d’alerte spécifiques.

properties.description

string

description de l’alerte de métrique qui sera incluse dans l’e-mail d’alerte.

properties.enabled

boolean

indicateur qui indique si l’alerte de métrique est activée.

properties.evaluationFrequency

string

fréquence à laquelle l’alerte de métrique est évaluée au format de durée ISO 8601.

properties.isMigrated

boolean

valeur indiquant si cette règle d’alerte est migrée.

properties.lastUpdatedTime

string

Dernière fois que la règle a été mise à jour au format ISO8601.

properties.scopes

string[]

liste des ID de ressource auxquels cette alerte de métrique est limitée.

properties.severity

integer

Gravité de l’alerte {0, 1, 2, 3, 4}

properties.targetResourceRegion

string

région de la ou des ressources cibles sur lesquelles l’alerte est créée/mise à jour. Obligatoire si l’étendue contient un abonnement, un groupe de ressources ou plusieurs ressources.

properties.targetResourceType

string

type de ressource des ressources cibles sur lesquelles l’alerte est créée/mise à jour. Obligatoire si l’étendue contient un abonnement, un groupe de ressources ou plusieurs ressources.

properties.windowSize

string

période (au format de durée ISO 8601) utilisée pour surveiller l’activité d’alerte en fonction du seuil.

tags

object

Balises de ressource

type

string

Type de ressource Azure

MetricAlertResourceCollection

Représente une collection de ressources de règle d’alerte.

Nom Type Description
value

MetricAlertResource[]

valeurs des ressources de la règle d’alerte.

MetricAlertSingleResourceMultipleMetricCriteria

Spécifie les critères d’alerte de métrique pour une seule ressource qui a plusieurs critères de métrique.

Nom Type Description
allOf

MetricCriteria[]

Liste des critères de métrique pour cette opération « tout ».

odata.type string:

Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria

spécifie le type des critères d’alerte.

MetricCriteria

Critère pour filtrer les métriques.

Nom Type Description
criterionType string:

StaticThresholdCriterion

Spécifie le type de critères de seuil

dimensions

MetricDimension[]

Liste des conditions de dimension.

metricName

string

Nom de la métrique.

metricNamespace

string

Espace de noms de la métrique.

name

string

Nom des critères.

operator

Operator

opérateur de critères.

skipMetricValidation

boolean

Permet de créer une règle d’alerte sur une métrique personnalisée qui n’est pas encore émise, en provoquant l’omission de la validation de la métrique.

threshold

number

valeur de seuil de critères qui active l’alerte.

timeAggregation

AggregationTypeEnum

les types d’agrégation de temps des critères.

MetricDimension

Spécifie une dimension de métrique.

Nom Type Description
name

string

Nom de la dimension.

operator

string

opérateur de dimension. Seuls « Include » et « Exclude » sont pris en charge

values

string[]

liste des valeurs de dimension.

Operator

opérateur de critères.

Nom Type Description
Equals

string

GreaterThan

string

GreaterThanOrEqual

string

LessThan

string

LessThanOrEqual

string

WebtestLocationAvailabilityCriteria

Spécifie les critères de règle d’alerte de métrique pour une ressource de test web.

Nom Type Description
componentId

string

ID de ressource Application Insights.

failedLocationCount

number

Nombre d’emplacements ayant échoué.

odata.type string:

Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria

spécifie le type des critères d’alerte.

webTestId

string

ID de test web Application Insights.