Metric Alerts - List By Resource Group

Hívd le a riasztási szabálydefiníciókat egy erőforráscsoportban.

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

URI-paraméterek

Name In Kötelező Típus Description
resourceGroupName
path True

string

minLength: 1
maxLength: 90

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

subscriptionId
path True

string

minLength: 1

A cél-előfizetés azonosítója.

api-version
query True

string

minLength: 1

A művelethez használandó API-verzió.

Válaszok

Name Típus Description
200 OK

MetricAlertResourceCollection

Az Azure működése sikeresen befejeződött.

Other Status Codes

MetricAlertErrorResponse

Váratlan hibaválasz.

Biztonság

azure_auth

Azure Active Directory Oauth2-folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name Description
user_impersonation a felhasználói fiók megszemélyesítése

Példák

List metric alert rules

Mintakérelem

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

Mintaválasz

{
  "value": [
    {
      "type": "Microsoft.Insights/metricAlerts",
      "id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/highcpu",
      "location": "global",
      "properties": {
        "description": "This is the description of the rule1",
        "actions": [
          {
            "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
            "webHookProperties": {
              "key11": "value11",
              "key12": "value12"
            }
          }
        ],
        "criteria": {
          "allOf": [
            {
              "name": "High_CPU_80",
              "criterionType": "StaticThresholdCriterion",
              "dimensions": [],
              "metricName": "CustomMetric_\\Processor(_Total)\\% Processor Time",
              "operator": "GreaterThan",
              "threshold": 80.5,
              "timeAggregation": "Average"
            }
          ],
          "odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria"
        },
        "enabled": true,
        "evaluationFrequency": "PT1M",
        "scopes": [
          "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
        ],
        "severity": 3,
        "windowSize": "PT15M"
      },
      "tags": {
        "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
      }
    },
    {
      "type": "Microsoft.Insights/metricAlerts",
      "id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/mediumcpu",
      "location": "global",
      "properties": {
        "description": "Med cpu alert",
        "actions": [
          {
            "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
            "webHookProperties": {
              "key11": "value11",
              "key12": "value12"
            }
          }
        ],
        "criteria": {
          "allOf": [
            {
              "name": "Medium_CPU_50",
              "criterionType": "StaticThresholdCriterion",
              "dimensions": [],
              "metricName": "CustomMetric_\\Processor(_Total)\\% Processor Time",
              "operator": "GreaterThan",
              "threshold": 50.5,
              "timeAggregation": "Average"
            }
          ],
          "odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria"
        },
        "enabled": true,
        "evaluationFrequency": "PT1M",
        "scopes": [
          "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
        ],
        "severity": 4,
        "windowSize": "PT15M"
      },
      "tags": {
        "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
      }
    }
  ]
}

Definíciók

Name Description
AggregationTypeEnum

A feltételek időösszesítési típusai. Előfordulhat, hogy a korábban nem dokumentált értékek visszaadhatók

createdByType

Az erőforrást létrehozó identitás típusa.

DynamicMetricCriteria

A dinamikus küszöb kritériuma.

DynamicPromQLCriteria

A dinamikus bál lekérdezés kritériuma.

DynamicThresholdFailingPeriods

A riasztás létrehozásához szükséges minimális számú szabálysértés a kijelölt visszatekintési időkereten belül.

DynamicThresholdOperator

A metrikaérték és a küszöbérték összehasonlítására használt operátor. Előfordulhat, hogy a korábban nem dokumentált értékek visszaadhatók

DynamicThresholdSensitivity

A riasztás indításához szükséges eltérés mértéke. Ez hatással lesz arra, hogy a küszöbérték mennyire szűk a metrikasorozat-mintához. Előfordulhat, hogy a korábban nem dokumentált értékek visszaadhatók

IdentityType

A felügyelt szolgáltatás identitásának típusa.

MetricAlertAction

Riasztási művelet.

MetricAlertErrorResponse

A hibaválasz formátumát ismerteti.

MetricAlertMultipleResourceMultipleMetricCriteria

Megadja a metrikus riasztási kritériumokat több olyan erőforrásra, amelynek több metrikus kritériuma van.

MetricAlertResource

A metrikus riasztási forrás.

MetricAlertResourceCollection

A riasztási szabály erőforrásainak gyűjteményét jelöli.

MetricAlertSingleResourceMultipleMetricCriteria

