New-AzPrometheusRuleGroup

  • Ссылка
Модуль:
Az.AlertsManagement

Создайте или обновите определение группы правил Prometheus.

Синтаксис

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>]

Описание

Создайте или обновите определение группы правил Prometheus.

Примеры

Пример 1. Создание определения группы правил Prometheus с одним правилом.

$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

Создайте определение группы правил Prometheus с одним правилом.

Пример 2. Создание определения группы правил Prometheus с правилами.

$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

Создание определения группы правил Prometheus с помощью правил.

Параметры

-ClusterName

Применение правила к данным из определенного кластера.

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

-Confirm

Запрос подтверждения перед выполнением командлета.

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

-DefaultProfile

Параметр DefaultProfile не работает. Используйте параметр SubscriptionId, если он доступен при выполнении командлета в другой подписке.

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

-Description

Описание группы правил.

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

-Enabled

Включение и отключение группы правил.

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

-Interval

Интервал, в котором выполняется группа правил Prometheus, представленная в формате длительности ISO 8601. Должно быть от 1 до 15 минут

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

-Location

Географическое расположение, в котором находится ресурс

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

-ResourceGroupName

Имя группы ресурсов. Имя не учитывает регистр.

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

-Rule

Определяет правила в группе правил Prometheus. Сведения о создании см. в разделе NOTES для свойств RULE и создании хэш-таблицы.

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

-RuleGroupName

Имя группы правил.

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

-Scope

Целевые идентификаторы ресурсов рабочих областей Azure Monitor. Эта версия API в настоящее время ограничена созданием с помощью одной область. Это может измениться в будущем.

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

-SubscriptionId

Идентификатор целевой подписки.

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

-Tag

Теги ресурсов.

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

-WhatIf

Показывает, что произойдет при запуске командлета. Командлет не выполняется.

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

Выходные данные

IPrometheusRuleGroupResource

Примечания

ПСЕВДОНИМЫ

СЛОЖНЫЕ СВОЙСТВА ПАРАМЕТРОВ

Чтобы создать параметры, описанные ниже, создайте хэш-таблицу, содержащую соответствующие свойства. Сведения о хэш-таблицах выполните about_Hash_Tables get-Help.

RULE <IPrometheusRule[]>: определяет правила в группе правил Prometheus.

  • Expression <String>: выражение PromQL для вычисления. https://prometheus.io/docs/prometheus/latest/querying/basics/. Вычисляется периодически по "интервалу", а результат, записанный в виде нового набора временных рядов с именем метрик, заданным записью.
  • [Action <IPrometheusRuleGroupAction[]>]: действия, выполняемые при активации правила генерации оповещений, и при разрешении условия генерации оповещений.
    • [ActionGroupId <String>]: идентификатор ресурса группы действий, используемой.
    • [ActionProperty <IPrometheusRuleGroupActionProperties>]: свойства объекта группы действий.
      • [(Any) <String>]: это означает, что любое свойство можно добавить в этот объект.
  • [Alert <String>]: имя правила генерации оповещений.
  • [Annotation <IPrometheusRuleAnnotations>]: предложение примечаний указывает набор информационных меток, которые можно использовать для хранения более длинных дополнительных сведений, таких как описания оповещений или ссылки runbook. Значения заметок можно шаблонировать.
    • [(Any) <String>]: это означает, что любое свойство можно добавить в этот объект.
  • [Enabled <Boolean?>]: включение и отключение правила.
  • [For <TimeSpan?>]: перед запуском должно быть активное оповещение времени.
  • [Label <IPrometheusRuleLabels>]: метки для добавления или перезаписи перед сохранением результата.
    • [(Any) <String>]: это означает, что любое свойство можно добавить в этот объект.
  • [Record <String>]: записанное имя метрик.
  • [ResolveConfigurationAutoResolved <Boolean?>]: включение автоматического разрешения оповещений.
  • [ResolveConfigurationTimeToResolve <TimeSpan?>]: время ожидания автоматического разрешения оповещений.
  • [Severity <Int32?>]: серьезность оповещений, запущенных правилом. Должно быть от 0 до 4.