Microsoft.Insights scheduledQueryRules 2020-05-01-preview

Artigo
12/21/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 scheduledQueryRules 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/scheduledQueryRules, adicione o Bicep a seguir ao modelo.

resource symbolicname 'Microsoft.Insights/scheduledQueryRules@2020-05-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    actions: [
      {
        actionGroupId: 'string'
        webHookProperties: {
          {customized property}: 'string'
        }
      }
    ]
    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'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

Ação

Nome	Descrição	Valor
actionGroupId	ID de recurso do Grupo de Ações a ser invocada quando o alerta é acionado.	corda
WebHookProperties	As propriedades de um objeto webhook.	ActionWebHookProperties

ActionWebHookProperties

Nome	Descrição	Valor

Condição

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

ConditionFailingPeriods

Nome	Descrição	Valor
minFailingPeriodsToAlert	O número de violações para disparar um alerta. Deve ser menor ou igual a numberOfEvaluationPeriods. O valor padrão é 1	int
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. O valor padrão é 1	int

Dimensão

Nome	Descrição	Valor
nome	Nome da dimensão	cadeia de caracteres (obrigatório)
operador	Operador para valores de dimensão	'Excluir' 'Include' (obrigatório)
Valores	Lista de valores de dimensão	string[] (obrigatório)

Microsoft.Insights/scheduledQueryRules

Nome	Descrição	Valor
localização	A localização geográfica onde o recurso reside	cadeia de caracteres (obrigatório)
nome	O nome do recurso	corda Restrições: Padrão = `^[^#<>%&:\?/{}*]{1,260}$` (obrigatório)
Propriedades	As propriedades da regra do recurso.	ScheduledQueryRuleProperties (obrigatório)
Tags	Marcas de recurso	Dicionário de nomes e valores de marca. Consulte Marcas em modelos

ScheduledQueryRuleCriteria

Nome	Descrição	Valor
allOf	Uma lista de condições a serem avaliadas em relação aos escopos especificados	de Condição []

ScheduledQueryRuleProperties

Nome	Descrição	Valor
Ações		action[]
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.	corda
displayName	O nome de exibição da regra de alerta	corda
Habilitado	O sinalizador que indica se essa regra de consulta agendada está habilitada. 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.	corda
muteActionsDuration	Ações de mudo para o período de tempo escolhido (no formato de duração ISO 8601) depois que o alerta é acionado.	corda
overrideQueryTimeRange	Se especificado, substitui o intervalo de tempo da consulta (o padrão é WindowSize*NumberOfEvaluationPeriods)	corda
Escopos	A lista de IDs de recurso à qual essa regra de consulta agendada está no escopo.	string[]
severidade	Gravidade do alerta. Deve ser um inteiro entre [0-4]. O valor de 0 é mais severo	int
targetResourceTypes	Lista do tipo de recurso dos recursos de destino nos quais o alerta é criado/atualizado. Por exemplo, se o escopo for um grupo de recursos e targetResourceTypes for Microsoft.Compute/virtualMachines, um alerta diferente será disparado para cada máquina virtual no grupo de recursos que atenda aos 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 lixeira).	corda

TrackedResourceTags

Nome	Descrição	Valor

Definição de recurso de modelo do ARM

O tipo de recurso scheduledQueryRules 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/scheduledQueryRules, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.Insights/scheduledQueryRules",
  "apiVersion": "2020-05-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "actions": [
      {
        "actionGroupId": "string",
        "webHookProperties": {
          "{customized property}": "string"
        }
      }
    ],
    "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"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

Ação

Nome	Descrição	Valor
actionGroupId	ID de recurso do Grupo de Ações a ser invocada quando o alerta é acionado.	corda
WebHookProperties	As propriedades de um objeto webhook.	ActionWebHookProperties

ActionWebHookProperties

Nome	Descrição	Valor

Condição

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

ConditionFailingPeriods

Nome	Descrição	Valor
minFailingPeriodsToAlert	O número de violações para disparar um alerta. Deve ser menor ou igual a numberOfEvaluationPeriods. O valor padrão é 1	int
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. O valor padrão é 1	int

Dimensão

Nome	Descrição	Valor
nome	Nome da dimensão	cadeia de caracteres (obrigatório)
operador	Operador para valores de dimensão	'Excluir' 'Include' (obrigatório)
Valores	Lista de valores de dimensão	string[] (obrigatório)

Microsoft.Insights/scheduledQueryRules

Nome	Descrição	Valor
apiVersion	A versão da API	'2020-05-01-preview'
localização	A localização geográfica onde o recurso reside	cadeia de caracteres (obrigatório)
nome	O nome do recurso	corda Restrições: Padrão = `^[^#<>%&:\?/{}*]{1,260}$` (obrigatório)
Propriedades	As propriedades da regra do recurso.	ScheduledQueryRuleProperties (obrigatório)
Tags	Marcas de recurso	Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo	O tipo de recurso	'Microsoft.Insights/scheduledQueryRules'

ScheduledQueryRuleCriteria

Nome	Descrição	Valor
allOf	Uma lista de condições a serem avaliadas em relação aos escopos especificados	de Condição []

ScheduledQueryRuleProperties

