Share via


Microsoft.Insights scheduledQueryRules 2018-04-16

Definición de recursos de Bicep

El tipo de recurso scheduledQueryRules se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Observaciones

Para obtener instrucciones sobre cómo implementar soluciones de supervisión, consulte Creación de recursos de supervisión mediante Bicep.

Formato de los recursos

Para crear un recurso Microsoft.Insights/scheduledQueryRules, agregue el siguiente bicep a la plantilla.

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 acción

Establezca la propiedad odata.type para especificar el 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 propiedad

scheduledQueryRules

Nombre Descripción Value
name El nombre del recurso string (obligatorio)

Límite de caracteres: 1-260

Caracteres válidos:
No puede usar:
*<>%{}&:\\?/# ni caracteres de control

No puede terminar con un espacio ni punto.
ubicación Ubicación de los recursos string (obligatorio)
etiquetas Etiquetas del recurso Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
properties Las propiedades de regla del recurso. LogSearchRule (obligatorio)

LogSearchRule

Nombre Descripción Valor
action Es necesario realizar acciones en la ejecución de reglas. Acción (obligatorio)
autoMitigate Marca que indica si la alerta se debe resolver automáticamente o no. El valor predeterminado es false. bool
description Descripción de la regla de búsqueda de registros. string
DisplayName Nombre para mostrar de la regla de alertas string
enabled Marca que indica si la regla de búsqueda de registros está habilitada. El valor debe ser true o false 'false'
'true'
schedule Programación (frecuencia, ventana de tiempo) para la regla. Obligatorio para el tipo de acción: AlertingAction Programación
source Origen de datos en el que la regla consultará datos Origen (obligatorio)

Acción

Nombre Descripción Valor
odata.type Establecimiento del 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 (obligatorio)

AlertingAction

Nombre Descripción Valor
odata.type Especifica la acción. Valores admitidos: AlertingAction, LogToMetricAction 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction' (obligatorio)
aznsAction Referencia del grupo de acciones de Azure. AzNsActionGroup
severity Gravedad de la alerta "0"
'1'
'2'
'3'
'4' (obligatorio)
throttlingInMin tiempo (en minutos) para el que se deben limitar o suprimir las alertas. int
desencadenador Condición de desencadenador que da como resultado la regla de alertas. TriggerCondition (obligatorio)

AzNsActionGroup

Nombre Descripción Valor
actionGroup Referencia del grupo de acciones de Azure. string[]
customWebhookPayload Carga personalizada que se enviará para todo el URI de webhook en el grupo de acciones de Azure string
emailSubject Invalidación de asunto personalizada para todos los identificadores de correo electrónico en el grupo de acciones de Azure string

TriggerCondition

Nombre Descripción Valor
metricTrigger Condición de desencadenador para la regla de consulta de métricas LogMetricTrigger
threshold Umbral de resultado o recuento en función de la regla que se debe desencadenar. int (obligatorio)
thresholdOperator Operación de evaluación para la regla: "GreaterThan" o "LessThan". 'Equal'
'GreaterThan'
'GreaterThanOrEqual'
'LessThan'
'LessThanOrEqual' (obligatorio)

LogMetricTrigger

Nombre Descripción Valor
metricColumn Evaluación de la métrica en una columna determinada string
metricTriggerType Tipo de desencadenador de métrica: "Consecutivo" o "Total" 'Consecutivos'
'Total'
threshold Umbral del desencadenador de métrica. int
thresholdOperator Operación de evaluación para la métrica -"GreaterThan" o "LessThan" o "Equal". 'Equal'
'GreaterThan'
'GreaterThanOrEqual'
'LessThan'
'LessThanOrEqual'

LogToMetricAction

Nombre Descripción Valor
odata.type Especifica la acción. Valores admitidos: AlertingAction, LogToMetricAction "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction" (obligatorio)
criterios Criterios de métrica Criteria[] (obligatorio)

Criterios

Nombre Descripción Valor
dimensions Lista de dimensiones para crear métricas Dimensión[]
metricName Nombre de la métrica string (obligatorio)

Dimensión

Nombre Descripción Value
name Nombre de la dimensión string (obligatorio)
operator Operador para valores de dimensión 'Include' (obligatorio)
valores Lista de valores de dimensión string[] (obligatorio)

Programación

Nombre Descripción Valor
frequencyInMinutes frequency (en minutos) en la que se debe evaluar la condición de regla. int (obligatorio)
timeWindowInMinutes Período de tiempo para el que se deben capturar los datos para la consulta (debe ser mayor o igual que frequencyInMinutes). int (obligatorio)

Source

Nombre Descripción Valor
authorizedResources Lista de recursos a los que se hace referencia en la consulta string[]
dataSourceId Identificador URI del recurso en el que se va a ejecutar la consulta de búsqueda de registros. string (obligatorio)
Query Consulta de búsqueda de registros. Obligatorio para el tipo de acción: AlertingAction string
queryType Establezca el valor en "ResultCount". 'ResultCount'

Definición de recursos de plantilla de ARM

