Compartilhar via

Microsoft.Insights scheduledQueryRules 2018-04-16

  • Artigo

Definição de recurso do Bicep

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

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

Comentários

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

Formato de recurso

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

resource symbolicname 'Microsoft.Insights/scheduledQueryRules@2018-04-16' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    action: {
      'odata.type': 'string'
      // For remaining properties, see Action objects
    }
    autoMitigate: bool
    description: 'string'
    displayName: 'string'
    enabled: 'string'
    schedule: {
      frequencyInMinutes: int
      timeWindowInMinutes: int
    }
    source: {
      authorizedResources: [
        'string'
      ]
      dataSourceId: 'string'
      query: 'string'
      queryType: 'ResultCount'
    }
  }
}

Objetos de ação

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

Para Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction, use:

  'odata.type': 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction'
  aznsAction: {
    actionGroup: [
      'string'
    ]
    customWebhookPayload: 'string'
    emailSubject: 'string'
  }
  severity: 'string'
  throttlingInMin: int
  trigger: {
    metricTrigger: {
      metricColumn: 'string'
      metricTriggerType: 'string'
      threshold: int
      thresholdOperator: 'string'
    }
    threshold: int
    thresholdOperator: 'string'
  }

Para Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction, use:

  'odata.type': 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction'
  criteria: [
    {
      dimensions: [
        {
          name: 'string'
          operator: 'Include'
          values: [
            'string'
          ]
        }
      ]
      metricName: 'string'
    }
  ]

Valores de propriedade

scheduledQueryRules

Nome Descrição Valor
name O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 1-260

Caracteres válidos:
Não é possível usar:
*<>%{}&:\\?/# ou caracteres de controle

Não pode terminar com espaço ou ponto.
local Localização do recurso cadeia de caracteres (obrigatório)
marcas Marcações de recursos Dicionário de nomes e valores de marcas. Confira Marcas em modelos
properties As propriedades da regra do recurso. LogSearchRule (obrigatório)

LogSearchRule

Nome Descrição Valor
ação A ação precisa ser tomada na execução da regra. Ação (obrigatório)
autoMitigate O sinalizador que indica se o alerta deve ser resolvido automaticamente ou não. O padrão é false. bool
descrição A descrição da regra de Pesquisa de Logs. string
displayName O nome de exibição da regra de alerta string
Habilitado O sinalizador que indica se a regra de Pesquisa de Logs está habilitada. O valor deve ser true ou false 'false'
'true'
schedule Agendamento (Frequência, Janela de Tempo) para a regra. Necessário para o tipo de ação – AlertingAction Agenda
source Fonte de dados em relação a qual regra consultará dados Origem (obrigatório)

Ação

Nome Descrição Valor
odata.type Definir o tipo de objeto Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction
Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction (obrigatório)

AlertingAction

Nome Descrição Valor
odata.type Especifica a ação. Valores com suporte - AlertingAction, LogToMetricAction 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction' (obrigatório)
aznsAction Referência do grupo de ações do Azure. AzNsActionGroup
severidade Severidade do alerta '0'
'1'
'2'
'3'
'4' (obrigatório)
throttlingInMin tempo (em minutos) para o qual os alertas devem ser limitados ou suprimidos. INT
gatilho A condição de gatilho que resulta na regra de alerta. TriggerCondition (obrigatório)

AzNsActionGroup

Nome Descrição Valor
Actiongroup Referência do Grupo de Ações do Azure. string[]
customWebhookPayload Conteúdo personalizado a ser enviado para todo o URI do webhook no grupo de ações do Azure string
emailSubject Substituição de assunto personalizado para todas as IDs de email no grupo de ações do Azure string

TriggerCondition

Nome Descrição Valor
metricTrigger Condição de gatilho para a regra de consulta de métrica LogMetricTrigger
threshold Limite de resultado ou contagem com base em qual regra deve ser disparada. int (obrigatório)
thresholdOperator Operação de avaliação para regra – 'GreaterThan' ou 'LessThan. 'Equal'
'GreaterThan'
'GreaterThanOrEqual'
'LessThan'
'LessThanOrEqual' (obrigatório)

LogMetricTrigger