Nome	Descrição	Valor
Ações		action[]
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.	corda
displayName	O nome de exibição da regra de alerta	corda
Habilitado	O sinalizador que indica se essa regra de consulta agendada está habilitada. 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.	corda
muteActionsDuration	Ações de mudo para o período de tempo escolhido (no formato de duração ISO 8601) depois que o alerta é acionado.	corda
overrideQueryTimeRange	Se especificado, substitui o intervalo de tempo da consulta (o padrão é WindowSize*NumberOfEvaluationPeriods)	corda
Escopos	A lista de IDs de recurso à qual essa regra de consulta agendada está no escopo.	string[]
severidade	Gravidade do alerta. Deve ser um inteiro entre [0-4]. O valor de 0 é mais severo	int
targetResourceTypes	Lista do tipo de recurso dos recursos de destino nos quais o alerta é criado/atualizado. Por exemplo, se o escopo for um grupo de recursos e targetResourceTypes for Microsoft.Compute/virtualMachines, um alerta diferente será disparado para cada máquina virtual no grupo de recursos que atenda aos 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 lixeira).	corda

TrackedResourceTags

Nome	Descrição	Valor

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo	Descrição
Criar regra de alerta para itens de continuidade de negócios do Azure	Esses modelos criam uma regra de alerta e uma MSI atribuída pelo usuário. Ele também atribui o acesso do leitor MSI à assinatura para que a regra de alerta tenha acesso para consultar os itens protegidos necessários e os detalhes mais recentes do ponto de recuperação.

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

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

grupos 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/scheduledQueryRules, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/scheduledQueryRules@2020-05-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      actions = [
        {
          actionGroupId = "string"
          webHookProperties = {
            {customized property} = "string"
          }
        }
      ]
      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

Ação

Nome	Descrição	Valor
actionGroupId	ID de recurso do Grupo de Ações a ser invocada quando o alerta é acionado.	corda
WebHookProperties	As propriedades de um objeto webhook.	ActionWebHookProperties

ActionWebHookProperties

Nome	Descrição	Valor

Condição

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

ConditionFailingPeriods

Nome	Descrição	Valor
minFailingPeriodsToAlert	O número de violações para disparar um alerta. Deve ser menor ou igual a numberOfEvaluationPeriods. O valor padrão é 1	int
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. O valor padrão é 1	int

Dimensão

Nome	Descrição	Valor
nome	Nome da dimensão	cadeia de caracteres (obrigatório)
operador	Operador para valores de dimensão	'Excluir' 'Include' (obrigatório)
Valores	Lista de valores de dimensão	string[] (obrigatório)

Microsoft.Insights/scheduledQueryRules

Nome	Descrição	Valor
localização	A localização geográfica onde o recurso reside	cadeia de caracteres (obrigatório)
nome	O nome do recurso	corda Restrições: Padrão = `^[^#<>%&:\?/{}*]{1,260}$` (obrigatório)
Propriedades	As propriedades da regra do recurso.	ScheduledQueryRuleProperties (obrigatório)
Tags	Marcas de recurso	Dicionário de nomes e valores de marca.
tipo	O tipo de recurso	"Microsoft.Insights/scheduledQueryRules@2020-05-01-preview"

ScheduledQueryRuleCriteria

Nome	Descrição	Valor
allOf	Uma lista de condições a serem avaliadas em relação aos escopos especificados	de Condição []

ScheduledQueryRuleProperties

Nome	Descrição	Valor
Ações		action[]
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.	corda
displayName	O nome de exibição da regra de alerta	corda
Habilitado	O sinalizador que indica se essa regra de consulta agendada está habilitada. 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.	corda
muteActionsDuration	Ações de mudo para o período de tempo escolhido (no formato de duração ISO 8601) depois que o alerta é acionado.	corda
overrideQueryTimeRange	Se especificado, substitui o intervalo de tempo da consulta (o padrão é WindowSize*NumberOfEvaluationPeriods)	corda
Escopos	A lista de IDs de recurso à qual essa regra de consulta agendada está no escopo.	string[]
severidade	Gravidade do alerta. Deve ser um inteiro entre [0-4]. O valor de 0 é mais severo	int
targetResourceTypes	Lista do tipo de recurso dos recursos de destino nos quais o alerta é criado/atualizado. Por exemplo, se o escopo for um grupo de recursos e targetResourceTypes for Microsoft.Compute/virtualMachines, um alerta diferente será disparado para cada máquina virtual no grupo de recursos que atenda aos 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 lixeira).	corda

TrackedResourceTags

Nome	Descrição	Valor

Compartilhar via

Microsoft.Insights scheduledQueryRules 2020-05-01-preview

Observações

Definição de recurso do Bicep

Formato de recurso

Valores de propriedade

Ação

ActionWebHookProperties

Condição

ConditionFailingPeriods

Dimensão

Microsoft.Insights/scheduledQueryRules

ScheduledQueryRuleCriteria

ScheduledQueryRuleProperties

TrackedResourceTags

Definição de recurso de modelo do ARM

Formato de recurso

Valores de propriedade

Ação

ActionWebHookProperties

Condição

ConditionFailingPeriods

Dimensão

Microsoft.Insights/scheduledQueryRules

ScheduledQueryRuleCriteria

ScheduledQueryRuleProperties

TrackedResourceTags

Modelos de início rápido

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

Formato de recurso

Valores de propriedade

Ação

ActionWebHookProperties

Condição

ConditionFailingPeriods

Dimensão

Microsoft.Insights/scheduledQueryRules

ScheduledQueryRuleCriteria

ScheduledQueryRuleProperties

TrackedResourceTags

Comentários

Recursos adicionais