Microsoft.Insights scheduledQueryRules 2018-04-16

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.

Comentários

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

Formato do recurso

Para criar um recurso Microsoft.Insights/scheduledQueryRules, adicione o seguinte Bicep ao seu 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

Designação Descrição Valor
Designação O nome do recurso string (obrigatório)

Limite de caracteres: 1-260

Caracteres válidos:
Não pode usar:
*<>%{}&:\\?/#| ou controlar caracteres

Não pode terminar com espaço ou ponto.
Localização Localização do recurso string (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos
propriedades As propriedades da regra do recurso. LogSearchRule (obrigatório)

LogSearchRule

Designação Descrição Valor
ação É necessário tomar medidas no que respeita à execução das regras. Ação (obrigatório)
autoMitigar 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 Log. string
displayName O nome para exibição da regra de alerta string
ativado O sinalizador que indica se a regra de Pesquisa de Log está habilitada. O valor deve ser verdadeiro ou falso 'falso'
'verdadeiro'
Horário Cronograma (Frequência, Janela de Tempo) para a regra. Necessário para o tipo de ação - AlertingAction Horário
fonte Fonte de dados em relação à qual a regra consultará dados de origem (obrigatório)

Ação

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

Designação Descrição Valor
odata.type Especifica a ação. Valores suportados - AlertingAction, LogToMetricAction 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction' (obrigatório)
aznsAção Referência do grupo de ação do Azure. AzNsActionGroup
gravidade Gravidade do alerta '0'
'1'
'2'
'3'
'4' (obrigatório)
throttlingInMin tempo (em minutos) durante 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

Designação Descrição Valor
açãoGrupo Referência do Grupo de Ação do Azure. string[]
customWebhookPayload Carga útil personalizada a ser enviada para todo o URI do webhook no grupo de ação do Azure string
emailAssunto Substituição de assunto personalizada para todas as IDs de email no grupo de ações do Azure string

TriggerCondition

Designação Descrição Valor
metricTrigger Condição de gatilho para regra de consulta métrica LogMetricTrigger
limiar Limite de resultado ou contagem com base na regra que deve ser acionada. int (obrigatório)
Operador de limiar Operação de avaliação para a regra - 'GreaterThan' ou 'LessThan. 'Igual'
'MaiorQue'
'MaiorThanOrEqual'
'Menosque'
'LessThanOrEqual' (obrigatório)

LogMetricTrigger

Designação Descrição Valor
metricColumn Avaliação da métrica em uma coluna específica string
metricTriggerType Tipo de gatilho métrico - 'Consecutivo' ou 'Total' 'Consecutiva'
'Total'
limiar O limiar do gatilho métrico. Int
Operador de limiar Operação de avaliação para Metric -'GreaterThan' ou 'LessThan' ou 'Equal'. 'Igual'
'MaiorQue'
'MaiorThanOrEqual'
'Menosque'
'LessThanOrEqual'

LogToMetricAction

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

Critérios

Designação Descrição Valor
Dimensões Lista de dimensões para criar métricas Dimensão[]
metricName Nome da métrica string (obrigatório)

Dimensão

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

Horário

Designação Descrição Valor
frequênciaInMinutes frequência (em minutos) em que 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

Designação Descrição Valor
Recursos autorizados Lista de recursos referidos na consulta string[]
dataSourceId O uri do recurso sobre o qual a consulta de pesquisa de log deve ser executada. string (obrigatório)
consulta Consulta de pesquisa de log. Necessário para o tipo de ação - AlertingAction string
queryType Defina o valor como 'ResultCount' . 'Contagem de resultados'

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 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.

Comentários

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

Formato do recurso

Para criar um recurso Microsoft.Insights/scheduledQueryRules, adicione o seguinte JSON ao seu 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

Designação Descrição Valor
tipo O tipo de recurso 'Microsoft.Insights/scheduledQueryRules'
apiVersion A versão da api de recursos '2018-04-16'
Designação O nome do recurso string (obrigatório)

Limite de caracteres: 1-260

Caracteres válidos:
Não pode usar:
*<>%{}&:\\?/#| ou controlar caracteres

Não pode terminar com espaço ou ponto.
Localização Localização do recurso string (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos
propriedades As propriedades da regra do recurso. LogSearchRule (obrigatório)

LogSearchRule

Designação Descrição Valor
ação É necessário tomar medidas no que respeita à execução das regras. Ação (obrigatório)
autoMitigar 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 Log. string
displayName O nome para exibição da regra de alerta string
ativado O sinalizador que indica se a regra de Pesquisa de Log está habilitada. O valor deve ser verdadeiro ou falso 'falso'
'verdadeiro'
Horário Cronograma (Frequência, Janela de Tempo) para a regra. Necessário para o tipo de ação - AlertingAction Horário
fonte Fonte de dados em relação à qual a regra consultará dados de origem (obrigatório)

Ação

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

Designação Descrição Valor
odata.type Especifica a ação. Valores suportados - AlertingAction, LogToMetricAction 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction' (obrigatório)
aznsAção Referência do grupo de ação do Azure. AzNsActionGroup
gravidade Gravidade do alerta '0'
'1'
'2'
'3'
'4' (obrigatório)
throttlingInMin tempo (em minutos) durante 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

Designação Descrição Valor
açãoGrupo Referência do Grupo de Ação do Azure. string[]
customWebhookPayload Carga útil personalizada a ser enviada para todo o URI do webhook no grupo de ação do Azure string
emailAssunto Substituição de assunto personalizada para todas as IDs de email no grupo de ações do Azure string

TriggerCondition

Designação Descrição Valor
metricTrigger Condição de gatilho para regra de consulta métrica LogMetricTrigger
limiar Limite de resultado ou contagem com base na regra que deve ser acionada. int (obrigatório)
Operador de limiar Operação de avaliação para a regra - 'GreaterThan' ou 'LessThan. 'Igual'
'MaiorQue'
'MaiorThanOrEqual'
'Menosque'
'LessThanOrEqual' (obrigatório)

LogMetricTrigger

Designação Descrição Valor
metricColumn Avaliação da métrica em uma coluna específica string
metricTriggerType Tipo de gatilho métrico - 'Consecutivo' ou 'Total' 'Consecutiva'
'Total'
limiar O limiar do gatilho métrico. Int
Operador de limiar Operação de avaliação para Metric -'GreaterThan' ou 'LessThan' ou 'Equal'. 'Igual'
'MaiorQue'
'MaiorThanOrEqual'
'Menosque'
'LessThanOrEqual'

LogToMetricAction

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

Critérios

Designação Descrição Valor
Dimensões Lista de dimensões para criar métricas Dimensão[]
metricName Nome da métrica string (obrigatório)

Dimensão

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

Horário

Designação Descrição Valor
frequênciaInMinutes frequência (em minutos) em que 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

Designação Descrição Valor
Recursos autorizados Lista de recursos referidos na consulta string[]
dataSourceId O uri do recurso sobre o qual a consulta de pesquisa de log deve ser executada. string (obrigatório)
consulta Consulta de pesquisa de log. Necessário para o tipo de ação - AlertingAction string
queryType Defina o valor como 'ResultCount' . 'Contagem de resultados'

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@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

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

Limite de caracteres: 1-260

Caracteres válidos:
Não pode usar:
*<>%{}&:\\?/#| ou controlar caracteres

Não pode terminar com espaço ou ponto.
Localização Localização do recurso string (obrigatório)
parent_id Para implantar em um grupo de recursos, use a ID desse grupo de recursos. string (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
propriedades As propriedades da regra do recurso. LogSearchRule (obrigatório)

LogSearchRule

Designação Descrição Valor
ação É necessário tomar medidas no que respeita à execução das regras. Ação (obrigatório)
autoMitigar 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 Log. string
displayName O nome para exibição da regra de alerta string
ativado O sinalizador que indica se a regra de Pesquisa de Log está habilitada. O valor deve ser verdadeiro ou falso "falso"
"verdadeiro"
Horário Cronograma (Frequência, Janela de Tempo) para a regra. Necessário para o tipo de ação - AlertingAction Horário
fonte Fonte de dados em relação à qual a regra consultará dados de origem (obrigatório)

Ação

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

Designação Descrição Valor
odata.type Especifica a ação. Valores suportados - AlertingAction, LogToMetricAction "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction" (obrigatório)
aznsAção Referência do grupo de ação do Azure. AzNsActionGroup
gravidade Gravidade do alerta "0"
"1"
"2"
"3"
"4" (obrigatório)
throttlingInMin tempo (em minutos) durante 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

Designação Descrição Valor
açãoGrupo Referência do Grupo de Ação do Azure. string[]
customWebhookPayload Carga útil personalizada a ser enviada para todo o URI do webhook no grupo de ação do Azure string
emailAssunto Substituição de assunto personalizada para todas as IDs de email no grupo de ações do Azure string

TriggerCondition

Designação Descrição Valor
metricTrigger Condição de gatilho para regra de consulta métrica LogMetricTrigger
limiar Limite de resultado ou contagem com base na regra que deve ser acionada. int (obrigatório)
Operador de limiar Operação de avaliação para a regra - 'GreaterThan' ou 'LessThan. "Igual"
"Maior"
"MaiorThanOrEqual"
"Menos"
"LessThanOrEqual" (obrigatório)

LogMetricTrigger

Designação Descrição Valor
metricColumn Avaliação da métrica em uma coluna específica string
metricTriggerType Tipo de gatilho métrico - 'Consecutivo' ou 'Total' "Consecutiva"
"Total"
limiar O limiar do gatilho métrico. Int
Operador de limiar Operação de avaliação para Metric -'GreaterThan' ou 'LessThan' ou 'Equal'. "Igual"
"Maior"
"MaiorThanOrEqual"
"Menos"
"LessThanOrEqual"

LogToMetricAction

Designação Descrição Valor
odata.type Especifica a ação. Valores suportados - AlertingAction, LogToMetricAction "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction" (obrigatório)
critérios Critérios de Métrica Critérios[] (obrigatório)

Critérios

Designação Descrição Valor
Dimensões Lista de dimensões para criar métricas Dimensão[]
metricName Nome da métrica string (obrigatório)

Dimensão

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

Horário

Designação Descrição Valor
frequênciaInMinutes frequência (em minutos) em que 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

Designação Descrição Valor
Recursos autorizados Lista de recursos referidos na consulta string[]
dataSourceId O uri do recurso sobre o qual a consulta de pesquisa de log deve ser executada. string (obrigatório)
consulta Consulta de pesquisa de log. Necessário para o tipo de ação - AlertingAction string
queryType Defina o valor como 'ResultCount' . "Contagem de Resultados"