Metric Alerts - List By Subscription

Pobieranie definicji reguł alertów w subskrypcji.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
subscriptionId
path True

string

Identyfikator subskrypcji docelowej.

api-version
query True

string

Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa Typ Opis
200 OK

MetricAlertResourceCollection

Pomyślne żądanie listy alertów dotyczących metryk

Other Status Codes

ErrorResponse

BadRequest

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

List metric alert rules

Sample Request

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

Sample Response

{
  "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"
            }
          }
        ]
      }
    }
  ]
}

Definicje

Nazwa Opis
AggregationTypeEnum

typy agregacji czasu kryteriów.

DynamicMetricCriteria

Kryterium progu dynamicznego.

DynamicThresholdFailingPeriods

Minimalna liczba naruszeń wymaganych w wybranym przedziale czasu wyszukiwania wymaganego do zgłaszania alertu.

DynamicThresholdOperator

Operator używany do porównywania wartości metryki z progiem.

DynamicThresholdSensitivity

Zakres odchylenia wymaganego do wyzwolenia alertu. Wpłynie to na to, jak mocno próg jest do wzorca serii metryk.

ErrorResponse

Opisuje format odpowiedzi Błąd.

MetricAlertAction

Akcja alertu.

MetricAlertMultipleResourceMultipleMetricCriteria

Określa kryteria alertu metryki dla wielu zasobów, które mają wiele kryteriów metryk.

MetricAlertResource

Zasób alertu metryki.

MetricAlertResourceCollection

Reprezentuje kolekcję zasobów reguły alertu.

MetricAlertSingleResourceMultipleMetricCriteria

Określa kryteria alertu metryki dla pojedynczego zasobu, który ma wiele kryteriów metryk.

MetricCriteria

Kryterium filtrowania metryk.

MetricDimension

Określa wymiar metryki.

Operator

operator kryteriów.

WebtestLocationAvailabilityCriteria

Określa kryteria reguły alertu metryki dla zasobu testu internetowego.

AggregationTypeEnum

typy agregacji czasu kryteriów.

Nazwa Typ Opis
Average

string

Count

string

Maximum

string

Minimum

string

Total

string

DynamicMetricCriteria

Kryterium progu dynamicznego.

Nazwa Typ Opis
alertSensitivity

DynamicThresholdSensitivity

Zakres odchylenia wymaganego do wyzwolenia alertu. Wpłynie to na to, jak mocno próg jest do wzorca serii metryk.

criterionType string:

DynamicThresholdCriterion

Określa typ kryteriów progowych

dimensions

MetricDimension[]

Lista warunków wymiarów.

failingPeriods

DynamicThresholdFailingPeriods

Minimalna liczba naruszeń wymaganych w wybranym przedziale czasu wyszukiwania wymaganego do zgłaszania alertu.

ignoreDataBefore

string

Użyj tej opcji, aby ustawić datę rozpoczęcia uczenia się danych historycznych metryki i obliczyć progi dynamiczne (w formacie ISO8601)

metricName

string

Nazwa metryki.

metricNamespace

string

Przestrzeń nazw metryki.

name

string

Nazwa kryteriów.

operator

DynamicThresholdOperator

Operator używany do porównywania wartości metryki z progiem.

skipMetricValidation

boolean

Umożliwia on utworzenie reguły alertu na podstawie niestandardowej metryki, która nie została jeszcze wyemitowana, co powoduje pominięcie sprawdzania poprawności metryki.

timeAggregation

AggregationTypeEnum

typy agregacji czasu kryteriów.

DynamicThresholdFailingPeriods

Minimalna liczba naruszeń wymaganych w wybranym przedziale czasu wyszukiwania wymaganego do zgłaszania alertu.

Nazwa Typ Opis
minFailingPeriodsToAlert

number

Liczba naruszeń wyzwalanych przez alert. Powinna być mniejsza lub równa numberOfEvaluationPeriods.

numberOfEvaluationPeriods

number

Liczba zagregowanych punktów wyszukiwania. Przedział czasu wyszukiwania jest obliczany na podstawie stopnia szczegółowości agregacji (windowSize) i wybranej liczby zagregowanych punktów.

DynamicThresholdOperator

Operator używany do porównywania wartości metryki z progiem.

Nazwa Typ Opis
GreaterOrLessThan

string

GreaterThan

string

LessThan

string

DynamicThresholdSensitivity

Zakres odchylenia wymaganego do wyzwolenia alertu. Wpłynie to na to, jak mocno próg jest do wzorca serii metryk.

Nazwa Typ Opis
High

string

Low

string

Medium

string

ErrorResponse

Opisuje format odpowiedzi Błąd.

Nazwa Typ Opis
code

string

Kod błędu

message

string

Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

MetricAlertAction

Akcja alertu.

Nazwa Typ Opis
actionGroupId

string

identyfikator grupy akcji do użycia.