El tipo de recurso scheduledQueryRules se puede implementar con operaciones que tienen como destino:

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Observaciones

Para obtener instrucciones sobre cómo implementar soluciones de supervisión, consulte Creación de recursos de supervisión mediante Bicep.

Formato de los recursos

Para crear un recurso Microsoft.Insights/scheduledQueryRules, agregue el siguiente json a la plantilla.

{
  "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 action

Establezca la propiedad odata.type para especificar el 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 propiedad

scheduledQueryRules

Nombre Descripción Value
type Tipo de recurso "Microsoft.Insights/scheduledQueryRules"
apiVersion La versión de la API de recursos '2018-04-16'
name El nombre del recurso string (obligatorio)

Límite de caracteres: 1-260

Caracteres válidos:
No puede usar:
*<>%{}&:\\?/# ni caracteres de control

No puede terminar con un espacio ni punto.
ubicación Ubicación de los recursos string (obligatorio)
etiquetas Etiquetas del recurso Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
properties Las propiedades de regla del recurso. LogSearchRule (obligatorio)

LogSearchRule

Nombre Descripción Valor
action Es necesario realizar acciones en la ejecución de reglas. Acción (obligatoria)
autoMitigate Marca que indica si la alerta se debe resolver automáticamente o no. El valor predeterminado es false. bool
description Descripción de la regla de búsqueda de registros. string
DisplayName Nombre para mostrar de la regla de alertas string
enabled Marca que indica si la regla de búsqueda de registros está habilitada. El valor debe ser true o false 'false'
'true'
schedule Programación (frecuencia, período de tiempo) para la regla. Obligatorio para el tipo de acción: AlertingAction Programación
source Origen de datos con el que la regla consultará los datos Origen (obligatorio)

Acción

Nombre Descripción Valor
odata.type Establecimiento del 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 (obligatorio)

AlertingAction

Nombre Descripción Valor
odata.type Especifica la acción. Valores admitidos: AlertingAction, LogToMetricAction "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction" (obligatorio)
aznsAction Referencia del grupo de acciones de Azure. AzNsActionGroup
severity Gravedad de la alerta "0"
'1'
'2'
'3'
'4' (obligatorio)
throttlingInMin tiempo (en minutos) para el que se deben limitar o suprimir las alertas. int
desencadenador Condición de desencadenador que da como resultado la regla de alertas. TriggerCondition (obligatorio)

AzNsActionGroup

Nombre Descripción Valor
actionGroup Referencia del grupo de acciones de Azure. string[]
customWebhookPayload Carga personalizada que se enviará para todo el URI de webhook en el grupo de acciones de Azure string
emailSubject Invalidación de asunto personalizada para todos los identificadores de correo electrónico en el grupo de acciones de Azure string

TriggerCondition

Nombre Descripción Valor
metricTrigger Condición de desencadenador para la regla de consulta de métricas LogMetricTrigger
threshold Umbral de resultado o recuento en función de la regla que se debe desencadenar. int (obligatorio)
thresholdOperator Operación de evaluación para la regla: "GreaterThan" o "LessThan". 'Equal'
'GreaterThan'
'GreaterThanOrEqual'
'LessThan'
'LessThanOrEqual' (obligatorio)

LogMetricTrigger

Nombre Descripción Valor
metricColumn Evaluación de la métrica en una columna determinada string
metricTriggerType Tipo de desencadenador de métrica: "Consecutivo" o "Total" 'Consecutivos'
'Total'
threshold Umbral del desencadenador de métrica. int
thresholdOperator Operación de evaluación para la métrica -"GreaterThan" o "LessThan" o "Equal". 'Equal'
'GreaterThan'
'GreaterThanOrEqual'
'LessThan'
'LessThanOrEqual'

LogToMetricAction

Nombre Descripción Valor
odata.type Especifica la acción. Valores admitidos: AlertingAction, LogToMetricAction "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction" (obligatorio)
criterios Criterios de métrica Criteria[] (obligatorio)

Criterios

Nombre Descripción Valor
dimensions Lista de dimensiones para crear métricas Dimensión[]
metricName Nombre de la métrica string (obligatorio)

Dimensión

Nombre Descripción Value
name Nombre de la dimensión string (obligatorio)
operator Operador para valores de dimensión 'Include' (obligatorio)
valores Lista de valores de dimensión string[] (obligatorio)

Programación

Nombre Descripción Valor
frequencyInMinutes frequency (en minutos) en la que se debe evaluar la condición de regla. int (obligatorio)
timeWindowInMinutes Período de tiempo para el que se deben capturar los datos para la consulta (debe ser mayor o igual que frequencyInMinutes). int (obligatorio)

Source

Nombre Descripción Valor
authorizedResources Lista de recursos a los que se hace referencia en la consulta string[]
dataSourceId Identificador URI del recurso en el que se va a ejecutar la consulta de búsqueda de registros. string (obligatorio)
Query Consulta de búsqueda de registros. Obligatorio para el tipo de acción: AlertingAction string
queryType Establezca el valor en "ResultCount". 'ResultCount'

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso scheduledQueryRules se puede implementar con operaciones que tienen como destino:

  • Grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.Insights/scheduledQueryRules, agregue el siguiente terraform a la plantilla.

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 action

Establezca la propiedad odata.type para especificar el 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 propiedad

scheduledQueryRules

Nombre Descripción Value
type Tipo de recurso "Microsoft.Insights/scheduledQueryRules@2018-04-16"
name El nombre del recurso string (obligatorio)

Límite de caracteres: 1-260

Caracteres válidos:
No puede usar:
*<>%{}&:\\?/# ni caracteres de control

No puede terminar con un espacio ni punto.
ubicación Ubicación de los recursos string (obligatorio)
parent_id Para realizar la implementación en un grupo de recursos, use el identificador de ese grupo de recursos. string (obligatorio)
etiquetas Etiquetas del recurso Diccionario de nombres y valores de etiqueta.
properties Las propiedades de regla del recurso. LogSearchRule (obligatorio)

LogSearchRule

Nombre Descripción Valor
action Es necesario realizar acciones en la ejecución de reglas. Acción (obligatoria)
autoMitigate Marca que indica si la alerta se debe resolver automáticamente o no. El valor predeterminado es false. bool
description Descripción de la regla de búsqueda de registros. string
DisplayName Nombre para mostrar de la regla de alertas string
enabled Marca que indica si la regla de búsqueda de registros está habilitada. El valor debe ser true o false "false"
"true"
schedule Programación (frecuencia, período de tiempo) para la regla. Obligatorio para el tipo de acción: AlertingAction Programación
source Origen de datos con el que la regla consultará los datos Origen (obligatorio)

Acción

Nombre Descripción Valor
odata.type Establecimiento del 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 (obligatorio)

AlertingAction

Nombre Descripción Valor
odata.type Especifica la acción. Valores admitidos: AlertingAction, LogToMetricAction "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction" (obligatorio)
aznsAction Referencia del grupo de acciones de Azure. AzNsActionGroup
severity Gravedad de la alerta "0"
"1"
"2"
"3"
"4" (obligatorio)
throttlingInMin tiempo (en minutos) para el que las alertas deben limitarse o suprimirse. int
desencadenador Condición del desencadenador que da como resultado que la regla de alerta sea. TriggerCondition (obligatorio)

AzNsActionGroup

Nombre Descripción Valor
actionGroup Referencia del grupo de acciones de Azure. string[]
customWebhookPayload Carga personalizada que se va a enviar para todos los URI de webhook en el grupo de acciones de Azure string
emailSubject Invalidación de asunto personalizado para todos los identificadores de correo electrónico en el grupo de acciones de Azure string

TriggerCondition

Nombre Descripción Valor
metricTrigger Condición de desencadenador para la regla de consulta de métricas LogMetricTrigger
threshold Umbral de resultado o recuento en función de la regla que se debe desencadenar. int (obligatorio)
thresholdOperator Operación de evaluación para la regla: "GreaterThan" o "LessThan". "Igual"
"GreaterThan"
"GreaterThanOrEqual"
"LessThan"
"LessThanOrEqual" (obligatorio)

LogMetricTrigger

Nombre Descripción Valor
metricColumn Evaluación de la métrica en una columna determinada string
metricTriggerType Tipo de desencadenador de métrica: "Consecutivo" o "Total" "Consecutivo"
"Total"
threshold Umbral del desencadenador de métrica. int
thresholdOperator Operación de evaluación para la métrica -'GreaterThan' o 'LessThan' o 'Equal'. "Igual"
"GreaterThan"
"GreaterThanOrEqual"
"LessThan"
"LessThanOrEqual"

LogToMetricAction

Nombre Descripción Valor
odata.type Especifica la acción. Valores admitidos: AlertingAction, LogToMetricAction "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction" (obligatorio)
criterios Criterios de métrica Criterios[] (obligatorio)

Criterios

Nombre Descripción Valor
dimensions Lista de dimensiones para crear la métrica Dimensión[]
metricName Nombre de la métrica string (obligatorio)

Dimensión

Nombre Descripción Value
name Nombre de la dimensión string (obligatorio)
operator Operador para valores de dimensión "Include" (obligatorio)
valores Lista de valores de dimensión string[] (obligatorio)

Programación

Nombre Descripción Valor
frequencyInMinutes frequency (en minutos) en la que se debe evaluar la condición de regla. int (obligatorio)
timeWindowInMinutes Período de tiempo para el que se deben capturar los datos de la consulta (debe ser mayor o igual que frequencyInMinutes). int (obligatorio)

Source

Nombre Descripción Valor
authorizedResources Lista de recursos a los que se hace referencia en la consulta string[]
dataSourceId Identificador URI de recurso sobre el que se va a ejecutar la consulta de búsqueda de registros. string (obligatorio)
Query Consulta de búsqueda de registros. Obligatorio para el tipo de acción: AlertingAction string
queryType Establezca el valor en "ResultCount". "ResultCount"