Alert Rules - Create Or Update
Klasszikus metrikariasztási szabályt hoz létre vagy frissít.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/alertrules/{ruleName}?api-version=2016-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. |
rule
|
path | True |
string |
A szabály neve. |
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ó. |
Kérelem törzse
Name | Kötelező | Típus | Description |
---|---|---|---|
location | True |
string |
Erőforrás helye |
properties.condition | True | RuleCondition: |
az a feltétel, amely a riasztási szabály aktiválását eredményezi. |
properties.isEnabled | True |
boolean |
a riasztási szabály engedélyezését jelző jelző. |
properties.name | True |
string |
a riasztási szabály neve. |
properties.action | RuleAction: |
művelet, amelyet a riasztási szabály aktívvá válásakor és egy riasztási feltétel feloldásakor hajtanak végre. |
|
properties.actions | RuleAction[]: |
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.description |
string |
a riasztási szabály leírása, amely szerepelni fog a riasztási e-mailben. |
|
properties.provisioningState |
string |
a kiépítési állapotot. |
|
tags |
object |
Erőforráscímkék |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
Riasztási szabály frissítésére irányuló sikeres kérelem |
|
201 Created |
Riasztási szabály létrehozása |
|
Other Status Codes |
Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg. |
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
PUT https://management.azure.com/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourcegroups/Rac46PostSwapRG/providers/Microsoft.Insights/alertrules/chiricutin?api-version=2016-03-01
{
"location": "West US",
"tags": {},
"properties": {
"name": "chiricutin",
"description": "Pura Vida",
"isEnabled": true,
"condition": {
"odata.type": "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition",
"dataSource": {
"odata.type": "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource",
"resourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest",
"metricName": "Requests"
},
"operator": "GreaterThan",
"threshold": 3,
"windowSize": "PT5M",
"timeAggregation": "Total"
},
"actions": []
}
}
Sample Response
{
"id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/chiricutin",
"name": "chiricutin",
"type": "Microsoft.Insights/alertRules",
"location": "West US",
"tags": {
"$type": "Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage",
"hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
},
"properties": {
"name": "chiricutin",
"description": "Pura Vida",
"isEnabled": true,
"condition": {
"odata.type": "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition",
"dataSource": {
"odata.type": "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource",
"resourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest",
"metricName": "Requests"
},
"operator": "GreaterThan",
"threshold": 3,
"windowSize": "PT5M",
"timeAggregation": "Total"
},
"lastUpdatedTime": "2016-11-23T21:23:52.0221265Z",
"actions": []
}
}
{
"id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/chiricutin",
"name": "chiricutin",
"type": "Microsoft.Insights/alertRules",
"location": "West US",
"tags": {
"$type": "Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage",
"hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
},
"properties": {
"name": "chiricutin",
"description": "Pura Vida",
"isEnabled": true,
"condition": {
"odata.type": "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition",
"dataSource": {
"odata.type": "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource",
"resourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest",
"metricName": "Requests"
},
"operator": "GreaterThan",
"threshold": 3,
"windowSize": "PT5M",
"timeAggregation": "Total"
},
"lastUpdatedTime": "2016-11-23T21:23:52.0221265Z",
"actions": []
}
}
Definíciók
Name | Description |
---|---|
Alert |
A riasztási szabály erőforrása. |
Condition |
A szabályfeltételben engedélyezett operátorok. |
Error |
A hibaválasz formátumát ismerteti. |
Location |
Egy szabályfeltétel, amely bizonyos számú sikertelen hely alapján meghiúsul. |
Management |
Az összegyűjtött adatok időbeli összevonásának módját. |
Management |
Egy felügyeleti eseményszabály feltétele. |
Rule |
Megadja azt a műveletet, amely e-mailt küld a szabályfeltétel kiértékelésekor. Ebben az esetben a diszkriminatív a RuleEmailAction. |
Rule |
Egy szabálykezelési esemény adatforrásának jogcíme. |
Rule |
Szabálykezelési esemény adatforrása. Ebben az esetben a diszkriminatív mezők mindig RuleManagementEventDataSource. |
Rule |
Szabálymetrika adatforrása. Ebben az esetben a diszkriminatív érték mindig RuleMetricDataSource. |
Rule |
Megadja azt a műveletet, amelyet a szabályfeltétel kiértékelésekor közzé kell tenni a szolgáltatásban. Ebben az esetben a diszkriminatív a RuleWebhookAction. |
Threshold |
Egy küszöbértéket átlépő metrikán alapuló szabályfeltétel. |
Time |
A szabályban engedélyezett összesítő operátorok. |
AlertRuleResource
A riasztási szabály erőforrása.
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.action | RuleAction: |
művelet, amelyet akkor hajt végre, amikor a riasztási szabály aktívvá válik, és amikor egy riasztási feltétel megoldódik. |
properties.actions | RuleAction[]: |
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.condition | RuleCondition: |
a riasztási szabály aktiválását eredményező feltétel. |
properties.description |
string |
a riasztási szabály leírása, amely szerepelni fog a riasztási e-mailben. |
properties.isEnabled |
boolean |
jelölő, amely jelzi, hogy a riasztási szabály engedélyezve van-e. |
properties.lastUpdatedTime |
string |
A szabály legutóbbi frissítése ISO8601 formátumban. |
properties.name |
string |
a riasztási szabály neve. |
properties.provisioningState |
string |
a kiépítési állapot. |
tags |
object |
Erőforráscímkék |
type |
string |
Azure-erőforrástípus |
ConditionOperator
A szabályfeltételben engedélyezett operátorok.
Name | Típus | Description |
---|---|---|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
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. |
LocationThresholdRuleCondition
Egy szabályfeltétel, amely bizonyos számú sikertelen hely alapján meghiúsul.
Name | Típus | Description |
---|---|---|
dataSource | RuleDataSource: |
az erőforrás, amelyből a szabály adatokat gyűjt. Ehhez a típushoz a dataSource mindig RuleMetricDataSource típusú lesz. |
failedLocationCount |
integer |
azon helyek száma, amelyeknek nem kell aktiválniuk a riasztást. |
odata.type |
string:
Microsoft. |
a feltétel típusát adja meg. Ez a következő három típus egyike lehet: ManagementEventRuleCondition (felügyeleti események előfordulásai), LocationThresholdRuleCondition (egy webes teszt hibáinak száma alapján) és ThresholdRuleCondition (egy metrika küszöbértéke alapján). |
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). Ha meg van adva, akkor 5 perc és 1 nap között kell lennie. |
ManagementEventAggregationCondition
Az összegyűjtött adatok időbeli összevonásának módját.
Name | Típus | Description |
---|---|---|
operator |
a feltétel operátor. |
|
threshold |
number |
A riasztást aktiváló küszöbérték. |
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). Ha meg van adva, akkor 5 perc és 1 nap között kell lennie. |
ManagementEventRuleCondition
Egy felügyeleti eseményszabály feltétele.
Name | Típus | Description |
---|---|---|
aggregation |
Az összegyűjtött adatok egyesítése az idő függvényében és a riasztás aktiválásakor. Vegye figyelembe, hogy a felügyeleti eseményriasztások összesítése nem kötelező – ha nincs megadva, akkor bármely esemény aktiválja a riasztást. |
|
dataSource | RuleDataSource: |
az erőforrás, amelyből a szabály adatokat gyűjt. Ehhez a típushoz a dataSource mindig RuleMetricDataSource típusú lesz. |
odata.type |
string:
Microsoft. |
a feltétel típusát adja meg. Ez a következő három típus egyike lehet: ManagementEventRuleCondition (felügyeleti események előfordulásai), LocationThresholdRuleCondition (egy webes teszt hibáinak száma alapján) és ThresholdRuleCondition (egy metrika küszöbértéke alapján). |
RuleEmailAction
Megadja azt a műveletet, amely e-mailt küld a szabályfeltétel kiértékelésekor. Ebben az esetben a diszkriminatív a RuleEmailAction.
Name | Típus | Description |
---|---|---|
customEmails |
string[] |
a rendszergazda egyéni e-mail-címeinek listája a riasztás aktiválásáról való értesítéshez. |
odata.type |
string:
Microsoft. |
a művelet típusát adja meg. Kétféle művelet létezik: RuleEmailAction és RuleWebhookAction. |
sendToServiceOwners |
boolean |
Arról, hogy a szolgáltatás rendszergazdáinak (szolgáltatás- és társadminisztrátorainak) értesítést kell-e kapniuk a riasztás aktiválásakor. |
RuleManagementEventClaimsDataSource
Egy szabálykezelési esemény adatforrásának jogcíme.
Name | Típus | Description |
---|---|---|
emailAddress |
string |
az e-mail-címet. |
RuleManagementEventDataSource
Szabálykezelési esemény adatforrása. Ebben az esetben a diszkriminatív mezők mindig RuleManagementEventDataSource.
Name | Típus | Description |
---|---|---|
claims |
a jogcímeket. |
|
eventName |
string |
az esemény neve. |
eventSource |
string |
az eseményforrást. |
legacyResourceId |
string |
a szabály által figyelt erőforrás örökölt erőforrás-azonosítója. MEGJEGYZÉS: ez a tulajdonság egy meglévő szabály esetében nem frissíthető. |
level |
string |
a szintet. |
metricNamespace |
string |
a metrika névtere. |
odata.type |
string:
Microsoft. |
az adatforrás típusát adja meg. Kétféle szabályadatforrás létezik: RuleMetricDataSource és RuleManagementEventDataSource |
operationName |
string |
Annak a műveletnek a neve, amelyet ellenőrizni kell. Ha nincs megadva név, minden művelet megegyezik. |
resourceGroupName |
string |
az erőforráscsoport neve. |
resourceLocation |
string |
az erőforrás helye. |
resourceProviderName |
string |
az erőforrás-szolgáltató neve. |
resourceUri |
string |
a szabály által figyelt erőforrás erőforrás-azonosítója. MEGJEGYZÉS: ez a tulajdonság egy meglévő szabály esetében nem frissíthető. |
status |
string |
Annak a műveletnek az állapota, amelyet ellenőrizni kell. Ha nincs megadva állapot, az állapotok megegyeznek. |
subStatus |
string |
az alállapot. |
RuleMetricDataSource
Szabálymetrika adatforrása. Ebben az esetben a diszkriminatív érték mindig RuleMetricDataSource.
Name | Típus | Description |
---|---|---|
legacyResourceId |
string |
a szabály által figyelt erőforrás örökölt erőforrás-azonosítója. MEGJEGYZÉS: ez a tulajdonság egy meglévő szabály esetében nem frissíthető. |
metricName |
string |
a szabály által figyelt metrika neve. |
metricNamespace |
string |
a metrika névtere. |
odata.type |
string:
Microsoft. |
az adatforrás típusát adja meg. Kétféle szabályadatforrás létezik: RuleMetricDataSource és RuleManagementEventDataSource |
resourceLocation |
string |
az erőforrás helye. |
resourceUri |
string |
a szabály által figyelt erőforrás erőforrás-azonosítója. MEGJEGYZÉS: ez a tulajdonság egy meglévő szabály esetében nem frissíthető. |
RuleWebhookAction
Megadja azt a műveletet, amelyet a szabályfeltétel kiértékelésekor közzé kell tenni a szolgáltatásban. Ebben az esetben a diszkriminatív a RuleWebhookAction.
Name | Típus | Description |
---|---|---|
odata.type |
string:
Microsoft. |
a művelet típusát adja meg. Kétféle művelet létezik: RuleEmailAction és RuleWebhookAction. |
properties |
object |
az utóműveletbe belefoglalandó egyéni tulajdonságok szótárát. Ezek az adatok hozzá lesznek fűzve a webhook hasznos adataihoz. |
serviceUri |
string |
a szolgáltatás URI-ja az értesítés közzététele a riasztás aktiválásakor vagy feloldásakor. |
ThresholdRuleCondition
Egy küszöbértéket átlépő metrikán alapuló szabályfeltétel.
Name | Típus | Description |
---|---|---|
dataSource | RuleDataSource: |
az erőforrás, amelyből a szabály adatokat gyűjt. Ehhez a típushoz a dataSource mindig RuleMetricDataSource típusú lesz. |
odata.type |
string:
Microsoft. |
a feltétel típusát adja meg. Ez a következő három típus egyike lehet: ManagementEventRuleCondition (felügyeleti események előfordulásai), LocationThresholdRuleCondition (egy webes teszt hibáinak száma alapján) és ThresholdRuleCondition (egy metrika küszöbértéke alapján). |
operator |
az operátor, amelyet az adatok és a küszöbérték összehasonlítására használt. |
|
threshold |
number |
a riasztást aktiváló küszöbérték. |
timeAggregation |
az időösszesítési operátor. Az összegyűjtött adatok időbeli összevonásának módját. Az alapértelmezett érték a metrika PrimaryAggregationType értéke. |
|
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). Ha meg van adva, akkor 5 perc és 1 nap között kell lennie. |
TimeAggregationOperator
A szabályban engedélyezett összesítő operátorok.
Name | Típus | Description |
---|---|---|
Average |
string |
|
Last |
string |
|
Maximum |
string |
|
Minimum |
string |
|
Total |
string |