webHookProperties

object

To pole umożliwia określenie właściwości niestandardowych, które zostaną dołączone do ładunku alertu wysłanego jako dane wejściowe do elementu webhook.

MetricAlertMultipleResourceMultipleMetricCriteria

Określa kryteria alertu metryki dla wielu zasobów, które mają wiele kryteriów metryk.

Nazwa Typ Opis
allOf MultiMetricCriteria[]:

lista wielu kryteriów metryk dla tej operacji "wszystko".

odata.type string:

Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria

określa typ kryteriów alertu.

MetricAlertResource

Zasób alertu metryki.

Nazwa Typ Opis
id

string

Identyfikator zasobu platformy Azure

location

string

Lokalizacja zasobu

name

string

Nazwa zasobu platformy Azure

properties.actions

MetricAlertAction[]

tablica akcji, które są wykonywane, gdy reguła alertu staje się aktywna, a po rozwiązaniu warunku alertu.

properties.autoMitigate

boolean

flaga wskazująca, czy alert powinien zostać automatycznie rozwiązany, czy nie. Wartość domyślna to true.

properties.criteria MetricAlertCriteria:

definiuje określone informacje o kryteriach alertu.

properties.description

string

opis alertu dotyczącego metryk, który zostanie uwzględniony w wiadomości e-mail z alertem.

properties.enabled

boolean

flaga wskazująca, czy alert metryki jest włączony.

properties.evaluationFrequency

string

jak często alert metryki jest oceniany w formacie czasu trwania ISO 8601.

properties.isMigrated

boolean

wartość wskazująca, czy ta reguła alertu jest migrowana.

properties.lastUpdatedTime

string

Czas ostatniej aktualizacji reguły w formacie ISO8601.

properties.scopes

string[]

lista identyfikatorów zasobów, do których ten alert metryki ma zakres.

properties.severity

integer

Ważność alertu {0, 1, 2, 3, 4}

properties.targetResourceRegion

string

region zasobów docelowych, na których jest tworzony/aktualizowany alert. Obowiązkowe, jeśli zakres zawiera subskrypcję, grupę zasobów lub więcej niż jeden zasób.

properties.targetResourceType

string

typ zasobu docelowego zasobów, na których jest tworzony/aktualizowany alert. Obowiązkowe, jeśli zakres zawiera subskrypcję, grupę zasobów lub więcej niż jeden zasób.

properties.windowSize

string

okres czasu (w formacie czasu trwania ISO 8601) używany do monitorowania aktywności alertów na podstawie progu.

tags

object

Tagi zasobów

type

string

Typ zasobu platformy Azure

MetricAlertResourceCollection

Reprezentuje kolekcję zasobów reguły alertu.

Nazwa Typ Opis
value

MetricAlertResource[]

wartości zasobów reguły alertu.

MetricAlertSingleResourceMultipleMetricCriteria

Określa kryteria alertu metryki dla pojedynczego zasobu, który ma wiele kryteriów metryk.

Nazwa Typ Opis
allOf

MetricCriteria[]

Lista kryteriów metryk dla tej operacji "wszystkie".

odata.type string:

Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria

określa typ kryteriów alertu.

MetricCriteria

Kryterium filtrowania metryk.

Nazwa Typ Opis
criterionType string:

StaticThresholdCriterion

Określa typ kryteriów progowych

dimensions

MetricDimension[]

Lista warunków wymiarów.

metricName

string

Nazwa metryki.

metricNamespace

string

Przestrzeń nazw metryki.

name

string

Nazwa kryteriów.

operator

Operator

operator kryteriów.

skipMetricValidation

boolean

Umożliwia on utworzenie reguły alertu na podstawie niestandardowej metryki, która nie została jeszcze wyemitowana, co powoduje pominięcie sprawdzania poprawności metryki.

threshold

number

wartość progowa kryteriów, która aktywuje alert.

timeAggregation

AggregationTypeEnum

typy agregacji czasu kryteriów.

MetricDimension

Określa wymiar metryki.

Nazwa Typ Opis
name

string

Nazwa wymiaru.

operator

string

operator wymiaru. Obsługiwane są tylko elementy "Include" i "Exclude"

values

string[]

lista wartości wymiarów.

Operator

operator kryteriów.

Nazwa Typ Opis
Equals

string

GreaterThan

string

GreaterThanOrEqual

string

LessThan

string

LessThanOrEqual

string

WebtestLocationAvailabilityCriteria

Określa kryteria reguły alertu metryki dla zasobu testu internetowego.

Nazwa Typ Opis
componentId

string

Identyfikator zasobu usługi Application Insights.

failedLocationCount

number

Liczba lokalizacji zakończonych niepowodzeniem.

odata.type string:

Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria

określa typ kryteriów alertu.

webTestId

string

Identyfikator testu internetowego usługi Application Insights.