Metric Alerts - List By Subscription
Récupérer 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 |
---|---|---|---|---|
subscription
|
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 |
Demande réussie d’une liste d’alertes de métriques |
|
Other Status Codes |
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 |
---|---|
Aggregation |
les types d’agrégation de temps de critères. |
Dynamic |
Critère de seuil dynamique. |
Dynamic |
Nombre minimal de violations requises dans la fenêtre de temps de recherche sélectionnée pour déclencher une alerte. |
Dynamic |
Opérateur utilisé pour comparer la valeur de la métrique au seuil. |
Dynamic |
Étendue de l’écart nécessaire pour déclencher une alerte. Cela affectera la limite du seuil au modèle de série de métriques. |
Error |
Décrit le format de la réponse d’erreur. |
Metric |
Action d’alerte. |
Metric |
Spécifie les critères d’alerte de métrique pour plusieurs ressources qui ont plusieurs critères de métrique. |
Metric |
Ressource d’alerte de métrique. |
Metric |
Représente une collection de ressources de règle d’alerte. |
Metric |
Spécifie les critères d’alerte de métrique pour une seule ressource qui a plusieurs critères de métrique. |
Metric |
Critère pour filtrer les métriques. |
Metric |
Spécifie une dimension de métrique. |
Operator |
opérateur de critères. |
Webtest |
Spécifie les critères de règle d’alerte de métrique pour une ressource de test web. |
AggregationTypeEnum
les types d’agrégation de temps de 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 |
Étendue de l’écart nécessaire pour déclencher une alerte. Cela affectera la limite du seuil au modèle de série de métriques. |
|
criterionType |
string:
Dynamic |
Spécifie le type de critères de seuil |
dimensions |
Liste des conditions de dimension. |
|
failingPeriods |
Nombre minimal de violations requises dans la fenêtre de temps de recherche sélectionnée pour déclencher une alerte. |
|
ignoreDataBefore |
string |
Utilisez cette option pour définir la date à partir de laquelle commencer l’apprentissage des données historiques de métriques et calculer les seuils dynamiques (au format ISO8601) |
metricName |
string |
nom attribué à la métrique. |
metricNamespace |
string |
Espace de noms de la métrique. |
name |
string |
Nom des critères. |
operator |
Opérateur utilisé pour comparer la valeur de la métrique au seuil. |
|
skipMetricValidation |
boolean |
Permet la création d’une règle d’alerte pour une métrique personnalisée qui n’a pas encore été émise, car l’étape de validation de la métrique a été ignorée. |
timeAggregation |
les types d’agrégation de temps de critères. |
DynamicThresholdFailingPeriods
Nombre minimal de violations requises dans la fenêtre de temps de recherche sélectionnée pour déclencher une alerte.
Nom | Type | Description |
---|---|---|
minFailingPeriodsToAlert |
number |
Nombre de violations à déclencher une alerte. Doit être plus petit ou égal à numberOfEvaluationPeriods. |
numberOfEvaluationPeriods |
number |
Nombre de points de recherche en arrière agrégés. La fenêtre de temps de recherche en arrière 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 la métrique au seuil.
Nom | Type | Description |
---|---|---|
GreaterOrLessThan |
string |
|
GreaterThan |
string |
|
LessThan |
string |
DynamicThresholdSensitivity
Étendue de l’écart nécessaire pour déclencher une alerte. Cela affectera la limite du seuil au modèle de série de métriques.
Nom | Type | Description |
---|---|---|
High |
string |
|
Low |
string |
|
Medium |
string |
ErrorResponse
Décrit le format de la 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. |
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 « all of ». |
odata.type |
string:
Microsoft. |
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 de la ressource |
name |
string |
Nom de la ressource Azure |
properties.actions |
tableau d’actions qui sont 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 sur les 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 |
la fréquence à laquelle l’alerte de métrique est évaluée représenté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 |
La dernière fois que la règle a été mise à jour dans ISO8601 format. |
properties.scopes |
string[] |
liste des ID de ressource auxquels cette alerte de métrique est dé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 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.windowSize |
string |
la période (au format de durée ISO 8601) utilisée pour surveiller l’activité des alertes 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 |
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 |
Liste des critères de métrique pour cette opération « all of ». |
|
odata.type |
string:
Microsoft. |
spécifie le type des critères d’alerte. |
MetricCriteria
Critère pour filtrer les métriques.
Nom | Type | Description |
---|---|---|
criterionType |
string:
Static |
Spécifie le type de critères de seuil |
dimensions |
Liste des conditions de dimension. |
|
metricName |
string |
nom attribué à la métrique. |
metricNamespace |
string |
Espace de noms de la métrique. |
name |
string |
Nom des critères. |
operator |
opérateur de critères. |
|
skipMetricValidation |
boolean |
Permet la création d’une règle d’alerte pour une métrique personnalisée qui n’a pas encore été émise, car l’étape de validation de la métrique a été ignorée. |
threshold |
number |
valeur de seuil de critère qui active l’alerte. |
timeAggregation |
les types d’agrégation de temps de 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 de 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. |
spécifie le type des critères d’alerte. |
webTestId |
string |
ID de test web Application Insights. |