Alertes Microsoft.Insights
Définition de ressource Bicep
Le type de ressource alertrules peut être déployé avec des opérations qui ciblent :
- Groupes de ressources - Voir commandes de déploiement de groupe de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.
Format des ressources
Pour créer une ressource Microsoft.Insights/alertrules, ajoutez le Bicep suivant à votre modèle.
resource symbolicname 'Microsoft.Insights/alertrules@2016-03-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
action: {
'odata.type': 'string'
// For remaining properties, see RuleAction objects
}
actions: [
{
'odata.type': 'string'
// For remaining properties, see RuleAction objects
}
]
condition: {
dataSource: {
legacyResourceId: 'string'
metricNamespace: 'string'
resourceLocation: 'string'
resourceUri: 'string'
'odata.type': 'string'
// For remaining properties, see RuleDataSource objects
}
'odata.type': 'string'
// For remaining properties, see RuleCondition objects
}
description: 'string'
isEnabled: bool
name: 'string'
provisioningState: 'string'
}
}
Objets RuleAction
Définissez la propriété odata.type pour spécifier le type d’objet.
Pour Microsoft.Azure.Management.Insights.Models.RuleEmailAction, utilisez :
'odata.type': 'Microsoft.Azure.Management.Insights.Models.RuleEmailAction'
customEmails: [
'string'
]
sendToServiceOwners: bool
Pour Microsoft.Azure.Management.Insights.Models.RuleWebhookAction, utilisez :
'odata.type': 'Microsoft.Azure.Management.Insights.Models.RuleWebhookAction'
properties: {}
serviceUri: 'string'
Objets RuleCondition
Définissez la propriété odata.type pour spécifier le type d’objet.
Pour Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition, utilisez :
'odata.type': 'Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition'
failedLocationCount: int
windowSize: 'string'
Pour Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition, utilisez :
'odata.type': 'Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition'
aggregation: {
operator: 'string'
threshold: int
windowSize: 'string'
}
Pour Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition, utilisez :
'odata.type': 'Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition'
operator: 'string'
threshold: int
timeAggregation: 'string'
windowSize: 'string'
Objets RuleDataSource
Définissez la propriété odata.type pour spécifier le type d’objet.
Pour Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource, utilisez :
'odata.type': 'Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource'
claims: {
emailAddress: 'string'
}
eventName: 'string'
eventSource: 'string'
level: 'string'
operationName: 'string'
resourceGroupName: 'string'
resourceProviderName: 'string'
status: 'string'
subStatus: 'string'
Pour Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource, utilisez :
'odata.type': 'Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource'
metricName: 'string'
Valeurs de propriétés
alertrules
| Nom | Description | Valeur |
|---|---|---|
| name | Nom de la ressource | string (obligatoire) |
| location | Emplacement de la ressource | string (obligatoire) |
| tags | Balises de ressource | Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles |
| properties | Propriétés de la règle d’alerte de la ressource. | AlertRule (obligatoire) |
AlertRule
| Nom | Description | Valeur |
|---|---|---|
| action | action effectuée lorsque la règle d’alerte devient active et lorsqu’une condition d’alerte est résolue. | RuleAction |
| actions | tableau d’actions qui sont effectuées lorsque la règle d’alerte devient active et lorsqu’une condition d’alerte est résolue. | RuleAction[] |
| condition | condition qui entraîne l’activation de la règle d’alerte. | RuleCondition (obligatoire) |
| description | description de la règle d’alerte qui sera incluse dans l’e-mail d’alerte. | string |
| isEnabled | Indicateur qui indique si la règle d’alerte est activée. | bool (obligatoire) |
| name | nom de la règle d’alerte. | string (obligatoire) |
| provisioningState | état d’approvisionnement. | string |
RuleAction
| Nom | Description | Valeur |
|---|---|---|
| odata.type | Définir le type d’objet | Microsoft.Azure.Management.Insights.Models.RuleEmailAction Microsoft.Azure.Management.Insights.Models.RuleWebhookAction (obligatoire) |
RuleEmailAction
| Nom | Description | Valeur |
|---|---|---|
| odata.type | spécifie le type de l’action. Il existe deux types d’actions : RuleEmailAction et RuleWebhookAction. | « Microsoft.Azure.Management.Insights.Models.RuleEmailAction » (obligatoire) |
| customEmails | liste des adresses e-mail personnalisées de l’administrateur à notifier de l’activation de l’alerte. | string[] |
| sendToServiceOwners | Indique si les administrateurs (et coadministrateurs) du service doivent être avertis lors de l'activation de l'alerte. | bool |
RuleWebhookAction
| Nom | Description | Valeur |
|---|---|---|
| odata.type | spécifie le type de l’action. Il existe deux types d’actions : RuleEmailAction et RuleWebhookAction. | « Microsoft.Azure.Management.Insights.Models.RuleWebhookAction » (obligatoire) |
| properties | dictionnaire de propriétés personnalisées à inclure dans l’opération de publication. Ces données sont ajoutées à la charge utile du webhook. | object |
| serviceUri | URI de service pour publier la notification lorsque l’alerte s’active ou se résout. | string |
Rulecondition
| Nom | Description | Valeur |
|---|---|---|
| dataSource | ressource à partir de laquelle la règle collecte ses données. Pour ce type, dataSource sera toujours de type RuleMetricDataSource. | RuleDataSource |
| odata.type | Définir le type d’objet | Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition (obligatoire) |
RuleDataSource
| Nom | Description | Valeur |
|---|---|---|
| legacyResourceId | identificateur de ressource hérité de la ressource surveillée par la règle. REMARQUE : cette propriété ne peut pas être mise à jour pour une règle existante. | string |
| metricNamespace | espace de noms de la métrique. | string |
| resourceLocation | emplacement de la ressource. | string |
| resourceUri | identificateur de ressource de la ressource surveillée par la règle. REMARQUE : cette propriété ne peut pas être mise à jour pour une règle existante. | string |
| odata.type | Définir le type d’objet | Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource (obligatoire) |
RuleManagementEventDataSource
| Nom | Description | Valeur |
|---|---|---|
| odata.type | spécifie le type de source de données. Il existe deux types de sources de données de règle : RuleMetricDataSource et RuleManagementEventDataSource | « Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource » (obligatoire) |
| réclamations | les revendications. | RuleManagementEventClaimsDataSource |
| eventName | nom de l’événement. | string |
| eventSource | source de l’événement. | string |
| niveau | niveau. | string |
| operationName | Nom de l'opération à véfifier. Si aucun nom n'est spécifié, toute opération est concernée. | string |
| resourceGroupName | nom du groupe de ressources. | string |
| resourceProviderName | nom du fournisseur de ressources. | string |
| status | État de l'opération à vérifier. Si aucun état n'est spécifié, toute état est concerné. | string |
| subStatus | sous-état. | string |
RuleManagementEventClaimsDataSource
| Nom | Description | Valeur |
|---|---|---|
| emailAddress | adresse e-mail. | string |
RuleMetricDataSource
| Nom | Description | Valeur |
|---|---|---|
| odata.type | spécifie le type de source de données. Il existe deux types de sources de données de règle : RuleMetricDataSource et RuleManagementEventDataSource | « Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource » (obligatoire) |
| metricName | nom de la métrique qui définit ce que la règle surveille. | string |
LocationThresholdRuleCondition
| Nom | Description | Valeur |
|---|---|---|
| odata.type | 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). | « Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition » (obligatoire) |
| failedLocationCount | nombre d’emplacements qui ne doivent pas pouvoir activer l’alerte. | int (obligatoire) Contraintes : Valeur minimale = 0 |
| windowSize | 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. | string |
ManagementEventRuleCondition
| Nom | Description | Valeur |
|---|---|---|
| odata.type | 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). | « Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition » (obligatoire) |
| 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. | ManagementEventAggregationCondition |
ManagementEventAggregationCondition
| Nom | Description | Valeur |
|---|---|---|
| operator | opérateur de condition. | 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' |
| threshold | Valeur de seuil qui active l'alerte. | int |
| windowSize | 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. | string |
ThresholdRuleCondition
| Nom | Description | Valeur |
|---|---|---|
| odata.type | 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). | « Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition » (obligatoire) |
| operator | opérateur utilisé pour comparer les données et le seuil. | 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' (obligatoire) |
| threshold | valeur de seuil qui active l’alerte. | int (obligatoire) |
| 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. | 'Moyenne' 'Last' 'Maximum' 'Minimum' 'Total' |
| windowSize | 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. | string |
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
| Modèle | Description |
|---|---|
Attaque DDoS sur une machine virtuelle |
Cela permet de déployer une machine virtuelle, OMS et d’autres ressources réseau. Effectuez l’attaque DDoS en suivant les guidleines et exécutez le scénario de détection d’une attaque DDoS. |
Définition de ressources de modèle ARM
Le type de ressource alertrules peut être déployé avec des opérations qui ciblent :
- Groupes de ressources - Voir commandes de déploiement de groupes de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.
Format des ressources
Pour créer une ressource Microsoft.Insights/alertrules, ajoutez le code JSON suivant à votre modèle.
{
"type": "Microsoft.Insights/alertrules",
"apiVersion": "2016-03-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"action": {
"odata.type": "string"
// For remaining properties, see RuleAction objects
},
"actions": [
{
"odata.type": "string"
// For remaining properties, see RuleAction objects
}
],
"condition": {
"dataSource": {
"legacyResourceId": "string",
"metricNamespace": "string",
"resourceLocation": "string",
"resourceUri": "string",
"odata.type": "string"
// For remaining properties, see RuleDataSource objects
},
"odata.type": "string"
// For remaining properties, see RuleCondition objects
},
"description": "string",
"isEnabled": "bool",
"name": "string",
"provisioningState": "string"
}
}
Objets RuleAction
Définissez la propriété odata.type pour spécifier le type d’objet.
Pour Microsoft.Azure.Management.Insights.Models.RuleEmailAction, utilisez :
"odata.type": "Microsoft.Azure.Management.Insights.Models.RuleEmailAction",
"customEmails": [ "string" ],
"sendToServiceOwners": "bool"
Pour Microsoft.Azure.Management.Insights.Models.RuleWebhookAction, utilisez :
"odata.type": "Microsoft.Azure.Management.Insights.Models.RuleWebhookAction",
"properties": {},
"serviceUri": "string"
Objets RuleCondition
Définissez la propriété odata.type pour spécifier le type d’objet.
Pour Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition, utilisez :
"odata.type": "Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition",
"failedLocationCount": "int",
"windowSize": "string"
Pour Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition, utilisez :
"odata.type": "Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition",
"aggregation": {
"operator": "string",
"threshold": "int",
"windowSize": "string"
}
Pour Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition, utilisez :
"odata.type": "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition",
"operator": "string",
"threshold": "int",
"timeAggregation": "string",
"windowSize": "string"
Objets RuleDataSource
Définissez la propriété odata.type pour spécifier le type d’objet.
Pour Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource, utilisez :
"odata.type": "Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource",
"claims": {
"emailAddress": "string"
},
"eventName": "string",
"eventSource": "string",
"level": "string",
"operationName": "string",
"resourceGroupName": "string",
"resourceProviderName": "string",
"status": "string",
"subStatus": "string"
Pour Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource, utilisez :
"odata.type": "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource",
"metricName": "string"
Valeurs de propriétés
alertrules
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.Insights/alertrules » |
| apiVersion | Version de l’API de ressource | '2016-03-01' |
| name | Nom de la ressource | chaîne (obligatoire) |
| location | Emplacement de la ressource | chaîne (obligatoire) |
| tags | Balises de ressource | Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles |
| properties | Propriétés de la règle d’alerte de la ressource. | AlertRule (obligatoire) |
AlertRule
| Nom | Description | Valeur |
|---|---|---|
| action | action effectuée lorsque la règle d’alerte devient active et lorsqu’une condition d’alerte est résolue. | RuleAction |
| actions | tableau d’actions qui sont effectuées lorsque la règle d’alerte devient active et lorsqu’une condition d’alerte est résolue. | RuleAction[] |
| condition | condition qui entraîne l’activation de la règle d’alerte. | RuleCondition (obligatoire) |
| description | description de la règle d’alerte qui sera incluse dans l’e-mail d’alerte. | string |
| isEnabled | indicateur qui indique si la règle d’alerte est activée. | bool (obligatoire) |
| name | nom de la règle d’alerte. | chaîne (obligatoire) |
| provisioningState | état d’approvisionnement. | string |
RuleAction
| Nom | Description | Valeur |
|---|---|---|
| odata.type | Définir le type d’objet | Microsoft.Azure.Management.Insights.Models.RuleEmailAction Microsoft.Azure.Management.Insights.Models.RuleWebhookAction (obligatoire) |
RuleEmailAction
| Nom | Description | Valeur |
|---|---|---|
| odata.type | spécifie le type de l’action. Il existe deux types d’actions : RuleEmailAction et RuleWebhookAction. | « Microsoft.Azure.Management.Insights.Models.RuleEmailAction » (obligatoire) |
| customEmails | liste des adresses e-mail personnalisées de l’administrateur à notifier de l’activation de l’alerte. | string[] |
| sendToServiceOwners | Indique si les administrateurs (et coadministrateurs) du service doivent être avertis lors de l'activation de l'alerte. | bool |
RuleWebhookAction
| Nom | Description | Valeur |
|---|---|---|
| odata.type | spécifie le type de l’action. Il existe deux types d’actions : RuleEmailAction et RuleWebhookAction. | « Microsoft.Azure.Management.Insights.Models.RuleWebhookAction » (obligatoire) |
| properties | dictionnaire des propriétés personnalisées à inclure dans l’opération post. Ces données sont ajoutées à la charge utile du webhook. | object |
| serviceUri | uri de service pour publier la notification lorsque l’alerte s’active ou se résout. | string |
Rulecondition
| Nom | Description | Valeur |
|---|---|---|
| dataSource | ressource à partir de laquelle la règle collecte ses données. Pour ce type, dataSource sera toujours de type RuleMetricDataSource. | RuleDataSource |
| odata.type | Définir le type d’objet | Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition (obligatoire) |
RuleDataSource
| Nom | Description | Valeur |
|---|---|---|
| legacyResourceId | identificateur de ressource hérité de la ressource surveillée par la règle. REMARQUE : cette propriété ne peut pas être mise à jour pour une règle existante. | string |
| metricNamespace | espace de noms de la métrique. | string |
| resourceLocation | emplacement de la ressource. | string |
| resourceUri | identificateur de ressource de la ressource surveillée par la règle. REMARQUE : cette propriété ne peut pas être mise à jour pour une règle existante. | string |
| odata.type | Définir le type d’objet | Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource (obligatoire) |
RuleManagementEventDataSource
| Nom | Description | Valeur |
|---|---|---|
| odata.type | spécifie le type de source de données. Il existe deux types de sources de données de règle : RuleMetricDataSource et RuleManagementEventDataSource | « Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource » (obligatoire) |
| réclamations | les revendications. | RuleManagementEventClaimsDataSource |
| eventName | nom de l’événement. | string |
| eventSource | source de l’événement. | string |
| niveau | niveau. | string |
| operationName | Nom de l'opération à véfifier. Si aucun nom n'est spécifié, toute opération est concernée. | string |
| resourceGroupName | nom du groupe de ressources. | string |
| resourceProviderName | nom du fournisseur de ressources. | string |
| status | État de l'opération à vérifier. Si aucun état n'est spécifié, toute état est concerné. | string |
| subStatus | sous-état. | string |
RuleManagementEventClaimsDataSource
| Nom | Description | Valeur |
|---|---|---|
| emailAddress | adresse e-mail. | string |
RuleMetricDataSource
| Nom | Description | Valeur |
|---|---|---|
| odata.type | spécifie le type de source de données. Il existe deux types de sources de données de règle : RuleMetricDataSource et RuleManagementEventDataSource | « Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource » (obligatoire) |
| metricName | nom de la métrique qui définit ce que la règle surveille. | string |
LocationThresholdRuleCondition
| Nom | Description | Valeur |
|---|---|---|
| odata.type | 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 (basé sur le nombre d’échecs d’un test web) et ThresholdRuleCondition (basé sur le seuil d’une métrique). | « Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition » (obligatoire) |
| failedLocationCount | nombre d’emplacements qui ne peuvent pas activer l’alerte. | int (obligatoire) Contraintes : Valeur minimale = 0 |
| windowSize | la période (au format de durée ISO 8601) utilisée pour surveiller l’activité des alertes en fonction du seuil. Si elle est spécifiée, elle doit être comprise entre 5 minutes et 1 jour. | string |
ManagementEventRuleCondition
| Nom | Description | Valeur |
|---|---|---|
| odata.type | 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 (basé sur le nombre d’échecs d’un test web) et ThresholdRuleCondition (basé sur le seuil d’une métrique). | « Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition » (obligatoire) |
| aggregation | Comment les données collectées doivent être combinées au fil du temps et quand 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. | ManagementEventAggregationCondition |
ManagementEventAggregationCondition
| Nom | Description | Valeur |
|---|---|---|
| operator | opérateur de condition. | 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' |
| threshold | Valeur de seuil qui active l'alerte. | int |
| windowSize | la période (au format de durée ISO 8601) utilisée pour surveiller l’activité des alertes en fonction du seuil. Si elle est spécifiée, elle doit être comprise entre 5 minutes et 1 jour. | string |
ThresholdRuleCondition
| Nom | Description | Valeur |
|---|---|---|
| odata.type | 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 (basé sur le nombre d’échecs d’un test web) et ThresholdRuleCondition (basé sur le seuil d’une métrique). | « Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition » (obligatoire) |
| operator | opérateur utilisé pour comparer les données et le seuil. | 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' (obligatoire) |
| threshold | valeur de seuil qui active l’alerte. | int (obligatoire) |
| 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. | 'Moyenne' 'Last' 'Maximum' 'Minimum' 'Total' |
| windowSize | la période (au format de durée ISO 8601) utilisée pour surveiller l’activité des alertes en fonction du seuil. Si elle est spécifiée, elle doit être comprise entre 5 minutes et 1 jour. | string |
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
| Modèle | Description |
|---|---|
| Attaque DDoS sur une machine virtuelle |
Cette opération déploie une machine virtuelle, OMS et d’autres ressources réseau. Effectuez l’attaque DDoS en suivant les guidleines et exécutez le scénario de détection d’une attaque DDoS. |
Définition de ressource Terraform (fournisseur AzAPI)
Le type de ressource alertrules peut être déployé avec des opérations qui ciblent :
- Groupes de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.
Format des ressources
Pour créer une ressource Microsoft.Insights/alertrules, ajoutez le Terraform suivant à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Insights/alertrules@2016-03-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
action = {
odata.type = "string"
// For remaining properties, see RuleAction objects
}
actions = [
{
odata.type = "string"
// For remaining properties, see RuleAction objects
}
]
condition = {
dataSource = {
legacyResourceId = "string"
metricNamespace = "string"
resourceLocation = "string"
resourceUri = "string"
odata.type = "string"
// For remaining properties, see RuleDataSource objects
}
odata.type = "string"
// For remaining properties, see RuleCondition objects
}
description = "string"
isEnabled = bool
name = "string"
provisioningState = "string"
}
})
}
Objets RuleAction
Définissez la propriété odata.type pour spécifier le type d’objet.
Pour Microsoft.Azure.Management.Insights.Models.RuleEmailAction, utilisez :
odata.type = "Microsoft.Azure.Management.Insights.Models.RuleEmailAction"
customEmails = [
"string"
]
sendToServiceOwners = bool
Pour Microsoft.Azure.Management.Insights.Models.RuleWebhookAction, utilisez :
odata.type = "Microsoft.Azure.Management.Insights.Models.RuleWebhookAction"
properties = {}
serviceUri = "string"
Objets RuleCondition
Définissez la propriété odata.type pour spécifier le type d’objet.
Pour Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition, utilisez :
odata.type = "Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition"
failedLocationCount = int
windowSize = "string"
Pour Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition, utilisez :
odata.type = "Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition"
aggregation = {
operator = "string"
threshold = int
windowSize = "string"
}
Pour Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition, utilisez :
odata.type = "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition"
operator = "string"
threshold = int
timeAggregation = "string"
windowSize = "string"
Objets RuleDataSource
Définissez la propriété odata.type pour spécifier le type d’objet.
Pour Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource, utilisez :
odata.type = "Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource"
claims = {
emailAddress = "string"
}
eventName = "string"
eventSource = "string"
level = "string"
operationName = "string"
resourceGroupName = "string"
resourceProviderName = "string"
status = "string"
subStatus = "string"
Pour Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource, utilisez :
odata.type = "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource"
metricName = "string"
Valeurs de propriétés
alertrules
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.Insights/alertrules@2016-03-01 » |
| name | Nom de la ressource | string (obligatoire) |
| location | Emplacement de la ressource | string (obligatoire) |
| parent_id | Pour effectuer un déploiement dans un groupe de ressources, utilisez l’ID de ce groupe de ressources. | string (obligatoire) |
| tags | Balises de ressource | Dictionnaire de noms et de valeurs d’étiquettes. |
| properties | Propriétés de la règle d’alerte de la ressource. | AlertRule (obligatoire) |
AlertRule
| Nom | Description | Valeur |
|---|---|---|
| action | action effectuée lorsque la règle d’alerte devient active et lorsqu’une condition d’alerte est résolue. | RuleAction |
| actions | tableau d’actions qui sont effectuées lorsque la règle d’alerte devient active et lorsqu’une condition d’alerte est résolue. | RuleAction[] |
| condition | condition qui entraîne l’activation de la règle d’alerte. | RuleCondition (obligatoire) |
| description | description de la règle d’alerte qui sera incluse dans l’e-mail d’alerte. | string |
| isEnabled | indicateur qui indique si la règle d’alerte est activée. | bool (obligatoire) |
| name | nom de la règle d’alerte. | chaîne (obligatoire) |
| provisioningState | état d’approvisionnement. | string |
RuleAction
| Nom | Description | Valeur |
|---|---|---|
| odata.type | Définir le type d’objet | Microsoft.Azure.Management.Insights.Models.RuleEmailAction Microsoft.Azure.Management.Insights.Models.RuleWebhookAction (obligatoire) |
RuleEmailAction
| Nom | Description | Valeur |
|---|---|---|
| odata.type | spécifie le type de l’action. Il existe deux types d’actions : RuleEmailAction et RuleWebhookAction. | « Microsoft.Azure.Management.Insights.Models.RuleEmailAction » (obligatoire) |
| customEmails | liste des adresses e-mail personnalisées de l’administrateur à notifier de l’activation de l’alerte. | string[] |
| sendToServiceOwners | Indique si les administrateurs (et coadministrateurs) du service doivent être avertis lors de l'activation de l'alerte. | bool |
RuleWebhookAction
| Nom | Description | Valeur |
|---|---|---|
| odata.type | spécifie le type de l’action. Il existe deux types d’actions : RuleEmailAction et RuleWebhookAction. | « Microsoft.Azure.Management.Insights.Models.RuleWebhookAction » (obligatoire) |
| properties | dictionnaire des propriétés personnalisées à inclure dans l’opération post. Ces données sont ajoutées à la charge utile du webhook. | object |
| serviceUri | uri de service pour publier la notification lorsque l’alerte s’active ou se résout. | string |
Rulecondition
| Nom | Description | Valeur |
|---|---|---|
| dataSource | ressource à partir de laquelle la règle collecte ses données. Pour ce type, dataSource sera toujours de type RuleMetricDataSource. | RuleDataSource |
| odata.type | Définir le type d’objet | Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition (obligatoire) |
RuleDataSource
| Nom | Description | Valeur |
|---|---|---|
| legacyResourceId | 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. | string |
| metricNamespace | espace de noms de la métrique. | string |
| resourceLocation | emplacement de la ressource. | string |
| resourceUri | 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. | string |
| odata.type | Définir le type d’objet | Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource (obligatoire) |
RuleManagementEventDataSource
| Nom | Description | Valeur |
|---|---|---|
| odata.type | spécifie le type de source de données. Il existe deux types de sources de données de règle : RuleMetricDataSource et RuleManagementEventDataSource | « Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource » (obligatoire) |
| réclamations | les revendications. | RuleManagementEventClaimsDataSource |
| eventName | nom de l’événement. | string |
| eventSource | la source de l’événement. | string |
| niveau | niveau. | string |
| operationName | Nom de l'opération à véfifier. Si aucun nom n'est spécifié, toute opération est concernée. | string |
| resourceGroupName | nom du groupe de ressources. | string |
| resourceProviderName | nom du fournisseur de ressources. | string |
| status | État de l'opération à vérifier. Si aucun état n'est spécifié, toute état est concerné. | string |
| subStatus | sous-état. | string |
RuleManagementEventClaimsDataSource
| Nom | Description | Valeur |
|---|---|---|
| emailAddress | adresse e-mail. | string |
RuleMetricDataSource
| Nom | Description | Valeur |
|---|---|---|
| odata.type | spécifie le type de source de données. Il existe deux types de sources de données de règle : RuleMetricDataSource et RuleManagementEventDataSource | « Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource » (obligatoire) |
| metricName | nom de la métrique qui définit ce que la règle surveille. | string |
LocationThresholdRuleCondition
| Nom | Description | Valeur |
|---|---|---|
| odata.type | 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). | « Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition » (obligatoire) |
| failedLocationCount | nombre d’emplacements qui ne doivent pas pouvoir activer l’alerte. | int (obligatoire) Contraintes : Valeur minimale = 0 |
| windowSize | 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. | string |
ManagementEventRuleCondition
| Nom | Description | Valeur |
|---|---|---|
| odata.type | 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). | « Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition » (obligatoire) |
| 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. | ManagementEventAggregationCondition |
ManagementEventAggregationCondition
| Nom | Description | Valeur |
|---|---|---|
| operator | opérateur de condition. | « GreaterThan » « GreaterThanOrEqual » « LessThan » « LessThanOrEqual » |
| threshold | Valeur de seuil qui active l'alerte. | int |
| windowSize | 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. | string |
ThresholdRuleCondition
| Nom | Description | Valeur |
|---|---|---|
| odata.type | 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). | « Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition » (obligatoire) |
| operator | opérateur utilisé pour comparer les données et le seuil. | « GreaterThan » « GreaterThanOrEqual » « LessThan » « LessThanOrEqual » (obligatoire) |
| threshold | valeur de seuil qui active l’alerte. | int (obligatoire) |
| 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. | « Moyenne » « Dernier » « Maximum » « Minimum » « Total » |
| windowSize | 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. | string |
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour