Microsoft.Insights scheduledQueryRules 2020-05-01-preview

Artigo
09/21/2023

Definição de recurso do Bicep

O tipo de recurso scheduledQueryRules pode ser implementado com operações que visam:

Grupos de recursos – veja os comandos de implementação do grupo de recursos

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

Observações

Para obter orientações sobre como implementar soluções de monitorização, veja Criar recursos de monitorização com o Bicep.

Formato do recurso

Para criar um recurso Microsoft.Insights/scheduledQueryRules, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.Insights/scheduledQueryRules@2020-05-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    actions: [
      {
        actionGroupId: 'string'
        webHookProperties: {}
      }
    ]
    criteria: {
      allOf: [
        {
          dimensions: [
            {
              name: 'string'
              operator: 'string'
              values: [
                'string'
              ]
            }
          ]
          failingPeriods: {
            minFailingPeriodsToAlert: int
            numberOfEvaluationPeriods: int
          }
          metricMeasureColumn: 'string'
          operator: 'string'
          query: 'string'
          resourceIdColumn: 'string'
          threshold: int
          timeAggregation: 'string'
        }
      ]
    }
    description: 'string'
    displayName: 'string'
    enabled: bool
    evaluationFrequency: 'string'
    muteActionsDuration: 'string'
    overrideQueryTimeRange: 'string'
    scopes: [
      'string'
    ]
    severity: int
    targetResourceTypes: [
      'string'
    ]
    windowSize: 'string'
  }
}

Valores de propriedade

scheduledQueryRules

Nome	Descrição	Valor
name	O nome do recurso	cadeia (obrigatório) Limite de carateres: 1-260 Carateres válidos: Não é possível utilizar: `*<>%{}&:\\?/#` ou controlar carateres Não é possível terminar com espaço ou ponto final.
localização	A localização geográfica onde reside o recurso	cadeia (obrigatório)
etiquetas	Etiquetas de recursos.	Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
propriedades	As propriedades da regra do recurso.	ScheduledQueryRuleProperties (obrigatório)

ScheduledQueryRuleProperties

Nome	Descrição	Valor
ações		Ação[]
critérios	Os critérios de regra que definem as condições da regra de consulta agendada.	ScheduledQueryRuleCriteria
descrição	A descrição da regra de consulta agendada.	string
displayName	O nome a apresentar da regra de alerta	string
ativado	O sinalizador que indica se esta regra de consulta agendada está ativada. O valor deve ser verdadeiro ou falso	bool
evaluationFrequency	Com que frequência a regra de consulta agendada é avaliada representada no formato de duração ISO 8601.	string
muteActionsDuration	Desativar o som das ações para o período de tempo escolhido (no formato de duração ISO 8601) após o alerta ser acionado.	string
overrideQueryTimeRange	Se for especificado, substitui o intervalo de tempo da consulta (a predefinição é WindowSize*NumberOfEvaluationPeriods)	string
âmbitos	A lista de IDs de recursos para a qual esta regra de consulta agendada está confinada.	string[]
gravidade	Gravidade do alerta. Deve ser um número inteiro entre [0-4]. O valor de 0 é mais grave	int
targetResourceTypes	Lista do tipo de recurso dos recursos de destino nos quais o alerta é criado/atualizado. Por exemplo, se o âmbito for um grupo de recursos e targetResourceTypes for Microsoft.Compute/virtualMachines, será acionado um alerta diferente para cada máquina virtual no grupo de recursos que cumpra os critérios de alerta	string[]
windowSize	O período de tempo (no formato de duração ISO 8601) no qual a consulta Alerta será executada (tamanho da discretização).	string

Ação

Nome	Descrição	Valor
actionGroupId	ID de recurso do Grupo de Ações a invocar quando o alerta é acionado.	string
webHookProperties	As propriedades de um objeto webhook.	objeto

ScheduledQueryRuleCriteria

Nome	Descrição	Valor
allOf	Uma lista de condições a avaliar relativamente aos âmbitos especificados	Condição[]

Condição