Nome Descrição Valor
metricColumn Avaliação da métrica em uma coluna específica string
metricTriggerType Tipo de gatilho de métrica – 'Consecutivo' ou 'Total' 'Consecutivo'
'Total'
threshold O limite do gatilho de métrica. INT
thresholdOperator Operação de avaliação para Métrica -'GreaterThan' ou 'LessThan' ou 'Equal'. 'Equal'
'GreaterThan'
'GreaterThanOrEqual'
'LessThan'
'LessThanOrEqual'

LogToMetricAction

Nome Descrição Valor
odata.type Especifica a ação. Valores com suporte - AlertingAction, LogToMetricAction 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction' (obrigatório)
critérios Critérios de métrica Criteria[] (obrigatório)

Critérios

Nome Descrição Valor
dimensions Lista de dimensões para criar a métrica Dimensão[]
metricName Nome da métrica cadeia de caracteres (obrigatório)

Dimensão

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

Agenda

Nome Descrição Valor
frequencyInMinutes frequência (em minutos) na qual a condição da regra deve ser avaliada. int (obrigatório)
timeWindowInMinutes Janela de tempo para a qual os dados precisam ser buscados para consulta (deve ser maior ou igual a frequencyInMinutes). int (obrigatório)

Fonte

Nome Descrição Valor
authorizedResources Lista de recursos referenciados em consulta string[]
Datasourceid O uri do recurso sobre qual consulta de pesquisa de log deve ser executada. cadeia de caracteres (obrigatório)
Consulta Consulta de pesquisa de log. Necessário para o tipo de ação – AlertingAction string
queryType Defina o valor como 'ResultCount' . 'ResultCount'

Definição de recurso de modelo do ARM

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

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

Comentários

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

Formato de recurso

Para criar um recurso Microsoft.Insights/scheduledQueryRules, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.Insights/scheduledQueryRules",
  "apiVersion": "2018-04-16",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "action": {
      "odata.type": "string"
      // For remaining properties, see Action objects
    },
    "autoMitigate": "bool",
    "description": "string",
    "displayName": "string",
    "enabled": "string",
    "schedule": {
      "frequencyInMinutes": "int",
      "timeWindowInMinutes": "int"
    },
    "source": {
      "authorizedResources": [ "string" ],
      "dataSourceId": "string",
      "query": "string",
      "queryType": "ResultCount"
    }
  }
}

Objetos de ação

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

Para Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction, use:

  "odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction",
  "aznsAction": {
    "actionGroup": [ "string" ],
    "customWebhookPayload": "string",
    "emailSubject": "string"
  },
  "severity": "string",
  "throttlingInMin": "int",
  "trigger": {
    "metricTrigger": {
      "metricColumn": "string",
      "metricTriggerType": "string",
      "threshold": "int",
      "thresholdOperator": "string"
    },
    "threshold": "int",
    "thresholdOperator": "string"
  }

