Freigeben über


Metric Alerts - List By Resource Group

Ruft Warnungsregeldefinitionen in einer Ressourcengruppe ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
path True

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

subscriptionId
path True

string

Hierbei handelt es sich um die ID des Zielabonnements.

api-version
query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name Typ Beschreibung
200 OK

MetricAlertResourceCollection

Erfolgreiche Anforderung für eine Liste von Metrikwarnungen

Other Status Codes

ErrorResponse

BadRequest

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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/resourceGroups/gigtest/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
AggregationTypeEnum

die Kriterien für die Zeitaggregation.

DynamicMetricCriteria

Kriterium für den dynamischen Schwellenwert.

DynamicThresholdFailingPeriods

Die mindeste Anzahl von Verstößen, die innerhalb des ausgewählten Lookbackzeitfensters erforderlich sind, um eine Warnung auszulösen.

DynamicThresholdOperator

Der Operator, der verwendet wird, um den Metrikwert mit dem Schwellenwert zu vergleichen.

DynamicThresholdSensitivity

Das Ausmaß der Abweichung, die erforderlich ist, um eine Warnung auszulösen. Dies wirkt sich darauf aus, wie eng der Schwellenwert für das Metrikreihenmuster ist.

ErrorResponse

Beschreibt das Format der Fehlerantwort.

MetricAlertAction

Eine Warnungsaktion.

MetricAlertMultipleResourceMultipleMetricCriteria

Gibt die Metrikwarnungskriterien für mehrere Ressourcen an, die über mehrere Metrikkriterien verfügen.

MetricAlertResource

Die Metrikwarnungsressource.

MetricAlertResourceCollection

Stellt eine Auflistung von Warnungsregelressourcen dar.

MetricAlertSingleResourceMultipleMetricCriteria

Gibt die Metrikwarnungskriterien für eine einzelne Ressource an, die über mehrere Metrikkriterien verfügt.

MetricCriteria

Kriterium zum Filtern von Metriken.

MetricDimension

Gibt eine Metrikdimension an.

Operator

der Kriterienoperator.

WebtestLocationAvailabilityCriteria

Gibt die Metrikwarnungsregelkriterien für eine Webtestressource an.

AggregationTypeEnum

die Kriterien für die Zeitaggregation.

Name Typ Beschreibung
Average

string

Count

string

Maximum

string

Minimum

string

Total

string

DynamicMetricCriteria

Kriterium für den dynamischen Schwellenwert.

Name Typ Beschreibung
alertSensitivity

DynamicThresholdSensitivity

Das Ausmaß der Abweichung, die erforderlich ist, um eine Warnung auszulösen. Dies wirkt sich darauf aus, wie eng der Schwellenwert für das Metrikreihenmuster ist.

criterionType string:

DynamicThresholdCriterion

Gibt den Typ der Schwellenwertkriterien an.

dimensions

MetricDimension[]

Liste der Dimensionsbedingungen.

failingPeriods

DynamicThresholdFailingPeriods

Die mindeste Anzahl von Verstößen, die innerhalb des ausgewählten Lookbackzeitfensters erforderlich sind, um eine Warnung auszulösen.

ignoreDataBefore

string

Verwenden Sie diese Option, um das Datum festzulegen, ab dem mit dem Lernen der Metrikverlaufsdaten und der Berechnung der dynamischen Schwellenwerte (im format ISO8601) begonnen werden soll.

metricName

string

Der Name der Metrik.

metricNamespace

string

Namespace der Metrik.

name

string

Name der Kriterien.

operator

DynamicThresholdOperator

Der Operator, der verwendet wird, um den Metrikwert mit dem Schwellenwert zu vergleichen.

skipMetricValidation

boolean

Dadurch wird die Metrikvalidierung übersprungen, sodass eine Warnungsregel für eine benutzerdefinierte Metrik erstellt werden kann, die noch nicht ausgegeben wird.

timeAggregation

AggregationTypeEnum

die Kriterien für die Zeitaggregation.

DynamicThresholdFailingPeriods

Die mindeste Anzahl von Verstößen, die innerhalb des ausgewählten Lookbackzeitfensters erforderlich sind, um eine Warnung auszulösen.

Name Typ Beschreibung
minFailingPeriodsToAlert

number

Die Anzahl der Verstöße, die eine Warnung auslösen. Sollte kleiner oder gleich numberOfEvaluationPeriods sein.

numberOfEvaluationPeriods

number

Die Anzahl der aggregierten Lookbackpunkte. Das Lookbackzeitfenster wird basierend auf der Aggregationsgranularität (windowSize) und der ausgewählten Anzahl aggregierter Punkte berechnet.

DynamicThresholdOperator

Der Operator, der verwendet wird, um den Metrikwert mit dem Schwellenwert zu vergleichen.

Name Typ Beschreibung
GreaterOrLessThan

string

GreaterThan