Megadja a metrikai riasztási kritériumokat egyetlen erőforrásra, amelynek több metrikus kritériuma van.

MetricCriteria

Criterion a metrikák szűrésére.

MetricDimension

Metrikai dimenziót határoz meg.

Microsoft.Common.ErrorDetail

Leírja a hibaválasz részleteit.

Microsoft.Common.ErrorDetailAdditionalInfoItem
Microsoft.Common.ErrorResponseError
Microsoft.Common.ErrorResponseErrorAdditionalInfoItem
Microsoft.Common.Identity

Az erőforrás identitása.

Microsoft.Common.UserIdentityProperties

A felhasználó által kijelölt identitás tulajdonságai.

Odatatype

Megadja a riasztási feltételek típusát. Előfordulhat, hogy a korábban nem dokumentált értékek visszaadhatók

Operator

A feltétel operátora. Előfordulhat, hogy a korábban nem dokumentált értékek visszaadhatók

PromQLCriteria

Megadja a PromQL kritériumokat a metrikus riasztási erőforráshoz.

QueryFailingPeriods

A lekérdezésalapú riasztások sikertelen időszakainak konfigurálása.

ResolveConfiguration
StaticPromQLCriteria

A statikus bál lekérdezés kritériuma.

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

WebtestLocationAvailabilityCriteria

Megadja a metrikus riasztási szabály feltételeit egy webteszt forráshoz.

AggregationTypeEnum

A feltételek időösszesítési típusai. Előfordulhat, hogy a korábban nem dokumentált értékek visszaadhatók

Érték Description
Average

Átlag

Count

Count

Minimum

Legkevesebb

Maximum

Legnagyobb érték

Total

Összesen

createdByType

Az erőforrást létrehozó identitás típusa.

Érték Description
User
Application
ManagedIdentity
Key

DynamicMetricCriteria

A dinamikus küszöb kritériuma.

Name Típus Description
alertSensitivity

DynamicThresholdSensitivity

A riasztás indításához szükséges eltérés mértéke. Ez hatással lesz arra, hogy a küszöbérték mennyire szűk a metrikasorozat-mintához. Előfordulhat, hogy a korábban nem dokumentált értékek visszaadhatók

criterionType string:

DynamicThresholdCriterion

Megadja a küszöbértékek típusát. Előfordulhat, hogy a korábban nem dokumentált értékek visszaadhatók

dimensions

MetricDimension[]

A dimenziófeltételek listája.

failingPeriods

DynamicThresholdFailingPeriods

A riasztás létrehozásához szükséges minimális számú szabálysértés a kijelölt visszatekintési időkereten belül.

ignoreDataBefore

string (date-time)

Ezzel a beállítással megadhatja a metrika előzményadatainak megismerésének és a dinamikus küszöbértékek kiszámításának dátumát (ISO8601 formátumban)

metricName

string

A metrika neve.

metricNamespace

string

a metrika Namespace.

name

string

A feltétel neve.

operator

DynamicThresholdOperator

A metrikaérték és a küszöbérték összehasonlítására használt operátor. Előfordulhat, hogy a korábban nem dokumentált értékek visszaadhatók

skipMetricValidation

boolean

Lehetővé teszi, hogy riasztási szabályt hozzon létre egy olyan egyéni metrikán, amely még nincs kibocsátva, mert a metrikaérvényesítést kihagyja.

timeAggregation

AggregationTypeEnum

A feltételek időösszesítési típusai. Előfordulhat, hogy a korábban nem dokumentált értékek visszaadhatók

DynamicPromQLCriteria

A dinamikus bál lekérdezés kritériuma.

Name Típus Description
alertSensitivity

DynamicThresholdSensitivity

A riasztás indításához szükséges eltérés mértéke. Ez hatással lesz arra, hogy a küszöbérték mennyire szűk a metrikasorozat-mintához. Előfordulhat, hogy a korábban nem dokumentált értékek visszaadhatók

criterionType string:

DynamicThresholdCriterion

Megadja a küszöbértékek típusát. Előfordulhat, hogy a korábban nem dokumentált értékek visszaadhatók

ignoreDataBefore

string (date-time)

Ezzel a beállítással megadhatja a metrika előzményadatainak megismerésének és a dinamikus küszöbértékek kiszámításának dátumát (ISO8601 formátumban)

name

string

A feltétel neve.

operator

DynamicThresholdOperator

