Udostępnij za pośrednictwem


Metric Alerts - List By Resource Group

Pobieranie definicji reguł alertów w grupie zasobów.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
resourceGroupName
path True

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

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 dotyczące listy alertów metryk

Other Status Codes

ErrorResponse

BadRequest

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

List metric alert rules

Przykładowe żądanie

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

Przykładowa odpowiedź

{
  "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
AdditionalInfo

Tablica obiektów z właściwościami "type" i "info". Schemat "info" jest specyficzny dla usługi i zależny od ciągu "type".

AggregationTypeEnum

kryteria agregacji czasu.

DynamicMetricCriteria

Kryterium progu dynamicznego.

DynamicThresholdFailingPeriods

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

DynamicThresholdOperator

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

DynamicThresholdSensitivity

Zakres odchylenia wymagany do wyzwolenia alertu. Będzie to miało wpływ na to, jak mocno próg jest do wzorca serii metryk.

Error
ErrorDetail

Opisuje szczegóły odpowiedzi na błąd.

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 dotyczącego 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.

AdditionalInfo

Tablica obiektów z właściwościami "type" i "info". Schemat "info" jest specyficzny dla usługi i zależny od ciągu "type".

Nazwa Typ Opis
info

object

Dodatkowe informacje specyficzne dla typu.

type

string

Typ dodatkowych informacji.

AggregationTypeEnum

kryteria agregacji czasu.

Nazwa Typ Opis
Average

string

Count

string

Maximum

string

Minimum

string

Total

string

DynamicMetricCriteria

Kryterium progu dynamicznego.

Nazwa Typ Opis
alertSensitivity

DynamicThresholdSensitivity

Zakres odchylenia wymagany do wyzwolenia alertu. Będzie to miało wpływ 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 wymaganym do zgłaszania alertu.

ignoreDataBefore

string

Użyj tej opcji, aby ustawić datę, od której chcesz rozpocząć naukę danych historycznych metryk 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 utworzenie reguły alertu dla metryki niestandardowej, która nie jest jeszcze emitowana, powodując pomijanie walidacji metryk.

timeAggregation

AggregationTypeEnum

kryteria agregacji czasu.

DynamicThresholdFailingPeriods

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

Nazwa Typ Opis
minFailingPeriodsToAlert

number

Liczba naruszeń wyzwalania alertu. 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 wymagany do wyzwolenia alertu. Będzie to miało wpływ na to, jak mocno próg jest do wzorca serii metryk.

Nazwa Typ Opis
High

string

Low

string

Medium

string

Error

Nazwa Typ Opis
additionalInfo

AdditionalInfo[]

Tablica obiektów z właściwościami "type" i "info". Schemat "info" jest specyficzny dla usługi i zależny od ciągu "type".

code

string

Nielokalizowany ciąg, który może służyć do programowego identyfikowania błędu.

details

ErrorDetail[]

Tablica dodatkowych obiektów informacji o błędach zagnieżdżonych zgodnie z opisem w tym kontrakcie.

message

string

Opisuje szczegółowo błąd i zawiera informacje o debugowaniu. Jeśli Accept-Language jest ustawiona w żądaniu, musi zostać zlokalizowana w tym języku.

target

string

Element docelowy określonego błędu (na przykład nazwa właściwości w błędzie).

ErrorDetail

Opisuje szczegóły odpowiedzi na błąd.

Nazwa Typ Opis
additionalInfo

AdditionalInfo[]

Tablica obiektów z właściwościami "type" i "info". Schemat "info" jest specyficzny dla usługi i zależny od ciągu "type".

code

string

Nielokalizowany ciąg, który może służyć do programowego identyfikowania błędu.

message

string

Opisuje szczegółowo błąd i zawiera informacje o debugowaniu.

target

string

Element docelowy określonego błędu (na przykład nazwa właściwości w błędzie).

ErrorResponse

Opisuje format odpowiedzi Błąd.

Nazwa Typ Opis
error

Error

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 "wszystkie".

odata.type string:

Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria

określa typ kryteriów alertu.

MetricAlertResource

Zasób alertu dotyczącego 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 stanie się aktywna, i gdy warunek alertu zostanie rozwiązany.

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

częstotliwość oceniania alertu metryki w formacie czasu trwania ISO 8601.

properties.isMigrated

boolean

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

properties.lastUpdatedTime

string

Ostatni raz reguła została zaktualizowana w formacie ISO8601.

properties.scopes

string[]

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

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ązkowy, jeśli zakres zawiera subskrypcję, grupę zasobów lub więcej niż jeden zasób.

properties.targetResourceType

string

typ zasobu zasobów docelowych, na których jest tworzony/aktualizowany alert. Obowiązkowy, 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 utworzenie reguły alertu dla metryki niestandardowej, która nie jest jeszcze emitowana, powodując pomijanie walidacji metryk.

threshold

number

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

timeAggregation

AggregationTypeEnum

kryteria agregacji czasu.

MetricDimension

Określa wymiar metryki.

Nazwa Typ Opis
name

string

Nazwa wymiaru.

operator

string

operator wymiaru. Obsługiwane są tylko "Dołączanie" i "Wykluczanie"

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 nieudanych lokalizacji.

odata.type string:

Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria

określa typ kryteriów alertu.

webTestId

string

Identyfikator testu internetowego usługi Application Insights.