Nome	Descrição	Valor
dimensões	Lista de condições de Dimensões	Dimensão[]
failingPeriods	O número mínimo de violações necessárias na janela de tempo de pesquisa selecionada necessária para emitir um alerta.	ConditionFailingPeriods
metricMeasureColumn	A coluna que contém o número da medida de métrica.	string
operador	O operador de critérios.	'Igual' 'GreaterThan' "GreaterThanOrEqual" 'LessThan' "LessThanOrEqual" (obrigatório)
query	Alerta de consulta de registo	string
resourceIdColumn	A coluna que contém o ID do recurso. O conteúdo da coluna tem de ser um uri formatado como id de recurso	string
limiar	o valor do limiar de critérios que ativa o alerta.	int (obrigatório)
timeAggregation	Tipo de agregação	"Média" "Contagem" "Máximo" "Mínimo" "Total" (obrigatório)

Dimensão

Nome	Descrição	Valor
name	Nome da dimensão	cadeia (obrigatório)
operador	Operador para valores de dimensão	"Excluir" "Incluir" (obrigatório)
values	Lista de valores de dimensão	string[] (obrigatório)

ConditionFailingPeriods

Nome	Descrição	Valor
minFailingPeriodsToAlert	O número de violações para acionar um alerta. Deve ser menor ou igual a numberOfEvaluationPeriods. O valor predefinido é 1	int
numberOfEvaluationPeriods	O número de pontos de referência agregados. A janela de tempo de pesquisa é calculada com base na granularidade da agregação (windowSize) e no número selecionado de pontos agregados. O valor predefinido é 1	int

Definição de recurso de modelo do ARM

O tipo de recurso scheduledQueryRules pode ser implementado com operações que visam:

Grupos de recursos – veja comandos de implementação de grupos de recursos

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

Observações

Para obter orientações sobre como implementar soluções de monitorização, veja Criar recursos de monitorização com o Bicep.

Formato do recurso

Para criar um recurso Microsoft.Insights/scheduledQueryRules, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.Insights/scheduledQueryRules",
  "apiVersion": "2020-05-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "actions": [
      {
        "actionGroupId": "string",
        "webHookProperties": {}
      }
    ],
    "criteria": {
      "allOf": [
        {
          "dimensions": [
            {
              "name": "string",
              "operator": "string",
              "values": [ "string" ]
            }
          ],
          "failingPeriods": {
            "minFailingPeriodsToAlert": "int",
            "numberOfEvaluationPeriods": "int"
          },
          "metricMeasureColumn": "string",
          "operator": "string",
          "query": "string",
          "resourceIdColumn": "string",
          "threshold": "int",
          "timeAggregation": "string"
        }
      ]
    },
    "description": "string",
    "displayName": "string",
    "enabled": "bool",
    "evaluationFrequency": "string",
    "muteActionsDuration": "string",
    "overrideQueryTimeRange": "string",
    "scopes": [ "string" ],
    "severity": "int",
    "targetResourceTypes": [ "string" ],
    "windowSize": "string"
  }
}

Valores de propriedade

scheduledQueryRules

Nome	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.Insights/scheduledQueryRules"
apiVersion	A versão da API de recursos	"2020-05-01-preview"
name	O nome do recurso	cadeia (obrigatório) Limite de carateres: 1-260 Carateres válidos: Não é possível utilizar: `*<>%{}&:\\?/#` ou controlar carateres Não é possível terminar com espaço ou ponto final.
localização	A localização geográfica onde o recurso se encontra	cadeia (obrigatório)
etiquetas	Etiquetas de recursos.	Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
propriedades	As propriedades da regra do recurso.	ScheduledQueryRuleProperties (obrigatório)

ScheduledQueryRuleProperties

Nome	Descrição	Valor
ações		Ação[]
critérios	Os critérios de regra que definem as condições da regra de consulta agendada.	ScheduledQueryRuleCriteria
descrição	A descrição da regra de consulta agendada.	string
displayName	O nome a apresentar da regra de alerta	string
ativado	O sinalizador que indica se esta regra de consulta agendada está ativada. O valor deve ser verdadeiro ou falso	bool
evaluationFrequency	Com que frequência a regra de consulta agendada é avaliada representada no formato de duração ISO 8601.	string
muteActionsDuration	Desativar o som das ações para o período de tempo escolhido (no formato de duração ISO 8601) após o alerta ser acionado.	string
overrideQueryTimeRange	Se especificado, substitui o intervalo de tempo da consulta (a predefinição é WindowSize*NumberOfEvaluationPeriods)	string
âmbitos	A lista de IDs de recursos a que esta regra de consulta agendada está no âmbito.	cadeia[]
gravidade	Gravidade do alerta. Deve ser um número inteiro entre [0-4]. O valor de 0 é mais grave	int
targetResourceTypes	Lista do tipo de recurso dos recursos de destino nos quais o alerta é criado/atualizado. Por exemplo, se o âmbito for um grupo de recursos e targetResourceTypes for Microsoft.Compute/virtualMachines, será acionado um alerta diferente para cada máquina virtual no grupo de recursos que cumpra os critérios de alerta	cadeia[]
windowsSize	O período de tempo (no formato de duração ISO 8601) no qual a consulta Alerta será executada (tamanho da caixa).	string