A metrikaérték és a küszöbérték összehasonlítására használt operátor. Előfordulhat, hogy a korábban nem dokumentált értékek visszaadhatók

query

string

A riasztási szabály kiértékeléséhez használt lekérdezés

DynamicThresholdFailingPeriods

A riasztás létrehozásához szükséges minimális számú szabálysértés a kijelölt visszatekintési időkereten belül.

Name Típus Description
minFailingPeriodsToAlert

number (float)

A riasztások indításához tartozó szabálysértések száma. Kisebbnek vagy egyenlőnek kell lennie a numberOfEvaluationPeriods értékével.

numberOfEvaluationPeriods

number (float)

Az összesített visszatekintési pontok száma. A visszatekintési időablak kiszámítása az összesítés részletessége (windowSize) és az összesített pontok kiválasztott száma alapján történik.

DynamicThresholdOperator

A metrikaérték és a küszöbérték összehasonlítására használt operátor. Előfordulhat, hogy a korábban nem dokumentált értékek visszaadhatók

Érték Description
GreaterThan

GreaterThan

LessThan

Kevesebb mint

GreaterOrLessThan

NagyobbVagy KevesebbMint

DynamicThresholdSensitivity

A riasztás indításához szükséges eltérés mértéke. Ez hatással lesz arra, hogy a küszöbérték mennyire szűk a metrikasorozat-mintához. Előfordulhat, hogy a korábban nem dokumentált értékek visszaadhatók

Érték Description
Low

Low

Medium

Medium

High

Magas

IdentityType

A felügyelt szolgáltatás identitásának típusa.

Érték Description
SystemAssigned

Rendszer Által Hozzárendelve

UserAssigned

UserAssigned

None

Nincs

MetricAlertAction

Riasztási művelet.

Name Típus Description
actionGroupId

string

A használni kívánt műveletcsoport azonosítója.

webHookProperties

object

Ez a mező egyéni tulajdonságok megadását teszi lehetővé, amelyeket hozzáfűz a webhook bemeneteként küldött riasztás hasznos adataihoz.

MetricAlertErrorResponse

A hibaválasz formátumát ismerteti.

Name Típus Description
error

Microsoft.Common.ErrorResponseError

MetricAlertMultipleResourceMultipleMetricCriteria

Megadja a metrikus riasztási kritériumokat több olyan erőforrásra, amelynek több metrikus kritériuma van.

Name Típus Description
allOf MultiMetricCriteria[]:

Az "összes" művelet több metrikafeltételének listája.

odata.type string:

Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria

Megadja a riasztási feltételek típusát. Előfordulhat, hogy a korábban nem dokumentált értékek visszaadhatók

MetricAlertResource

A metrikus riasztási forrás.

Name Típus Description
id

string

Az erőforrás teljes erőforrás-azonosítója. Example - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Microsoft.Common.Identity

Az erőforrás identitása.

location

string

Az a földrajzi hely, ahol az erőforrás él

name

string

Az erőforrás neve

properties.actionProperties

object

A művelettulajdonságok tulajdonságai.

properties.actions

MetricAlertAction[]

A riasztási szabály aktívvá válásakor és egy riasztási feltétel feloldásakor végrehajtott műveletek tömbje.

properties.autoMitigate

boolean

Az a jelző, amely jelzi, hogy a riasztást automatikusan fel kell-e oldani. Az alapértelmezett érték igaz.

properties.criteria MetricAlertCriteria:

Meghatározza az adott riasztási feltételek adatait.

properties.customProperties

object

A riasztás hasznos adatainak tulajdonságai.

properties.description

string

A riasztási e-mailben szereplő metrikariasztás leírása.

properties.enabled

boolean

Az a jelző, amely azt jelzi, hogy a metrikariasztás engedélyezve van-e.

properties.evaluationFrequency

string (duration)

A metrikariasztás kiértékelésének gyakorisága ISO 8601 időtartamú formátumban jelenik meg.

properties.isMigrated

boolean

Az érték, amely jelzi, hogy ez a riasztási szabály átvándorolt-e.

properties.lastUpdatedTime

string (date-time)

Legutóbb a szabályt ISO8601 formátumban frissítették.

properties.resolveConfiguration

ResolveConfiguration

A riasztás feloldásának konfigurációja. A PromQLCriteria esetében alkalmazható.

properties.scopes

string[]

Azon erőforrás-azonosítók listája, amelyekre ez a metrikariasztás hatóköre vonatkozik. A naplók alapján nem módosíthatja a metrikaszabály hatókörét.

