Metric Alerts - List By Subscription
Načtení definic pravidel upozornění v předplatném
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/metricAlerts?api-version=2018-03-01
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
ID cílového předplatného. |
api-version
|
query | True |
string |
Verze rozhraní API, která se má použít pro tuto operaci. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Úspěšná žádost o seznam upozornění metrik |
|
Other Status Codes |
BadRequest |
Zabezpečení
azure_auth
Azure Active Directory OAuth2 Flow
Typ:
oauth2
Tok:
implicit
URL autorizace:
https://login.microsoftonline.com/common/oauth2/authorize
Rozsahy
Name | Description |
---|---|
user_impersonation | zosobnění uživatelského účtu |
Příklady
List metric alert rules
Ukázkový požadavek
GET https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/providers/Microsoft.Insights/metricAlerts?api-version=2018-03-01
Ukázková odpověď
{
"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"
}
}
]
}
}
]
}
Definice
Name | Description |
---|---|
Additional |
Pole objektů s vlastnostmi type a info. Schéma "info" je specifické pro službu a závisí na řetězci typu. |
Aggregation |
časové typy agregace kritérií. |
Dynamic |
Kritérium dynamické prahové hodnoty |
Dynamic |
Minimální počet porušení požadovaných v rámci vybraného časového intervalu zpětného vyhledávání, které je nutné k vyvolání výstrahy. |
Dynamic |
Operátor použitý k porovnání hodnoty metriky s prahovou hodnotou. |
Dynamic |
Rozsah odchylky vyžadovaný k aktivaci výstrahy. To bude mít vliv na to, jak úzká je prahová hodnota vzoru řady metrik. |
Error | |
Error |
Popisuje podrobnosti odpovědi na chybu. |
Error |
Popisuje formát odpovědi na chybu. |
Metric |
Akce upozornění |
Metric |
Určuje kritéria upozornění na metriku pro více prostředků, které mají více kritérií metrik. |
Metric |
Prostředek upozornění na metriku |
Metric |
Představuje kolekci prostředků pravidla upozornění. |
Metric |
Určuje kritéria upozornění na metriku pro jeden prostředek, který má více kritérií metrik. |
Metric |
Kritérium pro filtrování metrik |
Metric |
Určuje dimenzi metriky. |
Operator |
operátor kritérií. |
Webtest |
Určuje kritéria pravidla upozornění na metriku pro prostředek webového testu. |
AdditionalInfo
Pole objektů s vlastnostmi type a info. Schéma "info" je specifické pro službu a závisí na řetězci typu.
Name | Typ | Description |
---|---|---|
info |
object |
Další informace specifické pro daný typ. |
type |
string |
Typ dalších informací. |
AggregationTypeEnum
časové typy agregace kritérií.
Name | Typ | Description |
---|---|---|
Average |
string |
|
Count |
string |
|
Maximum |
string |
|
Minimum |
string |
|
Total |
string |
DynamicMetricCriteria
Kritérium dynamické prahové hodnoty
Name | Typ | Description |
---|---|---|
alertSensitivity |
Rozsah odchylky vyžadovaný k aktivaci výstrahy. To bude mít vliv na to, jak úzká je prahová hodnota vzoru řady metrik. |
|
criterionType |
string:
Dynamic |
Určuje typ kritérií prahové hodnoty. |
dimensions |
Seznam podmínek dimenzí |
|
failingPeriods |
Minimální počet porušení požadovaných v rámci vybraného časového intervalu zpětného vyhledávání, které je nutné k vyvolání výstrahy. |
|
ignoreDataBefore |
string |
Tato možnost slouží k nastavení data, od kterého chcete začít učit historická data metrik a vypočítat dynamické prahové hodnoty (ve formátu ISO8601). |
metricName |
string |
Název metriky |
metricNamespace |
string |
Obor názvů metriky |
name |
string |
Název kritérií |
operator |
Operátor použitý k porovnání hodnoty metriky s prahovou hodnotou. |
|
skipMetricValidation |
boolean |
Umožňuje vytvořit pravidlo upozornění na vlastní metriku, která ještě není vygenerována, tím, že způsobí vynechání ověření metriky. |
timeAggregation |
časové typy agregace kritérií. |
DynamicThresholdFailingPeriods
Minimální počet porušení požadovaných v rámci vybraného časového intervalu zpětného vyhledávání, které je nutné k vyvolání výstrahy.
Name | Typ | Description |
---|---|---|
minFailingPeriodsToAlert |
number |
Počet porušení, která se mají aktivovat upozornění. Měl by být menší nebo roven čísluOfEvaluationPeriods. |
numberOfEvaluationPeriods |
number |
Počet agregovaných bodů zpětného vyhledávání. Časové období zpětného vyhledávání se vypočítá na základě členitosti agregace (windowSize) a vybraného počtu agregovaných bodů. |
DynamicThresholdOperator
Operátor použitý k porovnání hodnoty metriky s prahovou hodnotou.
Name | Typ | Description |
---|---|---|
GreaterOrLessThan |
string |
|
GreaterThan |
string |
|
LessThan |
string |
DynamicThresholdSensitivity
Rozsah odchylky vyžadovaný k aktivaci výstrahy. To bude mít vliv na to, jak úzká je prahová hodnota vzoru řady metrik.
Name | Typ | Description |
---|---|---|
High |
string |
|
Low |
string |
|
Medium |
string |
Error
Name | Typ | Description |
---|---|---|
additionalInfo |
Pole objektů s vlastnostmi type a info. Schéma "info" je specifické pro službu a závisí na řetězci typu. |
|
code |
string |
Nelokalizovaný řetězec, který lze použít k programové identifikaci chyby. |
details |
Pole dalších vnořených objektů s informacemi o odpovědích na chybu, jak je popsáno v tomto kontraktu. |
|
message |
string |
Podrobně popisuje chybu a poskytuje informace o ladění. Pokud je v požadavku nastavená Accept-Language, musí být lokalizovaná do daného jazyka. |
target |
string |
Cíl konkrétní chyby (například název vlastnosti v chybě). |
ErrorDetail
Popisuje podrobnosti odpovědi na chybu.
Name | Typ | Description |
---|---|---|
additionalInfo |
Pole objektů s vlastnostmi type a info. Schéma "info" je specifické pro službu a závisí na řetězci typu. |
|
code |
string |
Nelokalizovaný řetězec, který lze použít k programové identifikaci chyby. |
message |
string |
Podrobně popisuje chybu a poskytuje informace o ladění. |
target |
string |
Cíl konkrétní chyby (například název vlastnosti v chybě). |
ErrorResponse
Popisuje formát odpovědi na chybu.
Name | Typ | Description |
---|---|---|
error |
MetricAlertAction
Akce upozornění
Name | Typ | Description |
---|---|---|
actionGroupId |
string |
ID skupiny akcí, která se má použít. |
webHookProperties |
object |
Toto pole umožňuje zadat vlastní vlastnosti, které by se připojily k datové části výstrahy odeslané jako vstup do webhooku. |
MetricAlertMultipleResourceMultipleMetricCriteria
Určuje kritéria upozornění na metriku pro více prostředků, které mají více kritérií metrik.
Name | Typ | Description |
---|---|---|
allOf | MultiMetricCriteria[]: |
seznam více kritérií metrik pro tuto "veškerou" operaci. |
odata.type |
string:
Microsoft. |
určuje typ kritérií výstrahy. |
MetricAlertResource
Prostředek upozornění na metriku
Name | Typ | Description |
---|---|---|
id |
string |
ID prostředku Azure |
location |
string |
Umístění prostředku |
name |
string |
Název prostředku Azure |
properties.actions |
pole akcí, které se provádějí při aktivním pravidlu upozornění a při vyřešení podmínky upozornění. |
|
properties.autoMitigate |
boolean |
příznak, který označuje, jestli má být výstraha automaticky vyřešena, nebo ne. Výchozí hodnota je true. |
properties.criteria | MetricAlertCriteria: |
definuje konkrétní informace o kritériích upozornění. |
properties.description |
string |
popis upozornění na metriku, který bude součástí e-mailu s upozorněním. |
properties.enabled |
boolean |
příznak označující, jestli je upozornění na metriku povolené. |
properties.evaluationFrequency |
string |
jak často se upozornění na metriku vyhodnotí ve formátu doby trvání ISO 8601. |
properties.isMigrated |
boolean |
hodnota označující, zda je toto pravidlo upozornění migrováno. |
properties.lastUpdatedTime |
string |
Čas poslední aktualizace pravidla ve formátu ISO8601 |
properties.scopes |
string[] |
seznam ID prostředku, na který je toto upozornění metriky vymezeno. |
properties.severity |
integer |
Závažnost upozornění {0, 1, 2, 3, 4} |
properties.targetResourceRegion |
string |
oblast cílových prostředků, na kterých se výstraha vytvoří nebo aktualizuje. Povinné, pokud obor obsahuje předplatné, skupinu prostředků nebo více než jeden prostředek. |
properties.targetResourceType |
string |
typ prostředku cílových prostředků, na kterých se výstraha vytvoří nebo aktualizuje. Povinné, pokud obor obsahuje předplatné, skupinu prostředků nebo více než jeden prostředek. |
properties.windowSize |
string |
časové období (ve formátu doby trvání ISO 8601), které se používá k monitorování aktivity výstrahy na základě prahové hodnoty. |
tags |
object |
Značky prostředků |
type |
string |
Typ prostředku Azure |
MetricAlertResourceCollection
Představuje kolekci prostředků pravidla upozornění.
Name | Typ | Description |
---|---|---|
value |
hodnoty pro prostředky pravidla upozornění. |
MetricAlertSingleResourceMultipleMetricCriteria
Určuje kritéria upozornění na metriku pro jeden prostředek, který má více kritérií metrik.
Name | Typ | Description |
---|---|---|
allOf |
Seznamkritériích |
|
odata.type |
string:
Microsoft. |
určuje typ kritérií výstrahy. |
MetricCriteria
Kritérium pro filtrování metrik
Name | Typ | Description |
---|---|---|
criterionType |
string:
Static |
Určuje typ kritérií prahové hodnoty. |
dimensions |
Seznam podmínek dimenzí |
|
metricName |
string |
Název metriky |
metricNamespace |
string |
Obor názvů metriky |
name |
string |
Název kritérií |
operator |
operátor kritérií. |
|
skipMetricValidation |
boolean |
Umožňuje vytvořit pravidlo upozornění na vlastní metriku, která ještě není vygenerována, tím, že způsobí vynechání ověření metriky. |
threshold |
number |
prahová hodnota kritérií, která aktivuje výstrahu. |
timeAggregation |
časové typy agregace kritérií. |
MetricDimension
Určuje dimenzi metriky.
Name | Typ | Description |
---|---|---|
name |
string |
Název dimenze. |
operator |
string |
operátor dimenze. Podporují se pouze zahrnutí a vyloučení. |
values |
string[] |
seznam hodnot dimenzí. |
Operator
operátor kritérií.
Name | Typ | Description |
---|---|---|
Equals |
string |
|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
WebtestLocationAvailabilityCriteria
Určuje kritéria pravidla upozornění na metriku pro prostředek webového testu.
Name | Typ | Description |
---|---|---|
componentId |
string |
ID prostředku Application Insights |
failedLocationCount |
number |
Počet neúspěšných umístění. |
odata.type |
string:
Microsoft. |
určuje typ kritérií výstrahy. |
webTestId |
string |
ID webového testu Application Insights |