Alert Rules - Create Or Update
Crée ou met à jour une règle d’alerte de métrique classique.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/alertrules/{ruleName}?api-version=2016-03-01
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Nom du groupe de ressources. Le nom ne respecte pas la casse. |
rule
|
path | True |
string |
nom de la règle. |
subscription
|
path | True |
string |
ID de l’abonnement cible. |
api-version
|
query | True |
string |
Version de l’API à utiliser pour cette opération. |
Corps de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
location | True |
string |
Emplacement de la ressource |
properties.condition | True | RuleCondition: |
condition qui entraîne l’activation de la règle d’alerte. |
properties.isEnabled | True |
boolean |
indicateur qui indique si la règle d’alerte est activée. |
properties.name | True |
string |
nom de la règle d’alerte. |
properties.action | RuleAction: |
action effectuée lorsque la règle d’alerte devient active et lorsqu’une condition d’alerte est résolue. |
|
properties.actions | RuleAction[]: |
tableau d’actions qui sont effectuées lorsque la règle d’alerte devient active et lorsqu’une condition d’alerte est résolue. |
|
properties.description |
string |
description de la règle d’alerte qui sera incluse dans l’e-mail d’alerte. |
|
properties.provisioningState |
string |
état d’approvisionnement. |
|
tags |
object |
Balises de ressource |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Demande réussie de mise à jour d’une règle d’alerte |
|
201 Created |
Règle d’alerte créée |
|
Other Status Codes |
Réponse d’erreur décrivant la raison de l’échec de l’opération. |
Sécurité
azure_auth
Flux OAuth2 Azure Active Directory
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
Nom | Description |
---|---|
user_impersonation | Emprunter l’identité de votre compte d’utilisateur |
Exemples
Create or update an alert rule
Exemple de requête
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": []
}
}
Exemple de réponse
{
"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": []
}
}
Définitions
Nom | Description |
---|---|
Alert |
Ressource de règle d’alerte. |
Condition |
Opérateurs autorisés dans la condition de règle. |
Error |
Décrit le format de réponse d’erreur. |
Location |
Condition de règle basée sur l’échec d’un certain nombre d’emplacements. |
Management |
Détermine la façon dont les données collectées doivent être combinées au fil du temps. |
Management |
Condition de règle d’événement de gestion. |
Rule |
Spécifie l’action à envoyer un e-mail lorsque la condition de règle est évaluée. Le discriminateur est toujours RuleEmailAction dans ce cas. |
Rule |
Revendications d’une source de données d’événement de gestion des règles. |
Rule |
Source de données d’événements de gestion des règles. Dans ce cas, les champs discriminateurs sont toujours RuleManagementEventDataSource. |
Rule |
Source de données de métrique de règle. La valeur du discriminateur est toujours RuleMetricDataSource dans ce cas. |
Rule |
Spécifie l’action à publier dans le service lorsque la condition de règle est évaluée. Le discriminateur est toujours RuleWebhookAction dans ce cas. |
Threshold |
Condition de règle basée sur le dépassement d’un seuil par une métrique. |
Time |
Opérateurs d’agrégation autorisés dans une règle. |
AlertRuleResource
Ressource de règle d’alerte.
Nom | Type | Description |
---|---|---|
id |
string |
ID de ressource Azure |
location |
string |
Emplacement de la ressource |
name |
string |
Nom de la ressource Azure |
properties.action | RuleAction: |
action effectuée lorsque la règle d’alerte devient active et lorsqu’une condition d’alerte est résolue. |
properties.actions | RuleAction[]: |
tableau d’actions qui sont effectuées lorsque la règle d’alerte devient active et lorsqu’une condition d’alerte est résolue. |
properties.condition | RuleCondition: |
condition qui entraîne l’activation de la règle d’alerte. |
properties.description |
string |
description de la règle d’alerte qui sera incluse dans l’e-mail d’alerte. |
properties.isEnabled |
boolean |
indicateur qui indique si la règle d’alerte est activée. |
properties.lastUpdatedTime |
string |
Dernière mise à jour de la règle au format ISO8601. |
properties.name |
string |
nom de la règle d’alerte. |
properties.provisioningState |
string |
état d’approvisionnement. |
tags |
object |
Balises de ressource |
type |
string |
Type de ressource Azure |
ConditionOperator
Opérateurs autorisés dans la condition de règle.
Nom | Type | Description |
---|---|---|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
ErrorResponse
Décrit le format de réponse d’erreur.
Nom | Type | Description |
---|---|---|
code |
string |
Code d'erreur |
message |
string |
Message d’erreur indiquant la raison de l’échec de l’opération. |
LocationThresholdRuleCondition
Condition de règle basée sur l’échec d’un certain nombre d’emplacements.
Nom | Type | Description |
---|---|---|
dataSource | RuleDataSource: |
ressource à partir de laquelle la règle collecte ses données. Pour ce type, dataSource sera toujours de type RuleMetricDataSource. |
failedLocationCount |
integer |
nombre d’emplacements qui ne doivent pas pouvoir activer l’alerte. |
odata.type |
string:
Microsoft. |
spécifie le type de condition. Il peut s’agir de l’un des trois types suivants : ManagementEventRuleCondition (occurrences d’événements de gestion), LocationThresholdRuleCondition (en fonction du nombre d’échecs d’un test web) et ThresholdRuleCondition (basé sur le seuil d’une métrique). |
windowSize |
string |
la période (au format durée ISO 8601) utilisée pour surveiller l’activité d’alerte en fonction du seuil. Si elle est spécifiée, elle doit être comprise entre 5 minutes et 1 jour. |
ManagementEventAggregationCondition
Détermine la façon dont les données collectées doivent être combinées au fil du temps.
Nom | Type | Description |
---|---|---|
operator |
opérateur de condition. |
|
threshold |
number |
Valeur de seuil qui active l'alerte. |
windowSize |
string |
la période (au format durée ISO 8601) utilisée pour surveiller l’activité d’alerte en fonction du seuil. Si elle est spécifiée, elle doit être comprise entre 5 minutes et 1 jour. |
ManagementEventRuleCondition
Condition de règle d’événement de gestion.
Nom | Type | Description |
---|---|---|
aggregation |
Comment les données collectées doivent être combinées au fil du temps et lorsque l’alerte est activée. Notez que, pour les alertes d'événement de gestion, l'agrégation est facultative. Si elle n'est pas spécifiée, tout événement entraîne l'activation de l'alerte. |
|
dataSource | RuleDataSource: |
ressource à partir de laquelle la règle collecte ses données. Pour ce type, dataSource sera toujours de type RuleMetricDataSource. |
odata.type |
string:
Microsoft. |
spécifie le type de condition. Il peut s’agir de l’un des trois types suivants : ManagementEventRuleCondition (occurrences d’événements de gestion), LocationThresholdRuleCondition (en fonction du nombre d’échecs d’un test web) et ThresholdRuleCondition (basé sur le seuil d’une métrique). |
RuleEmailAction
Spécifie l’action à envoyer un e-mail lorsque la condition de règle est évaluée. Le discriminateur est toujours RuleEmailAction dans ce cas.
Nom | Type | Description |
---|---|---|
customEmails |
string[] |
liste des adresses e-mail personnalisées de l’administrateur à notifier de l’activation de l’alerte. |
odata.type |
string:
Microsoft. |
spécifie le type de l’action. Il existe deux types d’actions : RuleEmailAction et RuleWebhookAction. |
sendToServiceOwners |
boolean |
Indique si les administrateurs (et coadministrateurs) du service doivent être avertis lors de l'activation de l'alerte. |
RuleManagementEventClaimsDataSource
Revendications d’une source de données d’événement de gestion des règles.
Nom | Type | Description |
---|---|---|
emailAddress |
string |
adresse e-mail. |
RuleManagementEventDataSource
Source de données d’événements de gestion des règles. Dans ce cas, les champs discriminateurs sont toujours RuleManagementEventDataSource.
Nom | Type | Description |
---|---|---|
claims |
les revendications. |
|
eventName |
string |
nom de l’événement. |
eventSource |
string |
la source de l’événement. |
legacyResourceId |
string |
identificateur de ressource hérité de la ressource que la règle surveille. REMARQUE : cette propriété ne peut pas être mise à jour pour une règle existante. |
level |
string |
niveau. |
metricNamespace |
string |
espace de noms de la métrique. |
odata.type |
string:
Microsoft. |
spécifie le type de source de données. Il existe deux types de sources de données de règle : RuleMetricDataSource et RuleManagementEventDataSource |
operationName |
string |
Nom de l'opération à véfifier. Si aucun nom n'est spécifié, toute opération est concernée. |
resourceGroupName |
string |
nom du groupe de ressources. |
resourceLocation |
string |
emplacement de la ressource. |
resourceProviderName |
string |
nom du fournisseur de ressources. |
resourceUri |
string |
identificateur de ressource de la ressource que la règle surveille. REMARQUE : cette propriété ne peut pas être mise à jour pour une règle existante. |
status |
string |
État de l'opération à vérifier. Si aucun état n'est spécifié, toute état est concerné. |
subStatus |
string |
sous-état. |
RuleMetricDataSource
Source de données de métrique de règle. La valeur du discriminateur est toujours RuleMetricDataSource dans ce cas.
Nom | Type | Description |
---|---|---|
legacyResourceId |
string |
identificateur de ressource hérité de la ressource que la règle surveille. REMARQUE : cette propriété ne peut pas être mise à jour pour une règle existante. |
metricName |
string |
nom de la métrique qui définit ce que la règle surveille. |
metricNamespace |
string |
espace de noms de la métrique. |
odata.type |
string:
Microsoft. |
spécifie le type de source de données. Il existe deux types de sources de données de règle : RuleMetricDataSource et RuleManagementEventDataSource |
resourceLocation |
string |
emplacement de la ressource. |
resourceUri |
string |
identificateur de ressource de la ressource que la règle surveille. REMARQUE : cette propriété ne peut pas être mise à jour pour une règle existante. |
RuleWebhookAction
Spécifie l’action à publier dans le service lorsque la condition de règle est évaluée. Le discriminateur est toujours RuleWebhookAction dans ce cas.
Nom | Type | Description |
---|---|---|
odata.type |
string:
Microsoft. |
spécifie le type de l’action. Il existe deux types d’actions : RuleEmailAction et RuleWebhookAction. |
properties |
object |
dictionnaire des propriétés personnalisées à inclure dans l’opération post. Ces données sont ajoutées à la charge utile du webhook. |
serviceUri |
string |
uri de service pour publier la notification lorsque l’alerte s’active ou se résout. |
ThresholdRuleCondition
Condition de règle basée sur le dépassement d’un seuil par une métrique.
Nom | Type | Description |
---|---|---|
dataSource | RuleDataSource: |
ressource à partir de laquelle la règle collecte ses données. Pour ce type, dataSource sera toujours de type RuleMetricDataSource. |
odata.type |
string:
Microsoft. |
spécifie le type de condition. Il peut s’agir de l’un des trois types suivants : ManagementEventRuleCondition (occurrences d’événements de gestion), LocationThresholdRuleCondition (en fonction du nombre d’échecs d’un test web) et ThresholdRuleCondition (basé sur le seuil d’une métrique). |
operator |
opérateur utilisé pour comparer les données et le seuil. |
|
threshold |
number |
valeur de seuil qui active l’alerte. |
timeAggregation |
opérateur d’agrégation de temps. Comment les données collectées doivent être combinées au fil du temps. La valeur par défaut est PrimaryAggregationType de la métrique. |
|
windowSize |
string |
la période (au format durée ISO 8601) utilisée pour surveiller l’activité d’alerte en fonction du seuil. Si elle est spécifiée, elle doit être comprise entre 5 minutes et 1 jour. |
TimeAggregationOperator
Opérateurs d’agrégation autorisés dans une règle.
Nom | Type | Description |
---|---|---|
Average |
string |
|
Last |
string |
|
Maximum |
string |
|
Minimum |
string |
|
Total |
string |