Para Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction, use:

  "odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction",
  "criteria": [
    {
      "dimensions": [
        {
          "name": "string",
          "operator": "Include",
          "values": [ "string" ]
        }
      ],
      "metricName": "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 '2018-04-16'
name O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 1 a 260

Caracteres válidos:
Não é possível usar:
*<>%{}&:\\?/# ou caracteres de controle

Não pode terminar com espaço ou ponto.
local Localização do recurso cadeia de caracteres (obrigatório)
marcas Marcações de recursos Dicionário de nomes e valores de marcas. Consulte Marcas em modelos
properties As propriedades de regra do recurso. LogSearchRule (obrigatório)

LogSearchRule

Nome Descrição Valor
ação A ação precisa ser executada na execução da regra. Ação (obrigatório)
autoMitigate O sinalizador que indica se o alerta deve ser resolvido automaticamente ou não. O padrão é false. bool
descrição A descrição da regra de Pesquisa de Logs. string
displayName O nome de exibição da regra de alerta string
Habilitado O sinalizador que indica se a regra pesquisa de log está habilitada. O valor deve ser true ou false 'false'
'true'
schedule Agendamento (Frequência, Janela de Tempo) para a regra. Necessário para o tipo de ação – AlertingAction Agenda
source Fonte de dados em relação a qual regra consultará dados Origem (obrigatório)

Ação

Nome Descrição Valor
odata.type Definir o tipo de objeto Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction
Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction (obrigatório)

AlertingAction

Nome Descrição Valor
odata.type Especifica a ação. Valores com suporte – AlertingAction, LogToMetricAction 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction' (obrigatório)
aznsAction Referência do grupo de ações do Azure. AzNsActionGroup
severidade Severidade do alerta '0'
'1'
'2'
'3'
'4' (obrigatório)
throttlingInMin tempo (em minutos) para o qual os alertas devem ser limitados ou suprimidos. INT
gatilho A condição de gatilho que resulta na regra de alerta. TriggerCondition (obrigatório)

AzNsActionGroup

Nome Descrição Valor
Actiongroup Referência do Grupo de Ações do Azure. string[]
customWebhookPayload Conteúdo personalizado a ser enviado para todo o URI de webhook no grupo de ações do Azure string
emailSubject Substituição de entidade personalizada para todas as IDs de email no grupo de ações do Azure string

TriggerCondition

Nome Descrição Valor
metricTrigger Condição de gatilho para a regra de consulta de métrica LogMetricTrigger
threshold Limite de resultado ou contagem com base em qual regra deve ser disparada. int (obrigatório)
thresholdOperator Operação de avaliação para regra – 'GreaterThan' ou 'LessThan. 'Equal'
'GreaterThan'
'GreaterThanOrEqual'
'LessThan'
'LessThanOrEqual' (obrigatório)

LogMetricTrigger

Nome Descrição Valor
metricColumn Avaliação da métrica em uma coluna específica string
metricTriggerType Tipo de gatilho de métrica – 'Consecutivo' ou 'Total' 'Consecutivo'
'Total'
threshold O limite do gatilho de métrica. INT
thresholdOperator Operação de avaliação para Metric -'GreaterThan' ou 'LessThan' ou 'Equal'. 'Equal'
'GreaterThan'
'GreaterThanOrEqual'
'LessThan'
'LessThanOrEqual'

LogToMetricAction

Nome Descrição Valor
odata.type Especifica a ação. Valores com suporte – AlertingAction, LogToMetricAction 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction' (obrigatório)
critérios Critérios de métrica Criteria[] (obrigatório)

Critérios

Nome Descrição Valor
dimensions Lista de Dimensões para criar a métrica Dimensão[]
metricName Nome da métrica cadeia de caracteres (obrigatório)

Dimensão

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

Agenda

Nome Descrição Valor
frequencyInMinutes frequência (em minutos) na qual a condição da regra deve ser avaliada. int (obrigatório)
timeWindowInMinutes Janela de tempo para a qual os dados precisam ser buscados para consulta (deve ser maior ou igual a frequencyInMinutes). int (obrigatório)

Fonte

Nome Descrição Valor
authorizedResources Lista de recursos referenciados em consulta string[]
Datasourceid O uri do recurso sobre qual consulta de pesquisa de log deve ser executada. cadeia de caracteres (obrigatório)
Consulta Consulta de pesquisa de log. Necessário para o tipo de ação – AlertingAction string
queryType Defina o valor como 'ResultCount' . 'ResultCount'

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

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

  • Grupos de recursos

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

Formato de recurso

Para criar um recurso Microsoft.Insights/scheduledQueryRules, adicione o Terraform a seguir ao modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/scheduledQueryRules@2018-04-16"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      action = {
        odata.type = "string"
        // For remaining properties, see Action objects
      }
      autoMitigate = bool
      description = "string"
      displayName = "string"
      enabled = "string"
      schedule = {
        frequencyInMinutes = int
        timeWindowInMinutes = int
      }
      source = {
        authorizedResources = [
          "string"
        ]
        dataSourceId = "string"
        query = "string"
        queryType = "ResultCount"
      }
    }
  })
}

Objetos de ação

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

Para Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction, use:

  odata.type = "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction"
  aznsAction = {
    actionGroup = [
      "string"
    ]
    customWebhookPayload = "string"
    emailSubject = "string"
  }
  severity = "string"
  throttlingInMin = int
  trigger = {
    metricTrigger = {
      metricColumn = "string"
      metricTriggerType = "string"
      threshold = int
      thresholdOperator = "string"
    }
    threshold = int
    thresholdOperator = "string"
  }

Para Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction, use:

  odata.type = "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction"
  criteria = [
    {
      dimensions = [
        {
          name = "string"
          operator = "Include"
          values = [
            "string"
          ]
        }
      ]
      metricName = "string"
    }
  ]

Valores de propriedade

scheduledQueryRules

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.Insights/scheduledQueryRules@2018-04-16"
name O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 1 a 260

