Metric Alerts - Update

Metrikariasztás definíciójának frissítése.

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

URI-paraméterek

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

string

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

ruleName
path True

string

A szabály neve.

subscriptionId
path True

string

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

api-version
query True

string

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

Kérelem törzse

Name Típus Description
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

a jelző, amely azt 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étel adatait.

properties.description

string

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

properties.enabled

boolean

a jelölő, amely jelzi, hogy a metrikariasztás engedélyezve van-e.

properties.evaluationFrequency

string

a metrikariasztás kiértékelésének gyakorisága ISO 8601-es időtartam formátumban.

properties.scopes

string[]

azon erőforrás-azonosítók listája, amelyekre a metrikariasztás hatóköre kiterjed.

properties.severity

integer

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

properties.targetResourceRegion

string

azon célerőforrás(ok) régiója, amelyen a riasztás létrejön/frissül. A MultipleResourceMultipleMetricCriteria esetében kötelező.

properties.targetResourceType

string

azon célerőforrás(ok) erőforrástípusa, amelyen a riasztás létrejön vagy frissül. A MultipleResourceMultipleMetricCriteria esetében kötelező.

properties.windowSize

string

a riasztási tevékenység küszöbértéken alapuló figyelésére használt időtartam (ISO 8601-es időtartamformátumban).

tags

object

Erőforráscímkék

Válaszok

Name Típus Description
200 OK

MetricAlertResource

OK

Other Status Codes

ErrorResponse

BadRequest

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

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

Példák

Create or update an alert rule

Sample Request

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

{
  "tags": {},
  "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": "\\Processor(_Total)\\% Processor Time",
          "dimensions": [],
          "operator": "GreaterThan",
          "threshold": 80.5,
          "timeAggregation": "Average"
        }
      ]
    },
    "autoMitigate": true,
    "actions": [
      {
        "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        "webHookProperties": {
          "key11": "value11",
          "key12": "value12"
        }
      }
    ]
  }
}

Sample Response

{
  "id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/chiricutin",
  "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": "\\Processor(_Total)\\% Processor Time",
          "dimensions": [],
          "operator": "GreaterThan",
          "threshold": 80.5,
          "timeAggregation": "Average"
        }
      ]
    },
    "autoMitigate": true,
    "actions": [
      {
        "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        "webHookProperties": {
          "key11": "value11",
          "key12": "value12"
        }
      }
    ]
  }
}

Definíciók

Name Description
AggregationTypeEnum

a feltételek időösszesítési típusai.

DynamicMetricCriteria

A dinamikus küszöbérték kritériuma.

DynamicThresholdFailingPeriods

A riasztás létrehozásához szükséges minimális számú szabálysértés a kiválasztott visszatekintési időablakban.

DynamicThresholdOperator

A metrikaérték és a küszöbérték összehasonlítására használt operátor.

DynamicThresholdSensitivity

A riasztás indításához szükséges eltérés mértéke. Ez hatással lesz arra, hogy milyen szoros a küszöbérték a metrikasor mintájához.

ErrorResponse

A hibaválasz formátumát ismerteti.

MetricAlertAction

Riasztási művelet.

MetricAlertMultipleResourceMultipleMetricCriteria

Több, több metrikafeltételt tartalmazó erőforrás metrikariariasztási feltételeit adja meg.

MetricAlertResource

A metrikariasztási erőforrás.

MetricAlertResourcePatch

A javításműveletek metrikariasztási erőforrása.

MetricAlertSingleResourceMultipleMetricCriteria

Egy több metrikafeltételt tartalmazó erőforrás metrikariasztási feltételeit adja meg.

MetricCriteria

A metrikák szűrésének kritériuma.

MetricDimension

Metrikadimenziót ad meg.

Operator

a feltétel operátor.

WebtestLocationAvailabilityCriteria

Meghatározza a metrikariasztási szabály feltételeit egy webes teszterőforráshoz.

AggregationTypeEnum

a feltételek időösszesítési típusai.

Name Típus Description
Average

string

Count

string

Maximum

string

Minimum

string

Total

string

DynamicMetricCriteria

A dinamikus küszöbérték 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 milyen szoros a küszöbérték a metrikasor mintájához.

criterionType string:

DynamicThresholdCriterion

Meghatározza a küszöbérték-feltétel típusát

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 kiválasztott visszatekintési időablakban.

ignoreDataBefore

string

Ezzel a beállítással beállíthatja 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 névtere.

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.

skipMetricValidation

boolean

Ez lehetővé teszi egy riasztási szabály létrehozását egy még ki nem bocsátott egyéni metrikához, mivel kihagyja a metrika ellenőrzését.

timeAggregation

AggregationTypeEnum

a feltételek időösszesítési típusai.

DynamicThresholdFailingPeriods

A riasztás létrehozásához szükséges minimális számú szabálysértés a kiválasztott visszatekintési időablakban.

Name Típus Description
minFailingPeriodsToAlert

number

A riasztást aktiváló szabálysértések száma. Kisebbnek vagy egyenlőnek kell lennie a numberOfEvaluationPeriods értékekkel.

