Metric Alerts - List By Subscription
Abrufen von Warnungsregeldefinitionen in einem Abonnement.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/metricAlerts?api-version=2018-03-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
subscription
|
path | True |
string |
Die ID des Zielabonnements. |
api-version
|
query | True |
string |
Die API-Version, die für diesen Vorgang verwendet werden soll. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Erfolgreiche Anforderung für eine Liste von Metrikwarnungen |
|
Other Status Codes |
BadRequest |
Sicherheit
azure_auth
Azure Active Directory OAuth2-Fluss
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel ihres Benutzerkontos |
Beispiele
List metric alert rules
Beispielanforderung
GET https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/providers/Microsoft.Insights/metricAlerts?api-version=2018-03-01
Beispiel für eine Antwort
{
"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"
}
}
]
}
}
]
}
Definitionen
Name | Beschreibung |
---|---|
Additional |
Ein Array von Objekten mit eigenschaften "type" und "info". Das Schema von "info" ist dienstspezifisch und abhängig von der Zeichenfolge "type". |
Aggregation |
die Kriterien-Zeitaggregationstypen. |
Dynamic |
Kriterium für den dynamischen Schwellenwert. |
Dynamic |
Die minimale Anzahl von Verletzungen, die innerhalb des ausgewählten Nachschlagezeitfensters erforderlich sind, um eine Warnung auszuheben. |
Dynamic |
Der Operator, der zum Vergleichen des Metrikwerts mit dem Schwellenwert verwendet wird. |
Dynamic |
Der Umfang der Abweichung, die erforderlich ist, um eine Warnung auszulösen. Dies wirkt sich darauf aus, wie eng der Schwellenwert für das metrische Reihenmuster ist. |
Error | |
Error |
Beschreibt Details einer Fehlerantwort. |
Error |
Beschreibt das Format der Fehlerantwort. |
Metric |
Eine Warnungsaktion. |
Metric |
Gibt die Metrikwarnungskriterien für mehrere Ressourcen an, die mehrere Metrikkriterien enthalten. |
Metric |
Die metrische Warnungsressource. |
Metric |
Stellt eine Auflistung von Ressourcen für Warnungsregel dar. |
Metric |
Gibt die Metrikwarnungskriterien für eine einzelne Ressource an, die mehrere Metrikkriterien enthält. |
Metric |
Kriterium zum Filtern von Metriken. |
Metric |
Gibt eine Metrikdimension an. |
Operator |
den Kriterienoperator. |
Webtest |
Gibt die Kriterien für metrikbezogene Warnungsregel für eine Webtestressource an. |
AdditionalInfo
Ein Array von Objekten mit eigenschaften "type" und "info". Das Schema von "info" ist dienstspezifisch und abhängig von der Zeichenfolge "type".
Name | Typ | Beschreibung |
---|---|---|
info |
object |
Die zusätzlichen Informationen, die für den Typ spezifisch sind. |
type |
string |
Der Typ der zusätzlichen Informationen. |
AggregationTypeEnum
die Kriterien-Zeitaggregationstypen.
Name | Typ | Beschreibung |
---|---|---|
Average |
string |
|
Count |
string |
|
Maximum |
string |
|
Minimum |
string |
|
Total |
string |
DynamicMetricCriteria
Kriterium für den dynamischen Schwellenwert.
Name | Typ | Beschreibung |
---|---|---|
alertSensitivity |
Der Umfang der Abweichung, die erforderlich ist, um eine Warnung auszulösen. Dies wirkt sich darauf aus, wie eng der Schwellenwert für das metrische Reihenmuster ist. |
|
criterionType |
string:
Dynamic |
Gibt den Typ der Schwellenwertkriterien an. |
dimensions |
Liste der Dimensionsbedingungen. |
|
failingPeriods |
Die minimale Anzahl von Verletzungen, die innerhalb des ausgewählten Nachschlagezeitfensters erforderlich sind, um eine Warnung auszuheben. |
|
ignoreDataBefore |
string |
Verwenden Sie diese Option, um das Datum festzulegen, ab dem sie mit dem Erlernen der metrischen Verlaufsdaten beginnen und die dynamischen Schwellenwerte (im ISO8601 Format) berechnen möchten. |
metricName |
string |
Name der Metrik. |
metricNamespace |
string |
Namespace der Metrik. |
name |
string |
Name der Kriterien. |
operator |
Der Operator, der zum Vergleichen des Metrikwerts mit dem Schwellenwert verwendet wird. |
|
skipMetricValidation |
boolean |
Ermöglicht das Erstellen einer Warnungsregel für eine benutzerdefinierte Metrik, die noch nicht ausgegeben wird, indem die Metriküberprüfung übersprungen wird. |
timeAggregation |
die Kriterien-Zeitaggregationstypen. |
DynamicThresholdFailingPeriods
Die minimale Anzahl von Verletzungen, die innerhalb des ausgewählten Nachschlagezeitfensters erforderlich sind, um eine Warnung auszuheben.
Name | Typ | Beschreibung |
---|---|---|
minFailingPeriodsToAlert |
number |
Die Anzahl der Verletzungen, um eine Warnung auszulösen. Sollte kleiner oder gleich "NumberOfEvaluationPeriods" sein. |
numberOfEvaluationPeriods |
number |
Die Anzahl der aggregierten Lookbackpunkte. Das Nachschlagezeitfenster wird basierend auf der Aggregations granularität (windowSize) und der ausgewählten Anzahl aggregierter Punkte berechnet. |
DynamicThresholdOperator
Der Operator, der zum Vergleichen des Metrikwerts mit dem Schwellenwert verwendet wird.
Name | Typ | Beschreibung |
---|---|---|
GreaterOrLessThan |
string |
|
GreaterThan |
string |
|
LessThan |
string |
DynamicThresholdSensitivity
Der Umfang der Abweichung, die erforderlich ist, um eine Warnung auszulösen. Dies wirkt sich darauf aus, wie eng der Schwellenwert für das metrische Reihenmuster ist.
Name | Typ | Beschreibung |
---|---|---|
High |
string |
|
Low |
string |
|
Medium |
string |
Error
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Ein Array von Objekten mit eigenschaften "type" und "info". Das Schema von "info" ist dienstspezifisch und abhängig von der Zeichenfolge "type". |
|
code |
string |
Nicht lokalisierte Zeichenfolge, die zum programmgesteuerten Identifizieren des Fehlers verwendet werden kann. |
details |
Ein Array zusätzlicher geschachtelter Fehlerantwort-Infoobjekte, wie in diesem Vertrag beschrieben. |
|
message |
string |
Beschreibt den Fehler im Detail und stellt Debuginformationen bereit. Wenn Accept-Language in der Anforderung festgelegt ist, muss sie in diese Sprache lokalisiert werden. |
target |
string |
Das Ziel des bestimmten Fehlers (z. B. der Name der Eigenschaft im Fehler). |
ErrorDetail
Beschreibt Details einer Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Ein Array von Objekten mit eigenschaften "type" und "info". Das Schema von "info" ist dienstspezifisch und abhängig von der Zeichenfolge "type". |
|
code |
string |
Nicht lokalisierte Zeichenfolge, die zum programmgesteuerten Identifizieren des Fehlers verwendet werden kann. |
message |
string |
Beschreibt den Fehler im Detail und stellt Debuginformationen bereit. |
target |
string |
Das Ziel des bestimmten Fehlers (z. B. der Name der Eigenschaft im Fehler). |
ErrorResponse
Beschreibt das Format der Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
error |
MetricAlertAction
Eine Warnungsaktion.
Name | Typ | Beschreibung |
---|---|---|
actionGroupId |
string |
die ID der zu verwendenden Aktionsgruppe. |
webHookProperties |
object |
Dieses Feld ermöglicht das Angeben von benutzerdefinierten Eigenschaften, die an die Warnungsnutzlast angefügt werden, die als Eingabe an den Webhook gesendet wird. |
MetricAlertMultipleResourceMultipleMetricCriteria
Gibt die Metrikwarnungskriterien für mehrere Ressourcen an, die mehrere Metrikkriterien enthalten.
Name | Typ | Beschreibung |
---|---|---|
allOf | MultiMetricCriteria[]: |
die Liste mit mehreren Metrikkriterien für diesen "all of"-Vorgang. |
odata.type |
string:
Microsoft. |
Gibt den Typ der Warnungskriterien an. |
MetricAlertResource
Die metrische Warnungsressource.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Azure-Ressourcen-ID |
location |
string |
Ressourcenspeicherort |
name |
string |
Azure-Ressourcenname |
properties.actions |
das Array von Aktionen, die ausgeführt werden, wenn die Warnungsregel aktiv wird und wenn eine Warnungsbedingung aufgelöst wird. |
|
properties.autoMitigate |
boolean |
das Kennzeichen, das angibt, ob die Warnung automatisch aufgelöst werden soll oder nicht. Der Standardwert ist "true". |
properties.criteria | MetricAlertCriteria: |
definiert die spezifischen Warnungskriterieninformationen. |
properties.description |
string |
die Beschreibung der Metrikwarnung, die in die Benachrichtigungs-E-Mail aufgenommen wird. |
properties.enabled |
boolean |
das Flag, das angibt, ob die Metrikwarnung aktiviert ist. |
properties.evaluationFrequency |
string |
wie oft die Metrikwarnung im ISO 8601-Dauerformat ausgewertet wird. |
properties.isMigrated |
boolean |
der Wert, der angibt, ob diese Warnungsregel migriert wird. |
properties.lastUpdatedTime |
string |
Zeitpunkt der letzten Aktualisierung der Regel im ISO8601 Format. |
properties.scopes |
string[] |
die Liste der Ressourcen-IDs, auf die diese Metrikwarnung abgegrenzt ist. |
properties.severity |
integer |
Warnungsschweregrad {0, 1, 2, 3, 4} |
properties.targetResourceRegion |
string |
die Region der Zielressource(n), in der die Warnung erstellt/aktualisiert wird. Obligatorisch, wenn der Bereich ein Abonnement, eine Ressourcengruppe oder mehrere Ressourcen enthält. |
properties.targetResourceType |
string |
der Ressourcentyp der Zielressource(n), für die die Warnung erstellt/aktualisiert wird. Obligatorisch, wenn der Bereich ein Abonnement, eine Ressourcengruppe oder mehrere Ressourcen enthält. |
properties.windowSize |
string |
den Zeitraum (im ISO 8601-Dauerformat), der zum Überwachen der Warnungsaktivität basierend auf dem Schwellenwert verwendet wird. |
tags |
object |
Ressourcentags |
type |
string |
Azure-Ressourcentyp |
MetricAlertResourceCollection
Stellt eine Auflistung von Ressourcen für Warnungsregel dar.
Name | Typ | Beschreibung |
---|---|---|
value |
die Werte für die Ressourcen der Warnungsregel. |
MetricAlertSingleResourceMultipleMetricCriteria
Gibt die Metrikwarnungskriterien für eine einzelne Ressource an, die mehrere Metrikkriterien enthält.
Name | Typ | Beschreibung |
---|---|---|
allOf |
Die Liste der Metrikkriterien für diesen "all of"-Vorgang. |
|
odata.type |
string:
Microsoft. |
Gibt den Typ der Warnungskriterien an. |
MetricCriteria
Kriterium zum Filtern von Metriken.
Name | Typ | Beschreibung |
---|---|---|
criterionType |
string:
Static |
Gibt den Typ der Schwellenwertkriterien an. |
dimensions |
Liste der Dimensionsbedingungen. |
|
metricName |
string |
Name der Metrik. |
metricNamespace |
string |
Namespace der Metrik. |
name |
string |
Name der Kriterien. |
operator |
den Kriterienoperator. |
|
skipMetricValidation |
boolean |
Ermöglicht das Erstellen einer Warnungsregel für eine benutzerdefinierte Metrik, die noch nicht ausgegeben wird, indem die Metriküberprüfung übersprungen wird. |
threshold |
number |
der Schwellenwert für Kriterien, der die Warnung aktiviert. |
timeAggregation |
die Kriterien-Zeitaggregationstypen. |
MetricDimension
Gibt eine Metrikdimension an.
Name | Typ | Beschreibung |
---|---|---|
name |
string |
Name der Dimension. |
operator |
string |
der Bemaßungsoperator. Es werden nur 'Include' und 'Exclude' unterstützt. |
values |
string[] |
Liste der Dimensionswerte. |
Operator
den Kriterienoperator.
Name | Typ | Beschreibung |
---|---|---|
Equals |
string |
|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
WebtestLocationAvailabilityCriteria
Gibt die Kriterien für metrikbezogene Warnungsregel für eine Webtestressource an.
Name | Typ | Beschreibung |
---|---|---|
componentId |
string |
Die Application Insights-Ressourcen-ID. |
failedLocationCount |
number |
Die Anzahl der fehlgeschlagenen Speicherorte. |
odata.type |
string:
Microsoft. |
Gibt den Typ der Warnungskriterien an. |
webTestId |
string |
Die Application Insights-Webtest-ID. |