Caracteres válidos:
Não é possível usar:
*<>%{}&:\\?/# ou caracteres de controle

Não pode terminar com espaço ou ponto.
local Localização do recurso cadeia de caracteres (obrigatório)
parent_id Para implantar em um grupo de recursos, use a ID desse grupo de recursos. cadeia de caracteres (obrigatório)
marcas Marcações de recursos Dicionário de nomes e valores de marcas.
properties As propriedades de regra do recurso. LogSearchRule (obrigatório)

LogSearchRule

Nome Descrição Valor
ação A ação precisa ser executada na execução da regra. Ação (obrigatório)
autoMitigate O sinalizador que indica se o alerta deve ser resolvido automaticamente ou não. O padrão é false. bool
descrição A descrição da regra de Pesquisa de Logs. string
displayName O nome de exibição da regra de alerta string
Habilitado O sinalizador que indica se a regra pesquisa de log está habilitada. O valor deve ser true ou false "false"
"true"
schedule Agendamento (Frequência, Janela de Tempo) para a regra. Necessário para o tipo de ação – AlertingAction Agenda
source Fonte de dados em relação a qual regra consultará dados Origem (obrigatório)

Ação

Nome Descrição Valor
odata.type Definir o tipo de objeto Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction
Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction (obrigatório)

AlertingAction

Nome Descrição Valor
odata.type Especifica a ação. Valores com suporte – AlertingAction, LogToMetricAction "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction" (obrigatório)
aznsAction Referência do grupo de ações do Azure. AzNsActionGroup
severidade Severidade do alerta "0"
"1"
"2"
"3"
"4" (obrigatório)
throttlingInMin tempo (em minutos) para o qual os alertas devem ser limitados ou suprimidos. INT
gatilho A condição de gatilho que resulta na regra de alerta. TriggerCondition (obrigatório)

AzNsActionGroup

Nome Descrição Valor
Actiongroup Referência do Grupo de Ações do Azure. string[]
customWebhookPayload Conteúdo personalizado a ser enviado para todo o URI de webhook no grupo de ações do Azure string
emailSubject Substituição de entidade personalizada para todas as IDs de email no grupo de ações do Azure string

TriggerCondition

Nome Descrição Valor
metricTrigger Condição de gatilho para a regra de consulta de métrica LogMetricTrigger
threshold Limite de resultado ou contagem com base em qual regra deve ser disparada. int (obrigatório)
thresholdOperator Operação de avaliação para regra – 'GreaterThan' ou 'LessThan. "Igual"
"GreaterThan"
"GreaterThanOrEqual"
"LessThan"
"LessThanOrEqual" (obrigatório)

LogMetricTrigger

Nome Descrição Valor
metricColumn Avaliação da métrica em uma coluna específica string
metricTriggerType Tipo de gatilho de métrica – 'Consecutivo' ou 'Total' "Consecutivo"
"Total"
threshold O limite do gatilho de métrica. INT
thresholdOperator Operação de avaliação para Metric -'GreaterThan' ou 'LessThan' ou 'Equal'. "Igual"
"GreaterThan"
"GreaterThanOrEqual"
"LessThan"
"LessThanOrEqual"

LogToMetricAction

Nome Descrição Valor
odata.type Especifica a ação. Valores com suporte – AlertingAction, LogToMetricAction "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction" (obrigatório)
critérios Critérios de métrica Criteria[] (obrigatório)

Critérios

Nome Descrição Valor
dimensions Lista de Dimensões para criar a métrica Dimensão[]
metricName Nome da métrica cadeia de caracteres (obrigatório)

Dimensão

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

Agenda

Nome Descrição Valor
frequencyInMinutes frequência (em minutos) na qual a condição da regra deve ser avaliada. int (obrigatório)
timeWindowInMinutes Janela de tempo para a qual os dados precisam ser buscados para consulta (deve ser maior ou igual a frequencyInMinutes). int (obrigatório)

Fonte

Nome Descrição Valor
authorizedResources Lista de recursos referenciados em consulta string[]
Datasourceid O uri do recurso sobre qual consulta de pesquisa de log deve ser executada. cadeia de caracteres (obrigatório)
Consulta Consulta de pesquisa de log. Necessário para o tipo de ação – AlertingAction string
queryType Defina o valor como 'ResultCount' . "ResultCount"