Partilhar via


Microsoft.Insights scheduledQueryRules 2020-05-01-preview

Comentários

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

Definição de recursos do bíceps

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

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

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' = {
  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

Designação Descrição Valor
açãoGroupId ID do recurso do Grupo de Ações a ser invocado quando o alerta for acionado. string
webHookPropriedades As propriedades de um objeto webhook. ActionWebHookProperties

ActionWebHookProperties

Designação Descrição Valor

Condição

Designação Descrição Valor
Dimensões Condições da lista de dimensões Dimensão[]
failingPeriods O número mínimo de violações necessárias dentro da janela de tempo de retrospetiva selecionada necessária para gerar um alerta. ConditionFailingPeriods
metricMeasureColumn A coluna que contém o número da medida métrica. string
Operador O operador de critérios. 'Iguais'
'MaiorQue'
'MaiorThanOrEqual'
'Menosque'
'LessThanOrEqual' (obrigatório)
consulta Alerta de consulta de log string
resourceIdColumn A coluna que contém a id do recurso. O conteúdo da coluna deve ser um uri formatado como id de recurso string
limiar O valor limite de critérios que ativa o alerta. int (obrigatório)
agregação de tempo Tipo de agregação 'Média'
'Contagem'
'Máximo'
'Mínimo'
'Total' (obrigatório)

CondiçãoFailingPeriods

Designação 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
númeroDeAvaliaçãoPeríodos O número de pontos de retrospetiva agregados. A janela de tempo de retrospetiva é 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

Designação Descrição Valor
Designação Nome da dimensão string (obrigatório)
Operador Operador para valores de dimensão 'Excluir'
'Incluir' (obrigatório)
valores Lista de valores de dimensão string[] (obrigatório)

Microsoft.Insights/scheduledQueryRules

Designação Descrição Valor
Localização A geolocalização onde o recurso vive string (obrigatório)
Designação O nome do recurso string

Restrições:
Padrão = ^[^#<>%&:\?/{}*]{1,260}$ (obrigatório)
propriedades As propriedades da regra do recurso. ScheduledQueryRuleProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos

ScheduledQueryRuleCriteria

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

ScheduledQueryRuleProperties

Designação 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 para exibição da regra de alerta string
ativado O sinalizador que indica se essa regra de consulta agendada está habilitada. O valor deve ser verdadeiro ou falso Bool
avaliaçãoFrequência A frequência com que a regra de consulta agendada é avaliada representada no formato de duração ISO 8601. string
muteActionsDuration Silencie ações pelo período de tempo escolhido (no formato de duração ISO 8601) depois que o alerta for acionado. string
overrideQueryTimeRange Se especificado, substitui o intervalo de tempo de consulta (o padrão é WindowSize*NumberOfEvaluationPeriods) string
Âmbitos de aplicação A lista de ids de recurso para as quais esta regra de consulta agendada tem escopo. string[]
gravidade Severidade do alerta. Deve ser um número inteiro entre [0-4]. O valor de 0 é mais severo Int
targetResourceTypes Lista do tipo de recurso do(s) recurso(s) de destino no qual 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 atender 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 do compartimento). string

TrackedResourceTags

Designação Descrição Valor

Definição de recurso de modelo ARM

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

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

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",
  "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

Designação Descrição Valor
açãoGroupId ID do recurso do Grupo de Ações a ser invocado quando o alerta for acionado. string
webHookPropriedades As propriedades de um objeto webhook. ActionWebHookProperties

ActionWebHookProperties

Designação Descrição Valor

Condição

Designação Descrição Valor
Dimensões Condições da lista de dimensões Dimensão[]
failingPeriods O número mínimo de violações necessárias dentro da janela de tempo de retrospetiva selecionada necessária para gerar um alerta. ConditionFailingPeriods
metricMeasureColumn A coluna que contém o número da medida métrica. string
Operador O operador de critérios. 'Iguais'
'MaiorQue'
'MaiorThanOrEqual'
'Menosque'
'LessThanOrEqual' (obrigatório)
consulta Alerta de consulta de log string
resourceIdColumn A coluna que contém a id do recurso. O conteúdo da coluna deve ser um uri formatado como id de recurso string
limiar O valor limite de critérios que ativa o alerta. int (obrigatório)
agregação de tempo Tipo de agregação 'Média'
'Contagem'
'Máximo'
'Mínimo'
'Total' (obrigatório)

CondiçãoFailingPeriods

Designação 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
númeroDeAvaliaçãoPeríodos O número de pontos de retrospetiva agregados. A janela de tempo de retrospetiva é 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

Designação Descrição Valor
Designação Nome da dimensão string (obrigatório)
Operador Operador para valores de dimensão 'Excluir'
'Incluir' (obrigatório)
valores Lista de valores de dimensão string[] (obrigatório)

Microsoft.Insights/scheduledQueryRules

