Compartilhar via

Add-AzMetricAlertRule

  • Referência
Módulo:
Az.Monitor

Adiciona ou atualiza uma regra de alerta claasic baseada em métrica (já desativada na nuvem pública). Para criar uma nova regra de alerta de métrica, use o cmdlet Add-AzMetricAlertRuleV2.

Sintaxe

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

O cmdlet Add-AzMetricAlertRule adiciona ou atualiza uma regra de alerta baseada em métrica. A regra adicionada está associada a um grupo de recursos e tem um nome. Esse cmdlet implementa o padrão ShouldProcess, ou seja, ele pode solicitar confirmação do usuário antes de realmente criar, modificar ou remover o recurso.

Exemplos

Exemplo 1: adicionar uma regra de alerta de métrica a um site

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

Esse comando cria uma regra de alerta de métrica para um site.

Exemplo 2: Desabilitar uma regra

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

Esse comando desabilita uma regra. Se a regra não existir, ela a criará desabilitada. Se a regra existir, ela apenas a desabilita.

Exemplo 3: Adicionar uma regra com ações

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

Esse comando cria uma regra de alerta de métrica para um site.

Parâmetros

-Action

Especifica uma lista separada por vírgulas de ações.

Tipo:List<T>[RuleAction]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Confirm

Solicita a confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o azure

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Description

Especifica uma descrição da regra.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-DisableRule

Desabilita a regra. Se você não especificar esse parâmetro, a regra será habilitada.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Location

Especifica o local onde a regra é definida.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-MetricName

Especifica o nome da métrica que a regra está monitorando. Especifique esse parâmetro apenas para regras baseadas em métrica.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Name

Especifica o nome da regra.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Operator

Especifica o operador relacional para a condição da regra. Os valores aceitáveis para este parâmetro são:

  • GreaterThan
  • GreaterThanOrEqual
  • LessThan
  • LessThanOrEqual
Tipo:ConditionOperator
Valores aceitos:GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ResourceGroupName

Especifica o nome do grupo de recursos para a regra.

Tipo:String
Aliases:ResourceGroup
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-TargetResourceId

Especifica a ID do recurso que a regra está monitorando. OBSERVAÇÃO: essa propriedade não pode ser atualizada para uma regra de alerta existente.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Threshold

Especifica o limite da regra.

Tipo:Double
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-TimeAggregationOperator

Especifica o operador de agregação a ser aplicado à janela de tempo quando a regra está sendo avaliada.

Tipo:Nullable<T>[TimeAggregationOperator]
Valores aceitos:Average, Minimum, Maximum, Total, Last
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-WindowSize

Especifica o tamanho da janela de tempo para a regra computar seus dados.

Tipo:TimeSpan
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

Entradas

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

Saídas

PSAddAlertRuleOperationResponse