string

LessThan

string

DynamicThresholdSensitivity

Das Ausmaß der Abweichung, die erforderlich ist, um eine Warnung auszulösen. Dies wirkt sich darauf aus, wie eng der Schwellenwert für das Metrikreihenmuster ist.

Name Typ Beschreibung
High

string

Low

string

Medium

string

ErrorResponse

Beschreibt das Format der Fehlerantwort.

Name Typ Beschreibung
code

string

Fehlercode

message

string

Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

MetricAlertAction

Eine Warnungsaktion.

Name Typ Beschreibung
actionGroupId

string

die ID der zu verwendenden Aktionsgruppe.

webHookProperties

object

Dieses Feld ermöglicht das Angeben benutzerdefinierter 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 über mehrere Metrikkriterien verfügen.

Name Typ Beschreibung
allOf MultiMetricCriteria[]:

die Liste mehrerer Metrikkriterien für diesen "All of"-Vorgang.

odata.type string:

Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria

gibt den Typ der Warnungskriterien an.

MetricAlertResource

Die Metrikwarnungsressource.

Name Typ Beschreibung
id

string

Azure-Ressourcen-ID

location

string

Ressourcenspeicherort

name

string

Name der Azure-Ressource

properties.actions

MetricAlertAction[]

das Array von Aktionen, die ausgeführt werden, wenn die Warnungsregel aktiv wird und wenn eine Warnungsbedingung aufgelöst wird.

properties.autoMitigate

boolean

das Flag, das angibt, ob die Warnung automatisch aufgelöst werden soll. Der Standardwert ist „true“.

properties.criteria MetricAlertCriteria:

definiert die spezifischen Informationen zu Warnungskriterien.

properties.description

string

Die Beschreibung der Metrikwarnung, die in der Warnungs-E-Mail enthalten sein wird.

properties.enabled

boolean

das Flag, das angibt, ob die Metrikwarnung aktiviert ist.

properties.evaluationFrequency

string

wie oft die Metrikwarnung ausgewertet wird, dargestellt im ISO 8601-Dauerformat.

properties.isMigrated

boolean

der Wert, der angibt, ob diese Warnungsregel migriert wird.

properties.lastUpdatedTime

string

Das letzte Mal wurde die Regel im ISO8601 Format aktualisiert.

properties.scopes

string[]

die Liste der Ressourcen-IDs, auf die diese Metrikwarnung ausgerichtet ist.

properties.severity

integer

Warnungsschweregrad {0, 1, 2, 3, 4}

properties.targetResourceRegion

string

die Region 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.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

der 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 Warnungsregelressourcen dar.

Name Typ Beschreibung
value

MetricAlertResource[]

die Werte für die Ressourcen der Warnungsregel.

MetricAlertSingleResourceMultipleMetricCriteria

Gibt die Metrikwarnungskriterien für eine einzelne Ressource an, die über mehrere Metrikkriterien verfügt.

Name Typ Beschreibung
allOf

MetricCriteria[]

Die Liste der Metrikkriterien für diesen "All of"-Vorgang.

odata.type string:

Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria

gibt den Typ der Warnungskriterien an.

MetricCriteria

Kriterium zum Filtern von Metriken.

Name Typ Beschreibung
criterionType string:

StaticThresholdCriterion

Gibt den Typ der Schwellenwertkriterien an.

dimensions

MetricDimension[]

Liste der Dimensionsbedingungen.

metricName

string

Der Name der Metrik.

metricNamespace

string

Namespace der Metrik.

name

string

Name der Kriterien.

operator

Operator

der Kriterienoperator.

skipMetricValidation

boolean

Dadurch wird die Metrikvalidierung übersprungen, sodass eine Warnungsregel für eine benutzerdefinierte Metrik erstellt werden kann, die noch nicht ausgegeben wird.

threshold

number

der Schwellenwert für Kriterien, der die Warnung aktiviert.

timeAggregation

AggregationTypeEnum

die Kriterien für die Zeitaggregation.

MetricDimension

Gibt eine Metrikdimension an.

Name Typ Beschreibung
name

string

Name der Dimension.

operator

string

der Dimensionsoperator. Nur "Include" und "Exclude" werden unterstützt.

values

string[]

Liste der Dimensionswerte.

Operator

der Kriterienoperator.

Name Typ Beschreibung
Equals

string

GreaterThan

string

GreaterThanOrEqual

string

LessThan

string

LessThanOrEqual

string

WebtestLocationAvailabilityCriteria

Gibt die Metrikwarnungsregelkriterien für eine Webtestressource an.

Name Typ Beschreibung
componentId

string

Die Application Insights-Ressourcen-ID.

failedLocationCount

number

Die Anzahl der fehlerhaften Speicherorte.

odata.type string:

Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria

gibt den Typ der Warnungskriterien an.

webTestId

string

Die Application Insights-Webtest-ID.