Metric Alerts - Update
Aktualizujte definici upozornění na metriku.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}?api-version=2018-03-01
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena. |
rule
|
path | True |
string |
Název pravidla. |
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. |
Text požadavku
Name | Typ | Description |
---|---|---|
properties.actions |
pole akcí, které se provádějí, když se pravidlo upozornění aktivuje a kdy se vyřeší podmínka 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 vyhodnocuje ve formátu doby trvání ISO 8601. |
properties.scopes |
string[] |
seznam ID prostředku, na který je toto upozornění na metriku vymezeno. |
properties.severity |
integer |
Závažnost upozornění {0, 1, 2, 3, 4} |
properties.targetResourceRegion |
string |
oblast cílových prostředků, pro které je výstraha vytvořena nebo aktualizována. Povinné pro MultipleResourceMultipleMetricCriteria. |
properties.targetResourceType |
string |
typ prostředku cílových prostředků, pro které je výstraha vytvořena nebo aktualizována. Povinné pro MultipleResourceMultipleMetricCriteria. |
properties.windowSize |
string |
časové období (ve formátu doby trvání ISO 8601), které se používá k monitorování aktivity upozornění na základě prahové hodnoty. |
tags |
object |
Značky prostředků |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
BadRequest |
Zabezpečení
azure_auth
Tok Azure Active Directory OAuth2
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | zosobnění uživatelského účtu |
Příklady
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"
}
}
]
}
}
Definice
Name | Description |
---|---|
Aggregation |
typy časové agregace kritérií. |
Dynamic |
Kritérium pro dynamickou prahovou hodnotu |
Dynamic |
Minimální počet porušení požadovaných ve vybraném časovém intervalu doby 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 je prahová hodnota pro vzor řady metrik těsná. |
Error |
Popisuje formát chybové odpovědi. |
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 |
Prostředek upozornění na metriku pro operace oprav. |
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éria. |
Webtest |
Určuje kritéria pravidla upozornění na metriku pro prostředek webového testu. |
AggregationTypeEnum
typy časové agregace kritérií.
Name | Typ | Description |
---|---|---|
Average |
string |
|
Count |
string |
|
Maximum |
string |
|
Minimum |
string |
|
Total |
string |
DynamicMetricCriteria
Kritérium pro dynamickou prahovou hodnotu
Name | Typ | Description |
---|---|---|
alertSensitivity |
Rozsah odchylky vyžadovaný k aktivaci výstrahy. To bude mít vliv na to, jak je prahová hodnota pro vzor řady metrik těsná. |
|
criterionType |
string:
Dynamic |
Určuje typ prahových kritérií. |
dimensions |
Seznam podmínek dimenze |
|
failingPeriods |
Minimální počet porušení požadovaných ve vybraném časovém intervalu doby 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 se 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 |
Možnost vytvořit pravidlo výstrahy pro vlastní metriku, která ještě nebyla vygenerována, přeskočením ověření metriky |
timeAggregation |
typy časové agregace kritérií. |
DynamicThresholdFailingPeriods
Minimální počet porušení požadovaných ve vybraném časovém intervalu doby zpětného vyhledávání, který je nutný k vyvolání výstrahy.
Name | Typ | Description |
---|---|---|
minFailingPeriodsToAlert |
number |
Počet porušení pro aktivaci výstrahy Měl by být menší nebo roven hodnotě numberOfEvaluationPeriods. |
numberOfEvaluationPeriods |
number |
Počet agregovaných bodů zpětného vyhledávání. Časové období zpětného vyhledávání se počítá na základě agregační členitosti (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 je prahová hodnota pro vzor řady metrik těsná.
Name | Typ | Description |
---|---|---|
High |
string |
|
Low |
string |
|
Medium |
string |
ErrorResponse
Popisuje formát chybové odpovědi.
Name | Typ | Description |
---|---|---|
code |
string |
Kód chyby |
message |
string |
Chybová zpráva označující, proč operace selhala. |
MetricAlertAction
Akce upozornění.
Name | Typ | Description |
---|---|---|
actionGroupId |
string |
ID skupiny akcí, kterou chcete použít. |
webHookProperties |
object |
Toto pole umožňuje zadat vlastní vlastnosti, které by se připojily k datové části upozornění 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 operaci "all of". |
odata.type |
string:
Microsoft. |
určuje typ kritérií upozornění. |
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í, když se pravidlo upozornění aktivuje a kdy se vyřeší podmínka 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 vyhodnocuje ve formátu doby trvání ISO 8601. |
properties.isMigrated |
boolean |
hodnota označující, jestli 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í na metriku vymezeno. |
properties.severity |
integer |
Závažnost upozornění {0, 1, 2, 3, 4} |
properties.targetResourceRegion |
string |
oblast cílových prostředků, pro které je výstraha vytvořena nebo aktualizována. 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ů, pro které je výstraha vytvořena nebo aktualizována. 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 upozornění na základě prahové hodnoty. |
tags |
object |
Značky prostředků |
type |
string |
Typ prostředku Azure |
MetricAlertResourcePatch
Prostředek upozornění na metriku pro operace oprav.
Name | Typ | Description |
---|---|---|
properties.actions |
pole akcí, které se provádějí, když se pravidlo upozornění aktivuje a kdy se vyřeší podmínka 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 vyhodnocuje ve formátu doby trvání ISO 8601. |
properties.isMigrated |
boolean |
hodnota označující, jestli 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í na metriku vymezeno. |
properties.severity |
integer |
Závažnost upozornění {0, 1, 2, 3, 4} |
properties.targetResourceRegion |
string |
oblast cílových prostředků, pro které je výstraha vytvořena nebo aktualizována. Povinné pro MultipleResourceMultipleMetricCriteria. |
properties.targetResourceType |
string |
typ prostředku cílových prostředků, pro které je výstraha vytvořena nebo aktualizována. Povinné pro MultipleResourceMultipleMetricCriteria. |
properties.windowSize |
string |
časové období (ve formátu doby trvání ISO 8601), které se používá k monitorování aktivity upozornění na základě prahové hodnoty. |
tags |
object |
Značky prostředků |
MetricAlertSingleResourceMultipleMetricCriteria
Určuje kritéria upozornění na metriku pro jeden prostředek, který má více kritérií metrik.
Name | Typ | Description |
---|---|---|
allOf |
Seznam kritérií metrik pro tuto operaci "all of". |
|
odata.type |
string:
Microsoft. |
určuje typ kritérií upozornění. |
MetricCriteria
Kritérium pro filtrování metrik
Name | Typ | Description |
---|---|---|
criterionType |
string:
Static |
Určuje typ prahových kritérií. |
dimensions |
Seznam podmínek dimenze |
|
metricName |
string |
Název metriky |
metricNamespace |
string |
Obor názvů metriky. |
name |
string |
Název kritérií |
operator |
operátor kritéria. |
|
skipMetricValidation |
boolean |
Možnost vytvořit pravidlo výstrahy pro vlastní metriku, která ještě nebyla vygenerována, přeskočením ověření metriky |
threshold |
number |
prahová hodnota kritéria, která aktivuje výstrahu. |
timeAggregation |
typy časové agregace kritérií. |
MetricDimension
Určuje dimenzi metriky.
Name | Typ | Description |
---|---|---|
name |
string |
Název dimenze. |
operator |
string |
operátor dimenze. Podporují se jenom možnosti Zahrnout a Vyloučit. |
values |
string[] |
seznam hodnot dimenzí. |
Operator
operátor kritéria.
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í upozornění. |
webTestId |
string |
ID testu webu Application Insights |