Designação Descrição Valor
apiVersion A versão api '2020-05-01-pré-visualização'
Localização A geolocalização onde o recurso vive string (obrigatório)
Designação O nome do recurso string

Restrições:
Padrão = ^[^#<>%&:\?/{}*]{1,260}$ (obrigatório)
propriedades As propriedades da regra do recurso. ScheduledQueryRuleProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo O tipo de recurso 'Microsoft.Insights/scheduledQueryRules'

ScheduledQueryRuleCriteria

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

ScheduledQueryRuleProperties

Designação 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 para exibição da regra de alerta string
ativado O sinalizador que indica se essa regra de consulta agendada está habilitada. O valor deve ser verdadeiro ou falso Bool
avaliaçãoFrequência A frequência com que a regra de consulta agendada é avaliada representada no formato de duração ISO 8601. string
muteActionsDuration Silencie ações pelo período de tempo escolhido (no formato de duração ISO 8601) depois que o alerta for acionado. string
overrideQueryTimeRange Se especificado, substitui o intervalo de tempo de consulta (o padrão é WindowSize*NumberOfEvaluationPeriods) string
Âmbitos de aplicação A lista de ids de recurso para as quais esta regra de consulta agendada tem escopo. string[]
gravidade Severidade do alerta. Deve ser um número inteiro entre [0-4]. O valor de 0 é mais severo Int
targetResourceTypes Lista do tipo de recurso do(s) recurso(s) de destino no qual 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 atender 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 do compartimento). string

TrackedResourceTags

Designação 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

Implantar no Azure
Esses modelos criam uma regra de alerta e um MSI atribuído pelo usuário. Ele também atribui ao leitor MSI acesso à 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 recursos Terraform (provedor AzAPI)

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

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log 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"
  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

Designação Descrição Valor
açãoGroupId ID do recurso do Grupo de Ações a ser invocado quando o alerta for acionado. string
webHookPropriedades As propriedades de um objeto webhook. ActionWebHookProperties

ActionWebHookProperties

Designação Descrição Valor

Condição

Designação Descrição Valor
Dimensões Condições da lista de dimensões Dimensão[]
failingPeriods O número mínimo de violações necessárias dentro da janela de tempo de retrospetiva selecionada necessária para gerar um alerta. ConditionFailingPeriods
metricMeasureColumn A coluna que contém o número da medida métrica. string
Operador O operador de critérios. 'Iguais'
'MaiorQue'
'MaiorThanOrEqual'
'Menosque'
'LessThanOrEqual' (obrigatório)
consulta Alerta de consulta de log string
resourceIdColumn A coluna que contém a id do recurso. O conteúdo da coluna deve ser um uri formatado como id de recurso string
limiar O valor limite de critérios que ativa o alerta. int (obrigatório)
agregação de tempo Tipo de agregação 'Média'
'Contagem'
'Máximo'
'Mínimo'
'Total' (obrigatório)

CondiçãoFailingPeriods

Designação 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
númeroDeAvaliaçãoPeríodos O número de pontos de retrospetiva agregados. A janela de tempo de retrospetiva é 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

Designação Descrição Valor
Designação Nome da dimensão string (obrigatório)
Operador Operador para valores de dimensão 'Excluir'
'Incluir' (obrigatório)
valores Lista de valores de dimensão string[] (obrigatório)

Microsoft.Insights/scheduledQueryRules

Designação Descrição Valor
Localização A geolocalização onde o recurso vive string (obrigatório)
Designação O nome do recurso string

Restrições:
Padrão = ^[^#<>%&:\?/{}*]{1,260}$ (obrigatório)
propriedades As propriedades da regra do recurso. ScheduledQueryRuleProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.Insights/scheduledQueryRules@2020-05-01-preview"

ScheduledQueryRuleCriteria

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

ScheduledQueryRuleProperties

Designação 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 para exibição da regra de alerta string
ativado O sinalizador que indica se essa regra de consulta agendada está habilitada. O valor deve ser verdadeiro ou falso Bool
avaliaçãoFrequência A frequência com que a regra de consulta agendada é avaliada representada no formato de duração ISO 8601. string
muteActionsDuration Silencie ações pelo período de tempo escolhido (no formato de duração ISO 8601) depois que o alerta for acionado. string
overrideQueryTimeRange Se especificado, substitui o intervalo de tempo de consulta (o padrão é WindowSize*NumberOfEvaluationPeriods) string
Âmbitos de aplicação A lista de ids de recurso para as quais esta regra de consulta agendada tem escopo. string[]
gravidade Severidade do alerta. Deve ser um número inteiro entre [0-4]. O valor de 0 é mais severo Int
targetResourceTypes Lista do tipo de recurso do(s) recurso(s) de destino no qual 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 atender 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 do compartimento). string

TrackedResourceTags

Designação Descrição Valor