Ação

Nome	Descrição	Valor
actionGroupId	ID de recurso do Grupo de Ações para invocar quando o alerta é acionado.	string
webHookProperties	As propriedades de um objeto webhook.	objeto

ScheduledQueryRuleCriteria

Nome	Descrição	Valor
allOf	Uma lista de condições a avaliar relativamente aos âmbitos especificados	Condição[]

Condição

Nome	Descrição	Valor
dimensões	Lista de condições de Dimensões	Dimensão[]
failingPeriods	O número mínimo de violações necessárias na janela de tempo de pesquisa selecionada necessária para emitir um alerta.	ConditionFailingPeriods
metricMeasureColumn	A coluna que contém o número da medida de métrica.	string
operador	O operador de critérios.	'Igual' 'GreaterThan' "GreaterThanOrEqual" 'LessThan' "LessThanOrEqual" (obrigatório)
query	Alerta de consulta de registo	string
resourceIdColumn	A coluna que contém o ID do recurso. O conteúdo da coluna tem de ser um uri formatado como id de recurso	string
limiar	o valor do limiar de critérios que ativa o alerta.	int (obrigatório)
timeAggregation	Tipo de agregação	"Média" "Contagem" "Máximo" "Mínimo" "Total" (obrigatório)

Dimensão

Nome	Descrição	Valor
name	Nome da dimensão	cadeia (obrigatório)
operador	Operador para valores de dimensão	"Excluir" "Incluir" (obrigatório)
values	Lista de valores de dimensão	string[] (obrigatório)

ConditionFailingPeriods

Nome	Descrição	Valor
minFailingPeriodsToAlert	O número de violações para acionar um alerta. Deve ser menor ou igual a numberOfEvaluationPeriods. O valor predefinido é 1	int
numberOfEvaluationPeriods	O número de pontos de referência agregados. A janela de tempo de pesquisa é calculada com base na granularidade da agregação (windowSize) e no número selecionado de pontos agregados. O valor predefinido é 1	int

Definição de recurso do Terraform (fornecedor AzAPI)

O tipo de recurso scheduledQueryRules pode ser implementado com operações que visam:

Grupos de recursos

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

Formato do recurso

Para criar um recurso Microsoft.Insights/scheduledQueryRules, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/scheduledQueryRules@2020-05-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      actions = [
        {
          actionGroupId = "string"
          webHookProperties = {}
        }
      ]
      criteria = {
        allOf = [
          {
            dimensions = [
              {
                name = "string"
                operator = "string"
                values = [
                  "string"
                ]
              }
            ]
            failingPeriods = {
              minFailingPeriodsToAlert = int
              numberOfEvaluationPeriods = int
            }
            metricMeasureColumn = "string"
            operator = "string"
            query = "string"
            resourceIdColumn = "string"
            threshold = int
            timeAggregation = "string"
          }
        ]
      }
      description = "string"
      displayName = "string"
      enabled = bool
      evaluationFrequency = "string"
      muteActionsDuration = "string"
      overrideQueryTimeRange = "string"
      scopes = [
        "string"
      ]
      severity = int
      targetResourceTypes = [
        "string"
      ]
      windowSize = "string"
    }
  })
}

Valores de propriedade

scheduledQueryRules

Nome	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.Insights/scheduledQueryRules@2020-05-01-preview"
name	O nome do recurso	cadeia (obrigatório) Limite de carateres: 1-260 Carateres válidos: Não é possível utilizar: `*<>%{}&:\\?/#` ou controlar carateres Não é possível terminar com espaço ou ponto final.
localização	A localização geográfica onde o recurso se encontra	cadeia (obrigatório)
parent_id	Para implementar num grupo de recursos, utilize o ID desse grupo de recursos.	cadeia (obrigatório)
etiquetas	Etiquetas de recursos.	Dicionário de nomes e valores de etiquetas.
propriedades	As propriedades da regra do recurso.	ScheduledQueryRuleProperties (obrigatório)

