Metric Alerts - List By Resource Group
Riasztási szabály definícióinak lekérése egy erőforráscsoportban.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts?api-version=2018-03-01
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket. |
subscription
|
path | True |
string |
A cél-előfizetés azonosítója. |
api-version
|
query | True |
string |
A művelethez használandó API-verzió. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
A metrikariasztások listájának sikeres kérése |
|
Other Status Codes |
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
List metric alert rules
Sample Request
GET https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/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"
}
}
]
}
}
]
}
Definíciók
Name | Description |
---|---|
Aggregation |
a feltételek időösszesítési típusai. |
Dynamic |
A dinamikus küszöbérték kritériuma. |
Dynamic |
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. |
Dynamic |
A metrikaérték és a küszöbérték összehasonlítására használt operátor. |
Dynamic |
A riasztás aktiválásához szükséges eltérés mértéke. Ez hatással lesz arra, hogy milyen szűk a küszöbérték a metrikasorozat-mintához. |
Error |
A hibaválasz formátumát ismerteti. |
Metric |
Riasztási művelet. |
Metric |
Több, több metrikafeltételt tartalmazó erőforrás metrikariasztási feltételeit adja meg. |
Metric |
A metrikariasztási erőforrás. |
Metric |
Riasztási szabály erőforrásainak gyűjteményét jelöli. |
Metric |
Egy több metrikafeltételt tartalmazó erőforrás metrikariasztási feltételeit adja meg. |
Metric |
A metrikák szűrésére vonatkozó feltétel. |
Metric |
Metrikadimenziót ad meg. |
Operator |
a kritérium operátort. |
Webtest |
Megadja egy webes teszterőforrás metrikariasztási szabályának feltételeit. |
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 |
A riasztás aktiválásához szükséges eltérés mértéke. Ez hatással lesz arra, hogy milyen szűk a küszöbérték a metrikasorozat-mintához. |
|
criterionType |
string:
Dynamic |
Meghatározza a küszöbérték-feltételek típusát |
dimensions |
A dimenziófeltételek listája. |
|
failingPeriods |
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 |
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 névtere. |
name |
string |
A feltétel neve. |
operator |
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 |
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 kijelölt visszatekintési időkereten belül.
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 számmal. |
numberOfEvaluationPeriods |
number |
Az összesített visszatekintési pontok száma. A visszatekintési időkeret kiszámítása az összesítés részletessége (windowSize) és a kiválasztott összesített pontok 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 aktiválásához szükséges eltérés mértéke. Ez hatással lesz arra, hogy milyen szűk a küszöbérték a metrikasorozat-mintá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, amely jelzi, hogy a művelet miért hiúsult meg. |
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 a rendszer a webhook bemeneteként küldött riasztás hasznos adataihoz fűz. |
MetricAlertMultipleResourceMultipleMetricCriteria
Több, több metrikafeltételt tartalmazó erőforrás metrikariasztá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. |
a riasztási feltételek típusát adja meg. |
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 |
a riasztási szabály aktívvá válásakor és a riasztási feltétel feloldásakor végrehajtott műveletek tömbje. |
|
properties.autoMitigate |
boolean |
a jelző, amely jelzi, hogy a riasztást automatikusan fel kell-e oldani. Az alapértelmezett érték igaz. |
properties.criteria | MetricAlertCriteria: |
a meghatározott riasztási feltételekre vonatkozó információkat határozza meg. |
properties.description |
string |
a metrikariasztás leírása, amely szerepelni fog a riasztási e-mailben. |
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őtartamformá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/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égek 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 |
MetricAlertResourceCollection
Riasztási szabály erőforrásainak gyűjteményét jelöli.
Name | Típus | Description |
---|---|---|
value |
a riasztási szabály erőforrásainak értékeit. |
MetricAlertSingleResourceMultipleMetricCriteria
Egy több metrikafeltételt tartalmazó erőforrás metrikariasztási feltételeit adja meg.
Name | Típus | Description |
---|---|---|
allOf |
Az "összes" művelet metrikafeltételeinek listája. |
|
odata.type |
string:
Microsoft. |
a riasztási feltételek típusát adja meg. |
MetricCriteria
A metrikák szűrésére vonatkozó feltétel.
Name | Típus | Description |
---|---|---|
criterionType |
string:
Static |
Meghatározza a küszöbérték-feltételek típusát |
dimensions |
A dimenziófeltételek listája. |
|
metricName |
string |
A metrika neve. |
metricNamespace |
string |
A metrika névtere. |
name |
string |
A feltétel neve. |
operator |
a kritérium operátort. |
|
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ó kritérium küszöbértéke. |
timeAggregation |
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átort. Csak az "Include" és a "Exclude" támogatott |
values |
string[] |
dimenzióértékek listája. |
Operator
a kritérium operátort.
Name | Típus | Description |
---|---|---|
Equals |
string |
|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
WebtestLocationAvailabilityCriteria
Megadja egy webes teszterőforrás metrikariasztási szabályának feltételeit.
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. |
a riasztási feltételek típusát adja meg. |
webTestId |
string |
Az Application Insights webes tesztazonosítója. |