properties.severity

integer (int32)

Riasztás súlyossága {0, 1, 2, 3, 4}

properties.targetResourceRegion

string

A célerőforrás(ok) régiója, amelyen a riasztás létrejön/frissül. Kötelező, ha a hatókör előfizetést, erőforráscsoportot vagy több erőforrást tartalmaz.

properties.targetResourceType

string

A riasztás létrehozásához/frissítéséhez használt célerőforrás(ok) erőforrástípusa. Kötelező, ha a hatókör előfizetést, erőforráscsoportot vagy több erőforrást tartalmaz.

properties.windowSize

string (duration)

A riasztási tevékenység küszöbérték alapján történő figyelésére használt időtartam (ISO 8601 időtartam formátumban).

systemData

systemData

A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.

tags

object

Erőforráscímkék.

type

string

Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

MetricAlertResourceCollection

A riasztási szabály erőforrásainak gyűjteményét jelöli.

Name Típus Description
nextLink

string

Az URL-cím a következő találatok lekéréséhez.

value

MetricAlertResource[]

A riasztási szabály értékei erőforrásait.

MetricAlertSingleResourceMultipleMetricCriteria

Megadja a metrikai riasztási kritériumokat egyetlen erőforrásra, amelynek több metrikus kritériuma van.

Name Típus Description
allOf

MetricCriteria[]

Az "összes" művelet metrikafeltételeinek listája.

odata.type string:

Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria

Megadja a riasztási feltételek típusát. Előfordulhat, hogy a korábban nem dokumentált értékek visszaadhatók

MetricCriteria

Criterion a metrikák szűrésére.

Name Típus Description
criterionType string:

StaticThresholdCriterion

Megadja a küszöbértékek típusát. Előfordulhat, hogy a korábban nem dokumentált értékek visszaadhatók

dimensions

MetricDimension[]

A dimenziófeltételek listája.

metricName

string

A metrika neve.

metricNamespace

string

a metrika Namespace.

name

string

A feltétel neve.

operator

Operator

A feltétel operátora. Előfordulhat, hogy a korábban nem dokumentált értékek visszaadhatók

skipMetricValidation

boolean

Lehetővé teszi, hogy riasztási szabályt hozzon létre egy olyan egyéni metrikán, amely még nincs kibocsátva, mert a metrikaérvényesítést kihagyja.

threshold

number (double)

A riasztást aktiváló feltétel küszöbértéke.

timeAggregation

AggregationTypeEnum

A feltételek időösszesítési típusai. Előfordulhat, hogy a korábban nem dokumentált értékek visszaadhatók

MetricDimension

Metrikai dimenziót határoz meg.

Name Típus Description
name

string

A dimenzió neve.

operator

string

A dimenzió operátor. Csak az "Include" és a "Exclude" támogatott

values

string[]

Dimenzióértékek listája.

Microsoft.Common.ErrorDetail

Leírja a hibaválasz részleteit.

Name Típus Description
additionalInfo

Microsoft.Common.ErrorDetailAdditionalInfoItem[]

Egy tömb objektumokból álló 'type' és 'info' tulajdonságokkal. Az 'info' sémája szolgáltatásspecifikus, és a 'típus' láncszáltól függ.

code

string

Lokalizálatlan string, amely programmazívan azonosítható a hiba azonosítására.

message

string

Részletesen leírja a hibát és javító információkat nyújt.

target

string

Az adott hiba célja (például a hibás tulajdonság neve).

Microsoft.Common.ErrorDetailAdditionalInfoItem

Name Típus Description
info

A típusra vonatkozó további információk.

type

string

A további információk típusa.

Microsoft.Common.ErrorResponseError

Name Típus Description
additionalInfo

Microsoft.Common.ErrorResponseErrorAdditionalInfoItem[]

Egy tömb objektumokból álló 'type' és 'info' tulajdonságokkal. Az 'info' sémája szolgáltatásspecifikus, és a 'típus' láncszáltól függ.

code

string

Lokalizálatlan string, amely programmazívan azonosítható a hiba azonosítására.

details

Microsoft.Common.ErrorDetail[]

További beágyazott hibaválasz-információs objektumok tömbje, a jelen szerződés szerint.

message

string

Részletesen leírja a hibát és javító információkat nyújt. Ha Accept-Language be van állítva a kérésben, akkor lokalizálni kell az adott nyelvre.