numberOfEvaluationPeriods

number

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.

Name Típus Description
GreaterOrLessThan

string

GreaterThan

string

LessThan

string

DynamicThresholdSensitivity

A riasztás indításához szükséges eltérés mértéke. Ez hatással lesz arra, hogy milyen szoros a küszöbérték a metrikasor mintájához.

Name Típus Description
High

string

Low

string

Medium

string

ErrorResponse

A hibaválasz formátumát ismerteti.

Name Típus Description
code

string

Hibakód

message

string

Hibaüzenet jelzi, hogy a művelet miért nem sikerült.

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ő lehetővé teszi egyéni tulajdonságok megadását, amelyeket a webhook bemeneteként küldött riasztás hasznos adataihoz fűz.

MetricAlertMultipleResourceMultipleMetricCriteria

Több, több metrikafeltételt tartalmazó erőforrás metrikariariasztási feltételeit adja meg.

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.

MetricAlertResource

A metrikariasztási erőforrás.

Name Típus Description
id

string

Azure-erőforrás azonosítója

location

string

Erőforrás helye

name

string

Azure-erőforrás neve

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

a jelző, amely azt 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étel adatait.

properties.description

string

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

properties.enabled

boolean

a jelölő, amely jelzi, hogy a metrikariasztás engedélyezve van-e.

properties.evaluationFrequency

string

a metrikariasztás kiértékelésének gyakorisága ISO 8601-es időtartam formátumban.

properties.isMigrated

boolean

a riasztási szabály migrálását jelző érték.

properties.lastUpdatedTime

string

A szabály legutóbbi frissítése ISO8601 formátumban.

properties.scopes

string[]

azon erőforrás-azonosítók listája, amelyekre a metrikariasztás hatóköre kiterjed.

properties.severity

integer

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

properties.targetResourceRegion

string

azon 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 egynél több erőforrást tartalmaz.

properties.targetResourceType

string

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

properties.windowSize

string

a riasztási tevékenység küszöbértéken alapuló figyelésére használt időtartam (ISO 8601-es időtartamformátumban).

tags

object

Erőforráscímkék

type

string

Azure-erőforrástípus

MetricAlertResourcePatch

A javításműveletek metrikariasztási erőforrása.

Name Típus Description
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

a jelző, amely azt 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étel adatait.

properties.description

string

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

properties.enabled

boolean

a jelölő, amely jelzi, hogy a metrikariasztás engedélyezve van-e.

properties.evaluationFrequency

string

a metrikariasztás kiértékelésének gyakorisága ISO 8601-es időtartam formátumban.

properties.isMigrated

boolean

a riasztási szabály migrálását jelző érték.

properties.lastUpdatedTime

string

A szabály legutóbbi frissítése ISO8601 formátumban.

properties.scopes

string[]

azon erőforrás-azonosítók listája, amelyekre a metrikariasztás hatóköre kiterjed.

properties.severity

integer

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

properties.targetResourceRegion

string

azon célerőforrás(ok) régiója, amelyen a riasztás létrejön/frissül. A MultipleResourceMultipleMetricCriteria esetében kötelező.

properties.targetResourceType

string

azon célerőforrás(ok) erőforrástípusa, amelyen a riasztás létrejön vagy frissül. A MultipleResourceMultipleMetricCriteria esetében kötelező.

properties.windowSize

string

a riasztási tevékenység küszöbértéken alapuló figyelésére használt időtartam (ISO 8601-es időtartamformátumban).

tags

object

Erőforráscímkék

MetricAlertSingleResourceMultipleMetricCriteria

Egy több metrikafeltételt tartalmazó erőforrás metrikariasztási feltételeit adja meg.

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.

MetricCriteria

A metrikák szűrésének kritériuma.

Name Típus Description
criterionType string:

StaticThresholdCriterion

Meghatározza a küszöbérték-feltétel típusát

dimensions

MetricDimension[]

A dimenziófeltételek listája.

metricName

string

A metrika neve.

metricNamespace

string

A metrika névtere.

name

string

A feltétel neve.

operator

Operator

a feltétel operátor.

skipMetricValidation

boolean

Ez lehetővé teszi egy riasztási szabály létrehozását egy még ki nem bocsátott egyéni metrikához, mivel kihagyja a metrika ellenőrzését.

threshold

number

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

timeAggregation

AggregationTypeEnum

a feltételek időösszesítési típusai.

MetricDimension

Metrikadimenziót ad 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.

Operator

a feltétel operátor.

Name Típus Description
Equals

string

GreaterThan

string

GreaterThanOrEqual

string

LessThan

string

LessThanOrEqual

string

WebtestLocationAvailabilityCriteria

Meghatározza a metrikariasztási szabály feltételeit egy webes teszterőforráshoz.

Name Típus Description
componentId

string

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

failedLocationCount

number

A sikertelen helyek száma.

odata.type string:

Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria

megadja a riasztási feltételek típusát.

webTestId

string

Az Application Insights webes tesztazonosítója.