Alert Rules - Create Or Update
Hiermee maakt of werkt u een klassieke waarschuwingsregel voor metrische gegevens bij.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/alertrules/{ruleName}?api-version=2016-03-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig. |
rule
|
path | True |
string |
De naam van de regel. |
subscription
|
path | True |
string |
De id van het doelabonnement. |
api-version
|
query | True |
string |
De API-versie die voor deze bewerking moet worden gebruikt. |
Aanvraagbody
Name | Vereist | Type | Description |
---|---|---|---|
location | True |
string |
Resourcelocatie |
properties.condition | True | RuleCondition: |
de voorwaarde die tot gevolg heeft dat de waarschuwingsregel wordt geactiveerd. |
properties.isEnabled | True |
boolean |
de vlag die aangeeft of de waarschuwingsregel is ingeschakeld. |
properties.name | True |
string |
de naam van de waarschuwingsregel. |
properties.action | RuleAction: |
actie die wordt uitgevoerd wanneer de waarschuwingsregel actief wordt en wanneer een waarschuwingsvoorwaarde is opgelost. |
|
properties.actions | RuleAction[]: |
de matrix met acties die worden uitgevoerd wanneer de waarschuwingsregel actief wordt en wanneer een waarschuwingsvoorwaarde is opgelost. |
|
properties.description |
string |
de beschrijving van de waarschuwingsregel die wordt opgenomen in de waarschuwings-e-mail. |
|
properties.provisioningState |
string |
de inrichtingsstatus. |
|
tags |
object |
Resourcetags |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
Geslaagde aanvraag voor het bijwerken van een waarschuwingsregel |
|
201 Created |
Waarschuwingsregel gemaakt |
|
Other Status Codes |
Foutreactie waarin wordt beschreven waarom de bewerking is mislukt. |
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
Name | Description |
---|---|
user_impersonation | uw gebruikersaccount imiteren |
Voorbeelden
Create or update an alert rule
Voorbeeldaanvraag
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": []
}
}
Voorbeeldrespons
{
"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": []
}
}
Definities
Name | Description |
---|---|
Alert |
De waarschuwingsregelresource. |
Condition |
Operators die zijn toegestaan in de regelvoorwaarde. |
Error |
Beschrijft de indeling van foutantwoord. |
Location |
Een regelvoorwaarde op basis van een bepaald aantal locaties mislukt. |
Management |
Hoe de verzamelde gegevens in de loop van de tijd moeten worden gecombineerd. |
Management |
Een regelvoorwaarde voor beheerevenementen. |
Rule |
Hiermee geeft u de actie voor het verzenden van e-mail wanneer de regelvoorwaarde wordt geëvalueerd. De discriminator is in dit geval altijd RuleEmailAction. |
Rule |
De claims voor een gebeurtenisbron voor regelbeheer. |
Rule |
Een gebeurtenisgegevensbron voor regelbeheer. De discriminatorvelden zijn in dit geval altijd RuleManagementEventDataSource. |
Rule |
Een metrische gegevensbron van een regel. De discriminatorwaarde is in dit geval altijd RuleMetricDataSource. |
Rule |
Hiermee geeft u de actie op die naar de service moet worden geplaatst wanneer de regelvoorwaarde wordt geëvalueerd. De discriminator is in dit geval altijd RuleWebhookAction. |
Threshold |
Een regelvoorwaarde op basis van een metrische waarde die een drempelwaarde overschrijdt. |
Time |
Aggregatieoperators die zijn toegestaan in een regel. |
AlertRuleResource
De waarschuwingsregelresource.
Name | Type | Description |
---|---|---|
id |
string |
Azure-resource-id |
location |
string |
Resourcelocatie |
name |
string |
Azure-resourcenaam |
properties.action | RuleAction: |
actie die wordt uitgevoerd wanneer de waarschuwingsregel actief wordt en wanneer een waarschuwingsvoorwaarde is opgelost. |
properties.actions | RuleAction[]: |
de matrix met acties die worden uitgevoerd wanneer de waarschuwingsregel actief wordt en wanneer een waarschuwingsvoorwaarde is opgelost. |
properties.condition | RuleCondition: |
de voorwaarde die tot gevolg heeft dat de waarschuwingsregel wordt geactiveerd. |
properties.description |
string |
de beschrijving van de waarschuwingsregel die wordt opgenomen in de waarschuwings-e-mail. |
properties.isEnabled |
boolean |
de vlag die aangeeft of de waarschuwingsregel is ingeschakeld. |
properties.lastUpdatedTime |
string |
De laatste keer dat de regel is bijgewerkt in ISO8601 indeling. |
properties.name |
string |
de naam van de waarschuwingsregel. |
properties.provisioningState |
string |
de inrichtingsstatus. |
tags |
object |
Resourcetags |
type |
string |
Azure-resourcetype |
ConditionOperator
Operators die zijn toegestaan in de regelvoorwaarde.
Name | Type | Description |
---|---|---|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
ErrorResponse
Beschrijft de indeling van foutantwoord.
Name | Type | Description |
---|---|---|
code |
string |
Foutcode |
message |
string |
Foutbericht waarin wordt aangegeven waarom de bewerking is mislukt. |
LocationThresholdRuleCondition
Een regelvoorwaarde op basis van een bepaald aantal locaties mislukt.
Name | Type | Description |
---|---|---|
dataSource | RuleDataSource: |
de resource waaruit de regel de gegevens verzamelt. Voor dit type is dataSource altijd van het type RuleMetricDataSource. |
failedLocationCount |
integer |
het aantal locaties waarvoor de waarschuwing niet kan worden geactiveerd. |
odata.type |
string:
Microsoft. |
hiermee geeft u het type voorwaarde op. Dit kan een van de volgende drie typen zijn: ManagementEventRuleCondition (gebeurtenissen van beheer gebeurtenissen), LocationThresholdRuleCondition (op basis van het aantal fouten van een webtest) en ThresholdRuleCondition (op basis van de drempelwaarde van een metrische waarde). |
windowSize |
string |
de periode (in ISO 8601-duurnotatie) die wordt gebruikt voor het bewaken van waarschuwingsactiviteiten op basis van de drempelwaarde. Indien opgegeven, moet dit tussen 5 minuten en 1 dag zijn. |
ManagementEventAggregationCondition
Hoe de verzamelde gegevens in de loop van de tijd moeten worden gecombineerd.
Name | Type | Description |
---|---|---|
operator |
de operator voorwaarde. |
|
threshold |
number |
De drempelwaarde die de waarschuwing activeert. |
windowSize |
string |
de periode (in ISO 8601-duurnotatie) die wordt gebruikt voor het bewaken van waarschuwingsactiviteiten op basis van de drempelwaarde. Indien opgegeven, moet dit tussen 5 minuten en 1 dag zijn. |
ManagementEventRuleCondition
Een regelvoorwaarde voor beheerevenementen.
Name | Type | Description |
---|---|---|
aggregation |
Hoe de verzamelde gegevens in de loop van de tijd moeten worden gecombineerd en wanneer de waarschuwing wordt geactiveerd. Houd er rekening mee dat aggregatie voor waarschuwingen voor beheerevenementen optioneel is. Als deze niet is opgegeven, zorgt een gebeurtenis ervoor dat de waarschuwing wordt geactiveerd. |
|
dataSource | RuleDataSource: |
de resource waaruit de regel de gegevens verzamelt. Voor dit type is dataSource altijd van het type RuleMetricDataSource. |
odata.type |
string:
Microsoft. |
hiermee geeft u het type voorwaarde op. Dit kan een van de volgende drie typen zijn: ManagementEventRuleCondition (gebeurtenissen van beheer gebeurtenissen), LocationThresholdRuleCondition (op basis van het aantal fouten van een webtest) en ThresholdRuleCondition (op basis van de drempelwaarde van een metrische waarde). |
RuleEmailAction
Hiermee geeft u de actie voor het verzenden van e-mail wanneer de regelvoorwaarde wordt geëvalueerd. De discriminator is in dit geval altijd RuleEmailAction.
Name | Type | Description |
---|---|---|
customEmails |
string[] |
de lijst met aangepaste e-mailadressen van de beheerder om de activering van de waarschuwing te melden. |
odata.type |
string:
Microsoft. |
hiermee geeft u het type van de actie op. Er zijn twee soorten acties: RuleEmailAction en RuleWebhookAction. |
sendToServiceOwners |
boolean |
Of de beheerders (service en medebeheerders) van de service op de hoogte moeten worden gesteld wanneer de waarschuwing wordt geactiveerd. |
RuleManagementEventClaimsDataSource
De claims voor een gebeurtenisbron voor regelbeheer.
Name | Type | Description |
---|---|---|
emailAddress |
string |
het e-mailadres. |
RuleManagementEventDataSource
Een gebeurtenisgegevensbron voor regelbeheer. De discriminatorvelden zijn in dit geval altijd RuleManagementEventDataSource.
Name | Type | Description |
---|---|---|
claims |
de claims. |
|
eventName |
string |
de naam van de gebeurtenis. |
eventSource |
string |
de gebeurtenisbron. |
legacyResourceId |
string |
de verouderde resource-id van de resource die door de regel wordt bewaakt. OPMERKING: deze eigenschap kan niet worden bijgewerkt voor een bestaande regel. |
level |
string |
het niveau. |
metricNamespace |
string |
de naamruimte van de metrische waarde. |
odata.type |
string:
Microsoft. |
hiermee geeft u het type gegevensbron op. Er zijn twee typen regelgegevensbronnen: RuleMetricDataSource en RuleManagementEventDataSource |
operationName |
string |
De naam van de bewerking die moet worden gecontroleerd. Als er geen naam wordt opgegeven, komt elke bewerking overeen. |
resourceGroupName |
string |
de naam van de resourcegroep. |
resourceLocation |
string |
de locatie van de resource. |
resourceProviderName |
string |
de naam van de resourceprovider. |
resourceUri |
string |
de resource-id van de resource die door de regel wordt bewaakt. OPMERKING: deze eigenschap kan niet worden bijgewerkt voor een bestaande regel. |
status |
string |
De status van de bewerking waarop moet worden gecontroleerd. Als er geen status wordt opgegeven, komt elke status overeen. |
subStatus |
string |
de substatus. |
RuleMetricDataSource
Een metrische gegevensbron van een regel. De discriminatorwaarde is in dit geval altijd RuleMetricDataSource.
Name | Type | Description |
---|---|---|
legacyResourceId |
string |
de verouderde resource-id van de resource die door de regel wordt bewaakt. OPMERKING: deze eigenschap kan niet worden bijgewerkt voor een bestaande regel. |
metricName |
string |
de naam van de metrische waarde die definieert wat de regel bewaakt. |
metricNamespace |
string |
de naamruimte van de metrische waarde. |
odata.type |
string:
Microsoft. |
hiermee geeft u het type gegevensbron op. Er zijn twee typen regelgegevensbronnen: RuleMetricDataSource en RuleManagementEventDataSource |
resourceLocation |
string |
de locatie van de resource. |
resourceUri |
string |
de resource-id van de resource die door de regel wordt bewaakt. OPMERKING: deze eigenschap kan niet worden bijgewerkt voor een bestaande regel. |
RuleWebhookAction
Hiermee geeft u de actie op die naar de service moet worden geplaatst wanneer de regelvoorwaarde wordt geëvalueerd. De discriminator is in dit geval altijd RuleWebhookAction.
Name | Type | Description |
---|---|---|
odata.type |
string:
Microsoft. |
hiermee geeft u het type van de actie op. Er zijn twee soorten acties: RuleEmailAction en RuleWebhookAction. |
properties |
object |
de woordenlijst met aangepaste eigenschappen die moeten worden opgenomen bij de postbewerking. Deze gegevens worden toegevoegd aan de nettolading van de webhook. |
serviceUri |
string |
de service-URI naar Post de melding wanneer de waarschuwing wordt geactiveerd of opgelost. |
ThresholdRuleCondition
Een regelvoorwaarde op basis van een metrische waarde die een drempelwaarde overschrijdt.
Name | Type | Description |
---|---|---|
dataSource | RuleDataSource: |
de resource waaruit de regel de gegevens verzamelt. Voor dit type is dataSource altijd van het type RuleMetricDataSource. |
odata.type |
string:
Microsoft. |
hiermee geeft u het type voorwaarde op. Dit kan een van de volgende drie typen zijn: ManagementEventRuleCondition (gebeurtenissen van beheer gebeurtenissen), LocationThresholdRuleCondition (op basis van het aantal fouten van een webtest) en ThresholdRuleCondition (op basis van de drempelwaarde van een metrische waarde). |
operator |
de operator die wordt gebruikt om de gegevens en de drempelwaarde te vergelijken. |
|
threshold |
number |
de drempelwaarde die de waarschuwing activeert. |
timeAggregation |
de tijdaggregatieoperator. Hoe de verzamelde gegevens in de loop van de tijd moeten worden gecombineerd. De standaardwaarde is het PrimaryAggregationType van de metrische waarde. |
|
windowSize |
string |
de periode (in ISO 8601-duurnotatie) die wordt gebruikt voor het bewaken van waarschuwingsactiviteiten op basis van de drempelwaarde. Indien opgegeven, moet dit tussen 5 minuten en 1 dag zijn. |
TimeAggregationOperator
Aggregatieoperators die zijn toegestaan in een regel.
Name | Type | Description |
---|---|---|
Average |
string |
|
Last |
string |
|
Maximum |
string |
|
Minimum |
string |
|
Total |
string |