Microsoft.Insights metricAlerts 2018-03-01

Artigo
12/16/2024

Observações

Para obter diretrizes sobre como implantar soluções de monitoramento, consulte Criar recursos de monitoramento usando o Bicep.

Definição de recurso do Bicep

O tipo de recurso metricAlerts pode ser implantado com operações de destino:

Grupos de recursos - Consulte comandos de implantação do grupo de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Insights/metricAlerts, adicione o Bicep a seguir ao seu modelo.

resource symbolicname 'Microsoft.Insights/metricAlerts@2018-03-01' = {
  location: 'string'
  name: 'string'
  properties: {
    actions: [
      {
        actionGroupId: 'string'
        webHookProperties: {
          {customized property}: 'string'
        }
      }
    ]
    autoMitigate: bool
    criteria: {
      odata.type: 'string'
      // For remaining properties, see MetricAlertCriteria objects
    }
    description: 'string'
    enabled: bool
    evaluationFrequency: 'string'
    scopes: [
      'string'
    ]
    severity: int
    targetResourceRegion: 'string'
    targetResourceType: 'string'
    windowSize: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Objetos MetricAlertCriteria

Defina a propriedade odata.type para especificar o tipo de objeto.

Para Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria, use:

{
  allOf: [
    {
      dimensions: [
        {
          name: 'string'
          operator: 'string'
          values: [
            'string'
          ]
        }
      ]
      metricName: 'string'
      metricNamespace: 'string'
      name: 'string'
      skipMetricValidation: bool
      timeAggregation: 'string'
      criterionType: 'string'
      // For remaining properties, see MultiMetricCriteria objects
    }
  ]
  odata.type: 'Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria'
}

Para Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria, use:

{
  allOf: [
    {
      criterionType: 'string'
      dimensions: [
        {
          name: 'string'
          operator: 'string'
          values: [
            'string'
          ]
        }
      ]
      metricName: 'string'
      metricNamespace: 'string'
      name: 'string'
      operator: 'string'
      skipMetricValidation: bool
      threshold: int
      timeAggregation: 'string'
    }
  ]
  odata.type: 'Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria'
}

Para Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria, use:

{
  componentId: 'string'
  failedLocationCount: int
  odata.type: 'Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria'
  webTestId: 'string'
}

Objetos MultiMetricCriteria

Defina a propriedade criterionType para especificar o tipo de objeto.

Para DynamicThresholdCriterion, use:

{
  alertSensitivity: 'string'
  criterionType: 'DynamicThresholdCriterion'
  failingPeriods: {
    minFailingPeriodsToAlert: int
    numberOfEvaluationPeriods: int
  }
  ignoreDataBefore: 'string'
  operator: 'string'
}

Para StaticThresholdCriterion, use:

{
  criterionType: 'StaticThresholdCriterion'
  operator: 'string'
  threshold: int
}

Valores de propriedade

DynamicMetricCriteria

Nome	Descrição	Valor
alertSensitivity	A extensão do desvio necessária para disparar um alerta. Isso afetará o quão apertado é o limite para o padrão da série de métricas.	'Alto' 'Baixo' 'Medium' (obrigatório)
criterionType	Especifica o tipo de critério de limite	'DynamicThresholdCriterion' (obrigatório)
failPeriods	O número mínimo de violações necessárias na janela de tempo de pesquisa selecionada necessária para gerar um alerta.	DynamicThresholdFailingPeriods (obrigatório)
ignoreDataBefore	Use essa opção para definir a data da qual começar a aprender os dados históricos da métrica e calcular os limites dinâmicos (no formato ISO8601)	corda
operador	O operador usado para comparar o valor da métrica com o limite.	'GreaterOrLessThan' 'GreaterThan' 'LessThan' (obrigatório)

DynamicThresholdFailingPeriods

Nome	Descrição	Valor
minFailingPeriodsToAlert	O número de violações para disparar um alerta. Deve ser menor ou igual a numberOfEvaluationPeriods.	int (obrigatório)
numberOfEvaluationPeriods	O número de pontos de pesquisa agregados. A janela de tempo de pesquisa é calculada com base na granularidade de agregação (windowSize) e no número selecionado de pontos agregados.	int (obrigatório)

MetricAlertAction

Nome	Descrição	Valor
actionGroupId	a ID do grupo de ações a ser usado.	corda
WebHookProperties	Esse campo permite especificar propriedades personalizadas, que seriam acrescentadas ao conteúdo do alerta enviado como entrada para o webhook.	MetricAlertActionWebHookProperties

MetricAlertActionWebHookProperties

Nome	Descrição	Valor

MetricAlertCriteria

Nome	Descrição	Valor
odata.type	Defina como 'Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria' para o tipo MetricAlertMultipleResourceMultipleMetricCriteria. Defina como 'Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria' para o tipo MetricAlertSingleResourceMultipleMetricCriteria. Defina como 'Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria' para o tipo WebtestLocationAvailabilityCriteria.	'Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria' 'Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria' 'Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria' (obrigatório)

MetricAlertMultipleResourceMultipleMetricCriteria

Nome	Descrição	Valor
allOf	a lista de vários critérios de métrica para essa operação "tudo".	MultiMetricCriteria []
odata.type	especifica o tipo dos critérios de alerta.	'Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria' (obrigatório)

MetricAlertProperties

Nome	Descrição	Valor
Ações	a matriz de ações executadas quando a regra de alerta se torna ativa e quando uma condição de alerta é resolvida.	MetricAlertAction []
autoMitigate	o sinalizador que indica se o alerta deve ser resolvido automaticamente ou não. O padrão é verdadeiro.	Bool
Critérios	define as informações específicas de critérios de alerta.	MetricAlertCriteria (obrigatório)
descrição	a descrição do alerta de métrica que será incluído no email de alerta.	corda
Habilitado	o sinalizador que indica se o alerta de métrica está habilitado.	bool (obrigatório)
evaluationFrequency	com que frequência o alerta de métrica é avaliado representado no formato de duração ISO 8601.	cadeia de caracteres (obrigatório)
Escopos	a lista de IDs de recurso à qual esse alerta de métrica está no escopo.	string[] (obrigatório)
severidade	Gravidade do alerta {0, 1, 2, 3, 4}	int (obrigatório)
targetResourceRegion	a região dos recursos de destino em que o alerta é criado/atualizado. Obrigatório se o escopo contiver uma assinatura, um grupo de recursos ou mais de um recurso.	corda
targetResourceType	o tipo de recurso dos recursos de destino nos quais o alerta é criado/atualizado. Obrigatório se o escopo contiver uma assinatura, um grupo de recursos ou mais de um recurso.	corda
windowSize	o período de tempo (no formato de duração ISO 8601) usado para monitorar a atividade de alerta com base no limite.	cadeia de caracteres (obrigatório)

MetricAlertSingleResourceMultipleMetricCriteria

Nome	Descrição	Valor
allOf	A lista de critérios de métrica para esta operação "tudo".	MetricCriteria[]
odata.type	especifica o tipo dos critérios de alerta.	'Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria' (obrigatório)

MetricCriteria

Nome	Descrição	Valor
criterionType	Especifica o tipo de critério de limite	'DynamicThresholdCriterion' 'StaticThresholdCriterion' (obrigatório)
Dimensões	Lista de condições de dimensão.	MetricDimension []
metricName	Nome da métrica.	cadeia de caracteres (obrigatório)
metricNamespace	Namespace da métrica.	corda
nome	Nome dos critérios.	cadeia de caracteres (obrigatório)
operador	o operador de critérios.	'Equals' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' (obrigatório)
skipMetricValidation	Permite a criação de uma regra de alerta em uma métrica personalizada que ainda não foi emitida, fazendo com que a validação da métrica seja ignorada.	Bool
limiar	o valor do limite de critérios que ativa o alerta.	int (obrigatório)
timeAggregation	os tipos de agregação de tempo de critérios.	'Média' 'Count' 'Máximo' 'Mínimo' 'Total' (obrigatório)

MetricCriteria

Nome	Descrição	Valor
criterionType	Especifica o tipo de critério de limite	'StaticThresholdCriterion' (obrigatório)
operador	o operador de critérios.	'Equals' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' (obrigatório)
limiar	o valor do limite de critérios que ativa o alerta.	int (obrigatório)

MetricDimension

Nome	Descrição	Valor
nome	Nome da dimensão.	cadeia de caracteres (obrigatório)
operador	o operador de dimensão. Há suporte apenas para 'Incluir' e 'Excluir'	cadeia de caracteres (obrigatório)
Valores	lista de valores de dimensão.	string[] (obrigatório)