Alertes Microsoft.Insights 2014-04-01
Définition de ressource Bicep
Le type de ressource alertrules peut être déployé avec des opérations qui ciblent :
- groupes de ressources - Consultez 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 de ressource
Pour créer une ressource Microsoft.Insights/alertrules, ajoutez le bicep suivant à votre modèle.
resource symbolicname 'Microsoft.Insights/alertrules@2014-04-01' = {
location: 'string'
name: 'string'
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'
}
tags: {
{customized property}: '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 :
{
customEmails: [
'string'
]
odata.type: 'Microsoft.Azure.Management.Insights.Models.RuleEmailAction'
sendToServiceOwners: bool
}
Pour Microsoft.Azure.Management.Insights.Models.RuleWebhookAction, utilisez :
{
odata.type: 'Microsoft.Azure.Management.Insights.Models.RuleWebhookAction'
properties: {
{customized property}: 'string'
}
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 :
{
failedLocationCount: int
odata.type: 'Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition'
windowSize: 'string'
}
Pour Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition, utilisez :
{
aggregation: {
operator: 'string'
threshold: int
windowSize: 'string'
}
odata.type: 'Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition'
}
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 :
{
claims: {
emailAddress: 'string'
}
eventName: 'string'
eventSource: 'string'
level: 'string'
odata.type: 'Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource'
operationName: 'string'
resourceGroupName: 'string'
resourceProviderName: 'string'
status: 'string'
subStatus: 'string'
}
Pour Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource, utilisez :
{
metricName: 'string'
odata.type: 'Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource'
}
Valeurs de propriété
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 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. | corde |
isEnabled | indicateur qui indique si la règle d’alerte est activée. | bool (obligatoire) |
nom | nom de la règle d’alerte. | chaîne (obligatoire) |
provisioningState | état d’approvisionnement. | corde |
LocationThresholdRuleCondition
Nom | Description | Valeur |
---|---|---|
failedLocationCount | nombre d’emplacements qui doivent échouer pour activer l’alerte. | Int Contraintes: Valeur minimale = 0 (obligatoire) |
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) |
windowSize | période (au format de 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. | corde |
ManagementEventAggregationCondition
Nom | Description | Valeur |
---|---|---|
opérateur | opérateur de condition. | 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' |
seuil | Valeur de seuil qui active l’alerte. | Int |
windowSize | période (au format de 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. | corde |
ManagementEventRuleCondition
Nom | Description | Valeur |
---|---|---|
agrégation | Comment les données collectées doivent être combinées au fil du temps et lorsque l’alerte est activée. Notez que pour l’agrégation des alertes d’événements de gestion est facultative . Si aucun événement n’est fourni, l’alerte est activée. | ManagementEventAggregationCondition |
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) |
Microsoft.Insights/alertrules
Nom | Description | Valeur |
---|---|---|
emplacement | Emplacement des ressources | chaîne (obligatoire) |
nom | Nom de la ressource | chaîne (obligatoire) |
Propriétés | Propriétés de la règle d’alerte de la ressource. | AlertRule (obligatoire) |
étiquettes | Balises de ressource | Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles |
ResourceTags
Nom | Description | Valeur |
---|
RuleAction
Nom | Description | Valeur |
---|---|---|
odata.type | Défini sur « Microsoft.Azure.Management.Insights.Models.RuleEmailAction » pour le type RuleEmailAction. Défini sur « Microsoft.Azure.Management.Insights.Models.RuleWebhookAction » pour le type RuleWebhookAction. | 'Microsoft.Azure.Management.Insights.Models.RuleEmailAction' 'Microsoft.Azure.Management.Insights.Models.RuleWebhookAction' (obligatoire) |
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éfini sur « Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition » pour le type LocationThresholdRuleCondition. Défini sur « Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition » pour le type ManagementEventRuleCondition. Défini sur « Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition » pour le type ThresholdRuleCondition. | 'Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition' 'Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition' 'Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition' (obligatoire) |
RuleDataSource
Nom | Description | Valeur |
---|---|---|
legacyResourceId | l’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. | corde |
metricNamespace | espace de noms de la métrique. | corde |
odata.type | Défini sur « Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource » pour le type RuleManagementEventDataSource. Défini sur « Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource » pour le type RuleMetricDataSource. | 'Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource' 'Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource' (obligatoire) |
resourceLocation | emplacement de la ressource. | corde |
resourceUri | l’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. | corde |
RuleEmailAction
Nom | Description | Valeur |
---|---|---|
customEmails | liste des adresses e-mail personnalisées de l’administrateur à notifier l’activation de l’alerte. | string[] |
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) |
sendToServiceOwners | Indique si les administrateurs (service et coadministrateurs) du service doivent être avertis lorsque l’alerte est activée. | Bool |
RuleManagementEventClaimsDataSource
Nom | Description | Valeur |
---|---|---|
emailAddress | adresse e-mail. | corde |
RuleManagementEventDataSource
Nom | Description | Valeur |
---|---|---|
Revendications | revendications. | RuleManagementEventClaimsDataSource |
eventName | nom de l’événement. | corde |
eventSource | source de l’événement. | corde |
niveau | niveau. | corde |
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) |
operationName | Nom de l’opération à rechercher. Si aucun nom n’est fourni, toute opération correspond. | corde |
resourceGroupName | nom du groupe de ressources. | corde |
resourceProviderName | nom du fournisseur de ressources. | corde |
statut | État de l’opération à rechercher. Si aucun état n’est fourni, un état correspond. | corde |
subStatus | sous-état. | corde |
RuleMetricDataSource
Nom | Description | Valeur |
---|---|---|
metricName | nom de la métrique qui définit ce que la règle surveille. | corde |
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) |
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) |
Propriétés | dictionnaire de propriétés personnalisées à inclure avec l’opération de publication. Ces données sont ajoutées à la charge utile du webhook. | RuleWebhookActionProperties |
serviceUri | uri de service pour publier la notification lorsque l’alerte active ou résout. | corde |
RuleWebhookActionProperties
Nom | Description | Valeur |
---|
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) |
opérateur | opérateur utilisé pour comparer les données et le seuil. | 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' (obligatoire) |
seuil | 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. | 'Average' 'Last' 'Maximum' 'Minimum' 'Total' |
windowSize | période (au format de 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. | corde |
Définition de ressource de modèle ARM
Le type de ressource alertrules peut être déployé avec des opérations qui ciblent :
- groupes de ressources - Consultez 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 de ressource
Pour créer une ressource Microsoft.Insights/alertrules, ajoutez le code JSON suivant à votre modèle.
{
"type": "Microsoft.Insights/alertrules",
"apiVersion": "2014-04-01",
"name": "string",
"location": "string",
"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"
},
"tags": {
"{customized property}": "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 :
{
"customEmails": [ "string" ],
"odata.type": "Microsoft.Azure.Management.Insights.Models.RuleEmailAction",
"sendToServiceOwners": "bool"
}
Pour Microsoft.Azure.Management.Insights.Models.RuleWebhookAction, utilisez :
{
"odata.type": "Microsoft.Azure.Management.Insights.Models.RuleWebhookAction",
"properties": {
"{customized property}": "string"
},
"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 :
{
"failedLocationCount": "int",
"odata.type": "Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition",
"windowSize": "string"
}
Pour Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition, utilisez :
{
"aggregation": {
"operator": "string",
"threshold": "int",
"windowSize": "string"
},
"odata.type": "Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition"
}
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 :
{
"claims": {
"emailAddress": "string"
},
"eventName": "string",
"eventSource": "string",
"level": "string",
"odata.type": "Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource",
"operationName": "string",
"resourceGroupName": "string",
"resourceProviderName": "string",
"status": "string",
"subStatus": "string"
}
Pour Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource, utilisez :
{
"metricName": "string",
"odata.type": "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource"
}
Valeurs de propriété
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 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. | corde |
isEnabled | indicateur qui indique si la règle d’alerte est activée. | bool (obligatoire) |
nom | nom de la règle d’alerte. | chaîne (obligatoire) |
provisioningState | état d’approvisionnement. | corde |
LocationThresholdRuleCondition
Nom | Description | Valeur |
---|---|---|
failedLocationCount | nombre d’emplacements qui doivent échouer pour activer l’alerte. | Int Contraintes: Valeur minimale = 0 (obligatoire) |
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) |
windowSize | période (au format de 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. | corde |
ManagementEventAggregationCondition
Nom | Description | Valeur |
---|---|---|
opérateur | opérateur de condition. | 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' |
seuil | Valeur de seuil qui active l’alerte. | Int |
windowSize | période (au format de 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. | corde |
ManagementEventRuleCondition
Nom | Description | Valeur |
---|---|---|
agrégation | Comment les données collectées doivent être combinées au fil du temps et lorsque l’alerte est activée. Notez que pour l’agrégation des alertes d’événements de gestion est facultative . Si aucun événement n’est fourni, l’alerte est activée. | ManagementEventAggregationCondition |
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) |
Microsoft.Insights/alertrules
Nom | Description | Valeur |
---|---|---|
apiVersion | Version de l’API | '2014-04-01' |
emplacement | Emplacement des ressources | chaîne (obligatoire) |
nom | Nom de la ressource | chaîne (obligatoire) |
Propriétés | Propriétés de la règle d’alerte de la ressource. | AlertRule (obligatoire) |
étiquettes | Balises de ressource | Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles |
type | Type de ressource | 'Microsoft.Insights/alertrules' |
ResourceTags
Nom | Description | Valeur |
---|
RuleAction
Nom | Description | Valeur |
---|---|---|
odata.type | Défini sur « Microsoft.Azure.Management.Insights.Models.RuleEmailAction » pour le type RuleEmailAction. Défini sur « Microsoft.Azure.Management.Insights.Models.RuleWebhookAction » pour le type RuleWebhookAction. | 'Microsoft.Azure.Management.Insights.Models.RuleEmailAction' 'Microsoft.Azure.Management.Insights.Models.RuleWebhookAction' (obligatoire) |
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éfini sur « Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition » pour le type LocationThresholdRuleCondition. Défini sur « Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition » pour le type ManagementEventRuleCondition. Défini sur « Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition » pour le type ThresholdRuleCondition. | 'Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition' 'Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition' 'Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition' (obligatoire) |
RuleDataSource
Nom | Description | Valeur |
---|---|---|
legacyResourceId | l’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. | corde |
metricNamespace | espace de noms de la métrique. | corde |
odata.type | Défini sur « Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource » pour le type RuleManagementEventDataSource. Défini sur « Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource » pour le type RuleMetricDataSource. | 'Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource' 'Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource' (obligatoire) |
resourceLocation | emplacement de la ressource. | corde |
resourceUri | l’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. | corde |
RuleEmailAction
Nom | Description | Valeur |
---|---|---|
customEmails | liste des adresses e-mail personnalisées de l’administrateur à notifier l’activation de l’alerte. | string[] |
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) |
sendToServiceOwners | Indique si les administrateurs (service et coadministrateurs) du service doivent être avertis lorsque l’alerte est activée. | Bool |
RuleManagementEventClaimsDataSource
Nom | Description | Valeur |
---|---|---|
emailAddress | adresse e-mail. | corde |
RuleManagementEventDataSource
Nom | Description | Valeur |
---|---|---|
Revendications | revendications. | RuleManagementEventClaimsDataSource |
eventName | nom de l’événement. | corde |
eventSource | source de l’événement. | corde |
niveau | niveau. | corde |
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) |
operationName | Nom de l’opération à rechercher. Si aucun nom n’est fourni, toute opération correspond. | corde |
resourceGroupName | nom du groupe de ressources. | corde |
resourceProviderName | nom du fournisseur de ressources. | corde |
statut | État de l’opération à rechercher. Si aucun état n’est fourni, un état correspond. | corde |
subStatus | sous-état. | corde |
RuleMetricDataSource
Nom | Description | Valeur |
---|---|---|
metricName | nom de la métrique qui définit ce que la règle surveille. | corde |
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) |
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) |
Propriétés | dictionnaire de propriétés personnalisées à inclure avec l’opération de publication. Ces données sont ajoutées à la charge utile du webhook. | RuleWebhookActionProperties |
serviceUri | uri de service pour publier la notification lorsque l’alerte active ou résout. | corde |
RuleWebhookActionProperties
Nom | Description | Valeur |
---|
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) |
opérateur | opérateur utilisé pour comparer les données et le seuil. | 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' (obligatoire) |
seuil | 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. | 'Average' 'Last' 'Maximum' 'Minimum' 'Total' |
windowSize | période (au format de 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. | corde |
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 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 de l’API, consultez journal des modifications.
Format de ressource
Pour créer une ressource Microsoft.Insights/alertrules, ajoutez terraform suivant à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Insights/alertrules@2014-04-01"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
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 :
{
customEmails = [
"string"
]
odata.type = "Microsoft.Azure.Management.Insights.Models.RuleEmailAction"
sendToServiceOwners = bool
}
Pour Microsoft.Azure.Management.Insights.Models.RuleWebhookAction, utilisez :
{
odata.type = "Microsoft.Azure.Management.Insights.Models.RuleWebhookAction"
properties = {
{customized property} = "string"
}
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 :
{
failedLocationCount = int
odata.type = "Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition"
windowSize = "string"
}
Pour Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition, utilisez :
{
aggregation = {
operator = "string"
threshold = int
windowSize = "string"
}
odata.type = "Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition"
}
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 :
{
claims = {
emailAddress = "string"
}
eventName = "string"
eventSource = "string"
level = "string"
odata.type = "Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource"
operationName = "string"
resourceGroupName = "string"
resourceProviderName = "string"
status = "string"
subStatus = "string"
}
Pour Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource, utilisez :
{
metricName = "string"
odata.type = "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource"
}
Valeurs de propriété
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 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. | corde |
isEnabled | indicateur qui indique si la règle d’alerte est activée. | bool (obligatoire) |
nom | nom de la règle d’alerte. | chaîne (obligatoire) |
provisioningState | état d’approvisionnement. | corde |
LocationThresholdRuleCondition
Nom | Description | Valeur |
---|---|---|
failedLocationCount | nombre d’emplacements qui doivent échouer pour activer l’alerte. | Int Contraintes: Valeur minimale = 0 (obligatoire) |
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) |
windowSize | période (au format de 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. | corde |
ManagementEventAggregationCondition
Nom | Description | Valeur |
---|---|---|
opérateur | opérateur de condition. | 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' |
seuil | Valeur de seuil qui active l’alerte. | Int |
windowSize | période (au format de 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. | corde |
ManagementEventRuleCondition
Nom | Description | Valeur |
---|---|---|
agrégation | Comment les données collectées doivent être combinées au fil du temps et lorsque l’alerte est activée. Notez que pour l’agrégation des alertes d’événements de gestion est facultative . Si aucun événement n’est fourni, l’alerte est activée. | ManagementEventAggregationCondition |
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) |
Microsoft.Insights/alertrules
Nom | Description | Valeur |
---|---|---|
emplacement | Emplacement des ressources | chaîne (obligatoire) |
nom | Nom de la ressource | chaîne (obligatoire) |
Propriétés | Propriétés de la règle d’alerte de la ressource. | AlertRule (obligatoire) |
étiquettes | Balises de ressource | Dictionnaire de noms et de valeurs d’étiquettes. |
type | Type de ressource | « Microsoft.Insights/alertrules@2014-04-01 » |
ResourceTags
Nom | Description | Valeur |
---|
RuleAction
Nom | Description | Valeur |
---|---|---|
odata.type | Défini sur « Microsoft.Azure.Management.Insights.Models.RuleEmailAction » pour le type RuleEmailAction. Défini sur « Microsoft.Azure.Management.Insights.Models.RuleWebhookAction » pour le type RuleWebhookAction. | 'Microsoft.Azure.Management.Insights.Models.RuleEmailAction' 'Microsoft.Azure.Management.Insights.Models.RuleWebhookAction' (obligatoire) |
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éfini sur « Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition » pour le type LocationThresholdRuleCondition. Défini sur « Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition » pour le type ManagementEventRuleCondition. Défini sur « Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition » pour le type ThresholdRuleCondition. | 'Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition' 'Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition' 'Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition' (obligatoire) |
RuleDataSource
Nom | Description | Valeur |
---|---|---|
legacyResourceId | l’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. | corde |
metricNamespace | espace de noms de la métrique. | corde |
odata.type | Défini sur « Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource » pour le type RuleManagementEventDataSource. Défini sur « Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource » pour le type RuleMetricDataSource. | 'Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource' 'Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource' (obligatoire) |
resourceLocation | emplacement de la ressource. | corde |
resourceUri | l’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. | corde |
RuleEmailAction
Nom | Description | Valeur |
---|---|---|
customEmails | liste des adresses e-mail personnalisées de l’administrateur à notifier l’activation de l’alerte. | string[] |
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) |
sendToServiceOwners | Indique si les administrateurs (service et coadministrateurs) du service doivent être avertis lorsque l’alerte est activée. | Bool |
RuleManagementEventClaimsDataSource
Nom | Description | Valeur |
---|---|---|
emailAddress | adresse e-mail. | corde |
RuleManagementEventDataSource
Nom | Description | Valeur |
---|---|---|
Revendications | revendications. | RuleManagementEventClaimsDataSource |
eventName | nom de l’événement. | corde |
eventSource | source de l’événement. | corde |
niveau | niveau. | corde |
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) |
operationName | Nom de l’opération à rechercher. Si aucun nom n’est fourni, toute opération correspond. | corde |
resourceGroupName | nom du groupe de ressources. | corde |
resourceProviderName | nom du fournisseur de ressources. | corde |
statut | État de l’opération à rechercher. Si aucun état n’est fourni, un état correspond. | corde |
subStatus | sous-état. | corde |
RuleMetricDataSource
Nom | Description | Valeur |
---|---|---|
metricName | nom de la métrique qui définit ce que la règle surveille. | corde |
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) |
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) |
Propriétés | dictionnaire de propriétés personnalisées à inclure avec l’opération de publication. Ces données sont ajoutées à la charge utile du webhook. | RuleWebhookActionProperties |
serviceUri | uri de service pour publier la notification lorsque l’alerte active ou résout. | corde |
RuleWebhookActionProperties
Nom | Description | Valeur |
---|
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) |
opérateur | opérateur utilisé pour comparer les données et le seuil. | 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' (obligatoire) |
seuil | 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. | 'Average' 'Last' 'Maximum' 'Minimum' 'Total' |
windowSize | période (au format de 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. | corde |