Alert Rules - Update
Uppdateringar ett befintligt klassiskt mått AlertRuleResource. Om du vill uppdatera andra fält använder du metoden CreateOrUpdate.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/alertrules/{ruleName}?api-version=2016-03-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Namnet på resursgruppen. Namnet är skiftlägesokänsligt. |
rule
|
path | True |
string |
Namnet på regeln. |
subscription
|
path | True |
string |
ID för målprenumerationen. |
api-version
|
query | True |
string |
Den API-version som ska användas för den här åtgärden. |
Begärandetext
Name | Obligatorisk | Typ | Description |
---|---|---|---|
properties.condition | True | RuleCondition: |
villkoret som resulterar i att aviseringsregeln aktiveras. |
properties.isEnabled | True |
boolean |
flaggan som anger om aviseringsregeln är aktiverad. |
properties.name | True |
string |
namnet på aviseringsregeln. |
properties.action | RuleAction: |
åtgärd som utförs när aviseringsregeln blir aktiv och när ett aviseringsvillkor har lösts. |
|
properties.actions | RuleAction[]: |
matrisen med åtgärder som utförs när aviseringsregeln blir aktiv och när ett aviseringsvillkor löses. |
|
properties.description |
string |
beskrivningen av aviseringsregeln som ska ingå i aviseringsmeddelandet. |
|
properties.provisioningState |
string |
etableringstillståndet. |
|
tags |
object |
Resurstaggar |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Lyckad begäran om att uppdatera en aviseringsregel |
|
201 Created |
Lyckad begäran om att uppdatera en aviseringsregel som resulterade i att aviseringsregeln skapades |
|
Other Status Codes |
Felsvar som beskriver varför åtgärden misslyckades. |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto |
Exempel
Patch an alert rule
Exempelbegäran
PATCH https://management.azure.com/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourcegroups/Rac46PostSwapRG/providers/Microsoft.Insights/alertrules/chiricutin?api-version=2016-03-01
{
"tags": {
"$type": "Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary"
},
"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": []
}
}
Exempelsvar
{
"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"
},
"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"
},
"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": []
}
}
Definitioner
Name | Description |
---|---|
Alert |
Resursen för aviseringsregeln. |
Alert |
Aviseringsregelobjektet för korrigeringsåtgärder. |
Condition |
Operatorer tillåts i regelvillkoret. |
Error |
Beskriver formatet för felsvar. |
Location |
Ett regelvillkor baserat på ett visst antal platser som misslyckas. |
Management |
Hur de data som samlas in ska kombineras över tid. |
Management |
Ett regelvillkor för hanteringshändelser. |
Rule |
Anger åtgärden för att skicka e-post när regelvillkoret utvärderas. Diskriminatorn är alltid RuleEmailAction i det här fallet. |
Rule |
Anspråk för en datakälla för regelhanteringshändelser. |
Rule |
En datakälla för regelhanteringshändelser. De diskriminerande fälten är alltid RuleManagementEventDataSource i det här fallet. |
Rule |
En regelmåttdatakälla. Diskriminatorvärdet är alltid RuleMetricDataSource i det här fallet. |
Rule |
Anger vilken åtgärd som ska skickas till tjänsten när regelvillkoret utvärderas. Diskriminatorn är alltid RuleWebhookAction i det här fallet. |
Threshold |
Ett regelvillkor baserat på ett mått som överskrider ett tröskelvärde. |
Time |
Sammansättningsoperatorer tillåts i en regel. |
AlertRuleResource
Resursen för aviseringsregeln.
Name | Typ | Description |
---|---|---|
id |
string |
Resurs-ID för Azure |
location |
string |
Resursplats |
name |
string |
Azure-resursnamn |
properties.action | RuleAction: |
åtgärd som utförs när aviseringsregeln blir aktiv och när ett aviseringsvillkor har lösts. |
properties.actions | RuleAction[]: |
matrisen med åtgärder som utförs när aviseringsregeln blir aktiv och när ett aviseringsvillkor löses. |
properties.condition | RuleCondition: |
villkoret som resulterar i att aviseringsregeln aktiveras. |
properties.description |
string |
beskrivningen av aviseringsregeln som ska ingå i aviseringsmeddelandet. |
properties.isEnabled |
boolean |
flaggan som anger om aviseringsregeln är aktiverad. |
properties.lastUpdatedTime |
string |
Senaste gången regeln uppdaterades i ISO8601 format. |
properties.name |
string |
namnet på aviseringsregeln. |
properties.provisioningState |
string |
etableringstillståndet. |
tags |
object |
Resurstaggar |
type |
string |
Azure-resurstyp |
AlertRuleResourcePatch
Aviseringsregelobjektet för korrigeringsåtgärder.
Name | Typ | Description |
---|---|---|
properties.action | RuleAction: |
åtgärd som utförs när aviseringsregeln blir aktiv och när ett aviseringsvillkor har lösts. |
properties.actions | RuleAction[]: |
matrisen med åtgärder som utförs när aviseringsregeln blir aktiv och när ett aviseringsvillkor löses. |
properties.condition | RuleCondition: |
villkoret som resulterar i att aviseringsregeln aktiveras. |
properties.description |
string |
beskrivningen av aviseringsregeln som ska ingå i aviseringsmeddelandet. |
properties.isEnabled |
boolean |
flaggan som anger om aviseringsregeln är aktiverad. |
properties.lastUpdatedTime |
string |
Senaste gången regeln uppdaterades i ISO8601 format. |
properties.name |
string |
namnet på aviseringsregeln. |
properties.provisioningState |
string |
etableringstillståndet. |
tags |
object |
Resurstaggar |
ConditionOperator
Operatorer tillåts i regelvillkoret.
Name | Typ | Description |
---|---|---|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
ErrorResponse
Beskriver formatet för felsvar.
Name | Typ | Description |
---|---|---|
code |
string |
Felkod |
message |
string |
Felmeddelande som anger varför åtgärden misslyckades. |
LocationThresholdRuleCondition
Ett regelvillkor baserat på ett visst antal platser som misslyckas.
Name | Typ | Description |
---|---|---|
dataSource | RuleDataSource: |
resursen som regeln samlar in sina data från. För den här typen är dataSource alltid av typen RuleMetricDataSource. |
failedLocationCount |
integer |
antalet platser som inte kan aktivera aviseringen. |
odata.type |
string:
Microsoft. |
anger typen av villkor. Detta kan vara en av tre typer: ManagementEventRuleCondition (förekomster av hanteringshändelser), LocationThresholdRuleCondition (baserat på antalet fel i ett webbtest) och ThresholdRuleCondition (baserat på tröskelvärdet för ett mått). |
windowSize |
string |
tidsperioden (i ISO 8601-varaktighetsformat) som används för att övervaka aviseringsaktivitet baserat på tröskelvärdet. Om det anges måste det vara mellan 5 minuter och 1 dag. |
ManagementEventAggregationCondition
Hur de data som samlas in ska kombineras över tid.
Name | Typ | Description |
---|---|---|
operator |
villkorsoperatorn. |
|
threshold |
number |
Tröskelvärdet som aktiverar aviseringen. |
windowSize |
string |
tidsperioden (i ISO 8601-varaktighetsformat) som används för att övervaka aviseringsaktivitet baserat på tröskelvärdet. Om det anges måste det vara mellan 5 minuter och 1 dag. |
ManagementEventRuleCondition
Ett regelvillkor för hanteringshändelser.
Name | Typ | Description |
---|---|---|
aggregation |
Hur de data som samlas in ska kombineras över tid och när aviseringen aktiveras. Observera att aggregering för hanteringshändelseaviseringar är valfri – om den inte anges kommer alla händelser att göra så att aviseringen aktiveras. |
|
dataSource | RuleDataSource: |
resursen som regeln samlar in sina data från. För den här typen är dataSource alltid av typen RuleMetricDataSource. |
odata.type |
string:
Microsoft. |
anger typen av villkor. Detta kan vara en av tre typer: ManagementEventRuleCondition (förekomster av hanteringshändelser), LocationThresholdRuleCondition (baserat på antalet fel i ett webbtest) och ThresholdRuleCondition (baserat på tröskelvärdet för ett mått). |
RuleEmailAction
Anger åtgärden för att skicka e-post när regelvillkoret utvärderas. Diskriminatorn är alltid RuleEmailAction i det här fallet.
Name | Typ | Description |
---|---|---|
customEmails |
string[] |
listan över administratörens anpassade e-postadresser för att meddela om aktiveringen av aviseringen. |
odata.type |
string:
Microsoft. |
anger typen av åtgärd. Det finns två typer av åtgärder: RuleEmailAction och RuleWebhookAction. |
sendToServiceOwners |
boolean |
Om administratörerna (tjänsten och medadministratörerna) för tjänsten ska meddelas när aviseringen aktiveras. |
RuleManagementEventClaimsDataSource
Anspråk för en datakälla för regelhanteringshändelser.
Name | Typ | Description |
---|---|---|
emailAddress |
string |
e-postadressen. |
RuleManagementEventDataSource
En datakälla för regelhanteringshändelser. De diskriminerande fälten är alltid RuleManagementEventDataSource i det här fallet.
Name | Typ | Description |
---|---|---|
claims |
anspråken. |
|
eventName |
string |
händelsenamnet. |
eventSource |
string |
händelsekällan. |
legacyResourceId |
string |
den äldre resursidentifieraren för resursen som regeln övervakar. Obs! Det går inte att uppdatera den här egenskapen för en befintlig regel. |
level |
string |
nivån. |
metricNamespace |
string |
måttets namnområde. |
odata.type |
string:
Microsoft. |
anger typen av datakälla. Det finns två typer av regeldatakällor: RuleMetricDataSource och RuleManagementEventDataSource |
operationName |
string |
Namnet på den åtgärd som ska kontrolleras. Om inget namn anges matchar alla åtgärder. |
resourceGroupName |
string |
resursgruppens namn. |
resourceLocation |
string |
resursens plats. |
resourceProviderName |
string |
resursproviderns namn. |
resourceUri |
string |
resursidentifieraren för resursen som regeln övervakar. Obs! Det går inte att uppdatera den här egenskapen för en befintlig regel. |
status |
string |
Status för den åtgärd som ska kontrolleras. Om ingen status anges matchar statusen. |
subStatus |
string |
understatusen. |
RuleMetricDataSource
En regelmåttdatakälla. Diskriminatorvärdet är alltid RuleMetricDataSource i det här fallet.
Name | Typ | Description |
---|---|---|
legacyResourceId |
string |
den äldre resursidentifieraren för resursen som regeln övervakar. Obs! Det går inte att uppdatera den här egenskapen för en befintlig regel. |
metricName |
string |
namnet på måttet som definierar vad regeln övervakar. |
metricNamespace |
string |
måttets namnområde. |
odata.type |
string:
Microsoft. |
anger typen av datakälla. Det finns två typer av regeldatakällor: RuleMetricDataSource och RuleManagementEventDataSource |
resourceLocation |
string |
resursens plats. |
resourceUri |
string |
resursidentifieraren för resursen som regeln övervakar. Obs! Det går inte att uppdatera den här egenskapen för en befintlig regel. |
RuleWebhookAction
Anger vilken åtgärd som ska skickas till tjänsten när regelvillkoret utvärderas. Diskriminatorn är alltid RuleWebhookAction i det här fallet.
Name | Typ | Description |
---|---|---|
odata.type |
string:
Microsoft. |
anger typen av åtgärd. Det finns två typer av åtgärder: RuleEmailAction och RuleWebhookAction. |
properties |
object |
ordlistan med anpassade egenskaper som ska inkluderas i poståtgärden. Dessa data läggs till i webhookens nyttolast. |
serviceUri |
string |
tjänstens URI för att publicera meddelandet när aviseringen aktiveras eller löses. |
ThresholdRuleCondition
Ett regelvillkor baserat på ett mått som överskrider ett tröskelvärde.
Name | Typ | Description |
---|---|---|
dataSource | RuleDataSource: |
resursen som regeln samlar in sina data från. För den här typen är dataSource alltid av typen RuleMetricDataSource. |
odata.type |
string:
Microsoft. |
anger typen av villkor. Detta kan vara en av tre typer: ManagementEventRuleCondition (förekomster av hanteringshändelser), LocationThresholdRuleCondition (baserat på antalet fel i ett webbtest) och ThresholdRuleCondition (baserat på tröskelvärdet för ett mått). |
operator |
operatorn som används för att jämföra data och tröskelvärdet. |
|
threshold |
number |
tröskelvärdet som aktiverar aviseringen. |
timeAggregation |
tidsaggregeringsoperatorn. Hur de data som samlas in ska kombineras över tid. Standardvärdet är PrimaryAggregationType för måttet. |
|
windowSize |
string |
tidsperioden (i ISO 8601-varaktighetsformat) som används för att övervaka aviseringsaktivitet baserat på tröskelvärdet. Om det anges måste det vara mellan 5 minuter och 1 dag. |
TimeAggregationOperator
Sammansättningsoperatorer tillåts i en regel.
Name | Typ | Description |
---|---|---|
Average |
string |
|
Last |
string |
|
Maximum |
string |
|
Minimum |
string |
|
Total |
string |