Share via

New-AzPrometheusRuleGroup

  • Référence
Module:
Az.AlertsManagement

Créez ou mettez à jour une définition de groupe de règles Prometheus.

Syntax

New-AzPrometheusRuleGroup
   -ResourceGroupName <String>
   -RuleGroupName <String>
   [-SubscriptionId <String>]
   -Location <String>
   -Rule <IPrometheusRule[]>
   -Scope <String[]>
   [-ClusterName <String>]
   [-Description <String>]
   [-Enabled]
   [-Interval <TimeSpan>]
   [-Tag <Hashtable>]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Créez ou mettez à jour une définition de groupe de règles Prometheus.

Exemples

Exemple 1 : Créer une définition de groupe de règles Prometheus avec une règle.

$rule1 = New-AzPrometheusRuleObject -Record "job_type:billing_jobs_duration_seconds:99p5m"
$scope = "/subscriptions/fffffffff-ffff-ffff-ffff-ffffffffffff/resourcegroups/MyresourceGroup/providers/microsoft.monitor/accounts/MyAccounts"
New-AzPrometheusRuleGroup -ResourceGroupName MyresourceGroup -RuleGroupName MyRuleGroup -Location eastus -Rule $rule1 -Scope $scope -Enabled

Name        Location ClusterName Enabled
----        -------- ----------- -------
MyRuleGroup eastus               True

Créez une définition de groupe de règles Prometheus avec une règle.

Exemple 2 : Créer une définition de groupe de règles Prometheus avec des règles.

$rule1 = New-AzPrometheusRuleObject -Record "job_type:billing_jobs_duration_seconds:99p5m"
$action =  New-AzPrometheusRuleGroupActionObject -ActionGroupId /subscriptions/fffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/MyresourceGroup/providers/microsoft.insights/actiongroups/MyActionGroup -ActionProperty @{"key1" = "value1"}
$Timespan = New-TimeSpan -Minutes 15
$rule2 = New-AzPrometheusRuleObject -Alert Billing_Processing_Very_Slow -Expression "job_type:billing_jobs_duration_seconds:99p5m > 30" -Enabled $false -Severity 3 -For $Timespan -Label @{"team"="prod"} -Annotation @{"annotation" = "value"} -ResolveConfigurationAutoResolved $true -ResolveConfigurationTimeToResolve $Timespan -Action $action
$rules = @($rule1, $rule2)
$scope = "/subscriptions/fffffffff-ffff-ffff-ffff-ffffffffffff/resourcegroups/MyresourceGroup/providers/microsoft.monitor/accounts/MyAccounts"
New-AzPrometheusRuleGroup -ResourceGroupName MyresourceGroup -RuleGroupName MyRuleGroup -Location eastus -Rule $rule1 -Scope $scope -Enabled

Name        Location ClusterName Enabled
----        -------- ----------- -------
MyRuleGroup eastus               True

Créez une définition de groupe de règles Prometheus avec des règles.

Paramètres

-ClusterName

Appliquer une règle aux données d’un cluster spécifique.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Le paramètre DefaultProfile n’est pas fonctionnel. Utilisez le paramètre SubscriptionId lorsqu’il est disponible si vous exécutez l’applet de commande sur un autre abonnement.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Description du groupe de règles.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Enabled

Activer/désactiver le groupe de règles.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Interval

Intervalle dans lequel exécuter le groupe de règles Prometheus représenté au format de durée ISO 8601. Doit être compris entre 1 et 15 minutes

Type:TimeSpan
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Location

Emplacement géographique où réside la ressource

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Nom du groupe de ressources. Le nom ne respecte pas la casse.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Rule

Définit les règles dans le groupe de règles Prometheus. Pour construire, consultez la section NOTES pour les propriétés RULE et créer une table de hachage.

Type:IPrometheusRule[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-RuleGroupName

Nom du groupe de règles.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Scope

Cibler les ID de ressource des espaces de travail Azure Monitor. Cette version d’API est actuellement limitée à la création avec une seule étendue. Cela peut changer à l’avenir.

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

ID de l’abonnement cible.

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Tag

Balises de ressource.

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Sorties

IPrometheusRuleGroupResource

Notes

ALIAS

PROPRIÉTÉS DE PARAMÈTRES COMPLEXES

Pour créer les paramètres décrits ci-dessous, construisez une table de hachage contenant les propriétés appropriées. Pour plus d’informations sur les tables de hachage, exécutez Get-Help about_Hash_Tables.

RULE <IPrometheusRule[]>: définit les règles dans le groupe de règles Prometheus.

  • Expression <String>: expression PromQL à évaluer. https://prometheus.io/docs/prometheus/latest/querying/basics/. Évalué périodiquement comme donné par « interval », et le résultat enregistré sous la forme d’un nouvel ensemble de séries chronologiques avec le nom de métrique comme indiqué par « record ».
  • [Action <IPrometheusRuleGroupAction[]>]: actions effectuées lorsque la règle d’alerte devient active et lorsqu’une condition d’alerte est résolue.
    • [ActionGroupId <String>]: ID de ressource du groupe d’actions à utiliser.
    • [ActionProperty <IPrometheusRuleGroupActionProperties>]: propriétés d’un objet de groupe d’actions.
      • [(Any) <String>]: cela indique que n’importe quelle propriété peut être ajoutée à cet objet.
  • [Alert <String>]: nom de la règle d’alerte.
  • [Annotation <IPrometheusRuleAnnotations>]: la clause annotations spécifie un ensemble d’étiquettes d’information qui peuvent être utilisées pour stocker des informations supplémentaires plus longues, telles que des descriptions d’alerte ou des liens de runbook. Les valeurs d’annotation peuvent être modèleées.
    • [(Any) <String>]: cela indique que n’importe quelle propriété peut être ajoutée à cet objet.
  • [Enabled <Boolean?>]: Activer/désactiver la règle.
  • [For <TimeSpan?>]: la durée d’alerte doit être active avant le déclenchement.
  • [Label <IPrometheusRuleLabels>]: étiquettes à ajouter ou remplacer avant de stocker le résultat.
    • [(Any) <String>]: cela indique que n’importe quelle propriété peut être ajoutée à cet objet.
  • [Record <String>]: nom des métriques enregistrées.
  • [ResolveConfigurationAutoResolved <Boolean?>]: activez la résolution automatique des alertes.
  • [ResolveConfigurationTimeToResolve <TimeSpan?>]: délai d’expiration de résolution automatique des alertes.
  • [Severity <Int32?>]: gravité des alertes déclenchées par la règle. Doit être compris entre 0 et 4.