ScheduledQueryRuleProperties

Nome	Descrição	Valor
ações		Ação[]
critérios	Os critérios de regra que definem as condições da regra de consulta agendada.	ScheduledQueryRuleCriteria
descrição	A descrição da regra de consulta agendada.	string
displayName	O nome a apresentar da regra de alerta	string
ativado	O sinalizador que indica se esta regra de consulta agendada está ativada. O valor deve ser verdadeiro ou falso	bool
evaluationFrequency	Com que frequência a regra de consulta agendada é avaliada representada no formato de duração ISO 8601.	string
muteActionsDuration	Desativar o som das ações para o período de tempo escolhido (no formato de duração ISO 8601) após o alerta ser acionado.	string
overrideQueryTimeRange	Se especificado, substitui o intervalo de tempo da consulta (a predefinição é WindowSize*NumberOfEvaluationPeriods)	string
âmbitos	A lista de IDs de recursos a que esta regra de consulta agendada está no âmbito.	cadeia[]
gravidade	Gravidade do alerta. Deve ser um número inteiro entre [0-4]. O valor de 0 é mais grave	int
targetResourceTypes	Lista do tipo de recurso dos recursos de destino nos quais o alerta é criado/atualizado. Por exemplo, se o âmbito for um grupo de recursos e targetResourceTypes for Microsoft.Compute/virtualMachines, será acionado um alerta diferente para cada máquina virtual no grupo de recursos que cumpra os critérios de alerta	cadeia[]
windowsSize	O período de tempo (no formato de duração ISO 8601) no qual a consulta Alerta será executada (tamanho da caixa).	string

Ação

Nome	Descrição	Valor
actionGroupId	ID de recurso do Grupo de Ações para invocar quando o alerta é acionado.	string
webHookProperties	As propriedades de um objeto webhook.	objeto

ScheduledQueryRuleCriteria

Nome	Descrição	Valor
allOf	Uma lista de condições a avaliar relativamente aos âmbitos especificados	Condição[]

Condição

Nome	Descrição	Valor
dimensões	Lista de condições de Dimensões	Dimensão[]
failingPeriods	O número mínimo de violações necessárias na janela de tempo de pesquisa selecionada necessária para emitir um alerta.	ConditionFailingPeriods
metricMeasureColumn	A coluna que contém o número da medida de métrica.	string
operador	O operador de critérios.	"Igual a" "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" (obrigatório)
query	Alerta de consulta de registo	string
resourceIdColumn	A coluna que contém o ID do recurso. O conteúdo da coluna tem de ser um uri formatado como id de recurso	string
limiar	o valor do limiar de critérios que ativa o alerta.	int (obrigatório)
timeAggregation	Tipo de agregação	"Média" "Contagem" "Máximo" "Mínimo" "Total" (obrigatório)

Dimensão

Nome	Descrição	Valor
name	Nome da dimensão	cadeia (obrigatório)
operador	Operador para valores de dimensão	"Excluir" "Incluir" (obrigatório)
values	Lista de valores de dimensão	string[] (obrigatório)

ConditionFailingPeriods

Nome	Descrição	Valor
minFailingPeriodsToAlert	O número de violações para acionar um alerta. Deve ser menor ou igual a numberOfEvaluationPeriods. O valor predefinido é 1	int
numberOfEvaluationPeriods	O número de pontos de referência agregados. A janela de tempo de pesquisa é calculada com base na granularidade da agregação (windowSize) e no número selecionado de pontos agregados. O valor predefinido é 1	int

Partilhar via

Microsoft.Insights scheduledQueryRules 2020-05-01-preview

Definição de recurso do Bicep

Observações

Formato do recurso

Valores de propriedade

scheduledQueryRules

ScheduledQueryRuleProperties

Ação

ScheduledQueryRuleCriteria

Condição

Dimensão

ConditionFailingPeriods

Definição de recurso de modelo do ARM

Observações

Formato do recurso

Valores de propriedade

scheduledQueryRules

ScheduledQueryRuleProperties

Ação

ScheduledQueryRuleCriteria

Condição

Dimensão

ConditionFailingPeriods

Definição de recurso do Terraform (fornecedor AzAPI)

Formato do recurso

Valores de propriedade

scheduledQueryRules

ScheduledQueryRuleProperties

Ação

ScheduledQueryRuleCriteria

Condição

Dimensão

ConditionFailingPeriods

Comentários

Comentários

Recursos adicionais