Partage via

Add-AzMetricAlertRule

  • Référence
Module:
Az.Monitor

Ajoute ou met à jour une règle d’alerte basée sur des métriques claasic (déjà mise hors service sur le cloud public). Pour créer une règle d’alerte de métrique, utilisez l’applet de commande Add-AzMetricAlertRuleV2 .

Syntaxe

Add-AzMetricAlertRule
   -WindowSize <TimeSpan>
   -Operator <ConditionOperator>
   -Threshold <Double>
   -TargetResourceId <String>
   -MetricName <String>
   -TimeAggregationOperator <TimeAggregationOperator>
   -Location <String>
   [-Description <String>]
   [-DisableRule]
   -ResourceGroupName <String>
   -Name <String>
   [-Action <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.RuleAction]>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

L’applet de commande Add-AzMetricAlertRule ajoute ou met à jour une règle d’alerte basée sur les métriques. La règle ajoutée est associée à un groupe de ressources et a un nom. Cette applet de commande implémente le modèle ShouldProcess, c’est-à-dire qu’il peut demander la confirmation de l’utilisateur avant de créer, de modifier ou de supprimer la ressource.

Exemples

Exemple 1 : Ajouter une règle d’alerte de métrique à un site web

Add-AzMetricAlertRule -Name "metricRule5" -Location "East US" -ResourceGroup "Default-Web-EastUS" -Operator GreaterThan -Threshold 2 -WindowSize 00:05:00 -MetricName "Requests" -Description "Pura Vida" -TimeAggregationOperator Total

RequestId                                                                                                    StatusCode
---------                                                                                                    ----------
33574ccf-0b01-43b4-aa97-87e6bbcf1c11                                                                         Created

Cette commande crée une règle d’alerte de métrique pour un site web.

Exemple 2 : Désactiver une règle

Add-AzMetricAlertRule -Name "metricRule5" -Location "East US" -ResourceGroup Default-Web-EastUS -Operator GreaterThan -Threshold 2 -WindowSize 00:05:00 -MetricName "Requests" -TimeAggregationOperator Total

RequestId                                                                                                    StatusCode
---------                                                                                                    ----------
96c489f1-8529-46e1-a76d-2c1463ca3116                                                                                 OK

Cette commande désactive une règle. Si la règle n’existe pas, elle la crée désactivée. Si la règle existe, elle la désactive simplement.

Exemple 3 : Ajouter une règle avec des actions

Add-AzMetricAlertRule -Name "metricRule5" -Location "East US" -ResourceGroup "Default-Web-EastUS" -Operator GreaterThan -Threshold 1 -TargetResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/mywebsite" -MetricName "Requests" -TimeAggregationOperator Total

RequestId                                                                                                    StatusCode
---------                                                                                                    ----------
9a5bc388-c7ac-4dc6-aa70-f4bc29c2c712                                                                                 OK

Cette commande crée une règle d’alerte de métrique pour un site web.

Paramètres

-Action

Spécifie une liste séparée par des virgules d’actions.

Type:List<T>[RuleAction]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Confirm

Vous demande une confirmation avant d’exécuter l’applet de commande.

Type:SwitchParameter
Alias:cf
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure

Type:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Description

Spécifie une description de la règle.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-DisableRule

Il désactive la règle. Si vous ne spécifiez pas ce paramètre, la règle est activée.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Location

Spécifie l’emplacement où la règle est définie.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-MetricName

Spécifie le nom de la métrique que la règle surveille. Spécifiez ce paramètre uniquement pour les règles basées sur les métriques.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Name

Spécifie le nom de la règle.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Operator

Spécifie l’opérateur relationnel pour la condition de la règle. Les valeurs valides pour ce paramètre sont :

  • GreaterThan
  • GreaterThanOrEqual
  • LessThan
  • LessThanOrEqual
Type:ConditionOperator
Valeurs acceptées:GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-ResourceGroupName

Spécifie le nom du groupe de ressources pour la règle.

Type:String
Alias:ResourceGroup
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-TargetResourceId

Spécifie l’ID de la ressource que la règle surveille. REMARQUE : cette propriété ne peut pas être mise à jour pour une règle d’alerte existante.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Threshold

Spécifie le seuil de la règle.

Type:Double
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-TimeAggregationOperator

Spécifie l’opérateur d’agrégation à appliquer à la fenêtre de temps lorsque la règle est évaluée.

Type:Nullable<T>[TimeAggregationOperator]
Valeurs acceptées:Average, Minimum, Maximum, Total, Last
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

Type:SwitchParameter
Alias:wi
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-WindowSize

Spécifie la taille de la fenêtre de temps pour que la règle calcule ses données.

Type:TimeSpan
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

Entrées

TimeSpan

ConditionOperator

Double

String

Nullable<T>[[Microsoft.Azure.Management.Monitor.Management.Models.TimeAggregationOperator, Microsoft.Azure.PowerShell.Cmdlets.Monitor, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

SwitchParameter

List<T>[[Microsoft.Azure.Management.Monitor.Management.Models.RuleAction, Microsoft.Azure.PowerShell.Cmdlets.Monitor, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

Sorties

PSAddAlertRuleOperationResponse