target

string

Az adott hiba célja (például a hibás tulajdonság neve).

Microsoft.Common.ErrorResponseErrorAdditionalInfoItem

Name Típus Description
info

A típusra vonatkozó további információk.

type

string

A további információk típusa.

Microsoft.Common.Identity

Az erőforrás identitása.

Name Típus Description
principalId

string

Az erőforrás-identitás egyszerű azonosítója.

tenantId

string

Az erőforrás bérlőazonosítója.

type

IdentityType

A felügyelt szolgáltatás identitásának típusa.

userAssignedIdentities

<string,  Microsoft.Common.UserIdentityProperties>

Az erőforráshoz társított felhasználói identitások listája. A felhasználói identitás szótárkulcs-hivatkozásai arm-erőforrás-azonosítók lesznek a következő formában: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

Microsoft.Common.UserIdentityProperties

A felhasználó által kijelölt identitás tulajdonságai.

Name Típus Description
clientId

string

Az erőforrás identitásának kliensazonosítója.

principalId

string

Az erőforrás-identitás egyszerű azonosítója.

Odatatype

Megadja a riasztási feltételek típusát. Előfordulhat, hogy a korábban nem dokumentált értékek visszaadhatók

Érték Description
Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria

Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria

Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria

Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria

Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria

Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria

Microsoft.Azure.Monitor.PromQLCriteria

Microsoft.Azure.Monitor.PromQLCriteria

Operator

A feltétel operátora. Előfordulhat, hogy a korábban nem dokumentált értékek visszaadhatók

Érték Description
Equals

Egyenlő a következővel:

GreaterThan

GreaterThan

GreaterThanOrEqual

Nagyobb vagy egyenlő, mint

LessThan

Kevesebb mint

LessThanOrEqual

LessThanOrEqual

PromQLCriteria

Megadja a PromQL kritériumokat a metrikus riasztási erőforráshoz.

Name Típus Description
allOf MultiPromQLCriteria[]:

A szalagavató kritériumainak listája. A riasztás akkor jelenik meg, ha minden feltétel teljesül.

failingPeriods

QueryFailingPeriods

A lekérdezésalapú riasztások sikertelen időszakainak konfigurálása.

odata.type string:

Microsoft.Azure.Monitor.PromQLCriteria

Megadja a riasztási feltételek típusát. Előfordulhat, hogy a korábban nem dokumentált értékek visszaadhatók

QueryFailingPeriods

A lekérdezésalapú riasztások sikertelen időszakainak konfigurálása.

Name Típus Description
for

string (duration)

A riasztás aktiválása előtt aktívnak kell lennie (ISO 8601 időtartamú formátumban).

ResolveConfiguration

Name Típus Description
autoResolved

boolean

Azt jelzi, hogy a riasztást automatikusan fel kell-e oldani

timeToResolve

string (duration)

Az az idő (ISO 8601 időtartam formátumban), amely után a riasztást automatikusan fel kell oldani

StaticPromQLCriteria

A statikus bál lekérdezés kritériuma.

Name Típus Description
criterionType string:

StaticThresholdCriterion

Megadja a küszöbértékek típusát. Előfordulhat, hogy a korábban nem dokumentált értékek visszaadhatók

name

string

A feltétel neve.

query

string

A riasztási szabály kiértékeléséhez használt lekérdezés

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name Típus Description
createdAt

string (date-time)

Az erőforrás-létrehozás időbélyege (UTC).

createdBy

string

Az erőforrást létrehozó identitás.

createdByType

createdByType

Az erőforrást létrehozó identitás típusa.

lastModifiedAt

string (date-time)

Az erőforrás utolsó módosításának időbélyege (UTC)

lastModifiedBy

string

Az erőforrást legutóbb módosító identitás.

lastModifiedByType

createdByType

Az erőforrást legutóbb módosító identitás típusa.

WebtestLocationAvailabilityCriteria

Megadja a metrikus riasztási szabály feltételeit egy webteszt forráshoz.

Name Típus Description
componentId

string

Az Application Insights erőforrás-azonosítója.

failedLocationCount

number (float)

A sikertelen helyek száma.

odata.type string:

Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria

Megadja a riasztási feltételek típusát. Előfordulhat, hogy a korábban nem dokumentált értékek visszaadhatók

webTestId

string

Az Application Insights webes tesztazonosítója.