Compartir a través de


Microsoft.Insights scheduledQueryRules 2022-06-15

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 la implementación de soluciones de supervisión, consulte Creación de recursos de supervisión mediante Bicep.

Formato de recurso

Para crear un recurso Microsoft.Insights/scheduledQueryRules, agregue lo siguiente a la plantilla de Bicep.

resource symbolicname 'Microsoft.Insights/scheduledQueryRules@2022-06-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  properties: {
    actions: {
      actionGroups: [
        'string'
      ]
      customProperties: {
        {customized property}: 'string'
      }
    }
    autoMitigate: bool
    checkWorkspaceAlertsStorageConfigured: bool
    criteria: {
      allOf: [
        {
          dimensions: [
            {
              name: 'string'
              operator: 'string'
              values: [
                'string'
              ]
            }
          ]
          failingPeriods: {
            minFailingPeriodsToAlert: int
            numberOfEvaluationPeriods: int
          }
          metricMeasureColumn: 'string'
          metricName: '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
    skipQueryValidation: bool
    targetResourceTypes: [
      'string'
    ]
    windowSize: 'string'
  }
}

Valores de propiedad

scheduledQueryRules

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

Límite de caracteres: 1-260

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

No puede terminar con espacio o punto.
ubicación Ubicación geográfica donde reside el recurso string (obligatorio)
Etiquetas Etiquetas de recursos. Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
amable Indica el tipo de regla de consulta programada. El valor predeterminado es LogAlert. 'LogAlert'
'LogToMetric'
Propiedades Las propiedades de regla del recurso. ScheduledQueryRuleProperties (obligatorio)

ScheduledQueryRuleProperties

Nombre Descripción Valor
Acciones Acciones que se invocarán cuando se active la alerta. acciones de
autoMitigate Marca que indica si la alerta se debe resolver automáticamente o no. El valor predeterminado es true. Solo es relevante para las reglas del tipo LogAlert. Bool
checkWorkspaceAlertsStorageConfigured Marca que indica si esta regla de consulta programada debe almacenarse en el almacenamiento del cliente. El valor predeterminado es false. Solo es relevante para las reglas del tipo LogAlert. Bool
criterios Criterios de regla que definen las condiciones de la regla de consulta programada. ScheduledQueryRuleCriteria
descripción Descripción de la regla de consulta programada. cuerda
displayName Nombre para mostrar de la regla de alertas cuerda
Habilitado Marca que indica si esta regla de consulta programada está habilitada. El valor debe ser true o false Bool
evaluationFrequency Frecuencia con la que se evalúa la regla de consulta programada representada en formato de duración ISO 8601. Relevante y necesario solo para las reglas del tipo LogAlert. cuerda
muteActionsDuration Silenciar acciones durante el período de tiempo elegido (en formato de duración ISO 8601) después de activar la alerta. Solo es relevante para las reglas del tipo LogAlert. cuerda
overrideQueryTimeRange Si se especifica, invalida el intervalo de tiempo de consulta (el valor predeterminado es WindowSize*NumberOfEvaluationPeriods). Solo es relevante para las reglas del tipo LogAlert. cuerda
Ámbitos La lista de identificadores de recurso a la que se limita esta regla de consulta programada. string[]
severidad Gravedad de la alerta. Debe ser un entero entre [0-4]. El valor de 0 es más grave. Relevante y necesario solo para las reglas del tipo LogAlert. Int
skipQueryValidation Marca que indica si se debe validar o no la consulta proporcionada. El valor predeterminado es false. Solo es relevante para las reglas del tipo LogAlert. Bool
targetResourceTypes Lista del tipo de recurso de los recursos de destino en los que se crea o actualiza la alerta. Por ejemplo, si el ámbito es un grupo de recursos y targetResourceTypes es Microsoft.Compute/virtualMachines, se activará una alerta diferente para cada máquina virtual del grupo de recursos que cumpla los criterios de alerta. Relevante solo para las reglas del tipo LogAlert string[]
windowSize Período de tiempo (en formato de duración ISO 8601) en el que se ejecutará la consulta de alerta (tamaño de intervalo). Relevante y necesario solo para las reglas del tipo LogAlert. cuerda

Acciones

Nombre Descripción Valor
actionGroups Identificadores de recurso del grupo de acciones que se invocarán cuando se active la alerta. string[]
customProperties Propiedades de una carga de alerta. ActionsCustomProperties

ActionsCustomProperties

Nombre Descripción Valor
{propiedad personalizada} cuerda

ScheduledQueryRuleCriteria

Nombre Descripción Valor
allOf Lista de condiciones que se van a evaluar con respecto a los ámbitos especificados condición[]

Condición

Nombre Descripción Valor
Dimensiones Lista de condiciones de dimensiones dimensión[]
errorPeriods Número mínimo de infracciones necesarias en el período de tiempo de búsqueda seleccionado necesario para generar una alerta. Solo es relevante para las reglas del tipo LogAlert. conditionFailingPeriods
metricMeasureColumn Columna que contiene el número de medida de métrica. Solo es relevante para las reglas del tipo LogAlert. cuerda
metricName Nombre de la métrica que se va a enviar. Relevante y necesario solo para las reglas del tipo LogToMetric. cuerda
operador Operador criteria. Relevante y necesario solo para las reglas del tipo LogAlert. 'Equals'
'GreaterThan'
'GreaterThanOrEqual'
'LessThan'
'LessThanOrEqual'
consulta Alerta de consulta de registro cuerda
resourceIdColumn Columna que contiene el identificador del recurso. El contenido de la columna debe tener el formato URI como identificador de recurso. Solo es relevante para las reglas del tipo LogAlert. cuerda
umbral el valor de umbral de criterios que activa la alerta. Relevante y necesario solo para las reglas del tipo LogAlert. Int
timeAggregation Tipo de agregación. Relevante y necesario solo para las reglas del tipo LogAlert. 'Average'
'Count'
'Máximo'
"Mínimo"
'Total'

Dimensión

Nombre Descripción Valor
nombre Nombre de la dimensión string (obligatorio)
operador Operador para valores de dimensión 'Exclude'
'Include' (obligatorio)
valores Lista de valores de dimensión string[] (obligatorio)

ConditionFailingPeriods

Nombre Descripción Valor
minFailingPeriodsToAlert Número de infracciones para desencadenar una alerta. Debe ser menor o igual que numberOfEvaluationPeriods. El valor predeterminado es 1 Int
numberOfEvaluationPeriods Número de puntos de búsqueda agregados. El período de tiempo de búsqueda se calcula en función de la granularidad de agregación (windowSize) y del número seleccionado de puntos agregados. El valor predeterminado es 1 Int

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla Descripción
Creación de una regla de alertas para los elementos de continuidad empresarial de Azure

Implementación en Azure
Estas plantillas crean una regla de alertas y una MSI asignada por el usuario. También asigna el acceso del lector MSI a la suscripción para que la regla de alertas tenga acceso a consultar los elementos protegidos necesarios y los detalles más recientes del punto de recuperación.

Definición de recursos de plantilla de ARM

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 la implementación de soluciones de supervisión, consulte Creación de recursos de supervisión mediante Bicep.

Formato de recurso

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

{
  "type": "Microsoft.Insights/scheduledQueryRules",
  "apiVersion": "2022-06-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "properties": {
    "actions": {
      "actionGroups": [ "string" ],
      "customProperties": {
        "{customized property}": "string"
      }
    },
    "autoMitigate": "bool",
    "checkWorkspaceAlertsStorageConfigured": "bool",
    "criteria": {
      "allOf": [
        {
          "dimensions": [
            {
              "name": "string",
              "operator": "string",
              "values": [ "string" ]
            }
          ],
          "failingPeriods": {
            "minFailingPeriodsToAlert": "int",
            "numberOfEvaluationPeriods": "int"
          },
          "metricMeasureColumn": "string",
          "metricName": "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",
    "skipQueryValidation": "bool",
    "targetResourceTypes": [ "string" ],
    "windowSize": "string"
  }
}

Valores de propiedad

scheduledQueryRules

Nombre Descripción Valor
tipo El tipo de recurso "Microsoft.Insights/scheduledQueryRules"
apiVersion La versión de la API de recursos '2022-06-15'
nombre El nombre del recurso string (obligatorio)

Límite de caracteres: 1-260

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

No puede terminar con espacio o punto.
ubicación Ubicación geográfica donde reside el recurso string (obligatorio)
Etiquetas Etiquetas de recursos. Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
amable Indica el tipo de regla de consulta programada. El valor predeterminado es LogAlert. 'LogAlert'
'LogToMetric'
Propiedades Las propiedades de regla del recurso. ScheduledQueryRuleProperties (obligatorio)

ScheduledQueryRuleProperties

Nombre Descripción Valor
Acciones Acciones que se invocarán cuando se active la alerta. acciones de
autoMitigate Marca que indica si la alerta se debe resolver automáticamente o no. El valor predeterminado es true. Solo es relevante para las reglas del tipo LogAlert. Bool
checkWorkspaceAlertsStorageConfigured Marca que indica si esta regla de consulta programada debe almacenarse en el almacenamiento del cliente. El valor predeterminado es false. Solo es relevante para las reglas del tipo LogAlert. Bool
criterios Criterios de regla que definen las condiciones de la regla de consulta programada. ScheduledQueryRuleCriteria
descripción Descripción de la regla de consulta programada. cuerda
displayName Nombre para mostrar de la regla de alertas cuerda
Habilitado Marca que indica si esta regla de consulta programada está habilitada. El valor debe ser true o false Bool
evaluationFrequency Frecuencia con la que se evalúa la regla de consulta programada representada en formato de duración ISO 8601. Relevante y necesario solo para las reglas del tipo LogAlert. cuerda
muteActionsDuration Silenciar acciones durante el período de tiempo elegido (en formato de duración ISO 8601) después de activar la alerta. Solo es relevante para las reglas del tipo LogAlert. cuerda
overrideQueryTimeRange Si se especifica, invalida el intervalo de tiempo de consulta (el valor predeterminado es WindowSize*NumberOfEvaluationPeriods). Solo es relevante para las reglas del tipo LogAlert. cuerda
Ámbitos La lista de identificadores de recurso a la que se limita esta regla de consulta programada. string[]
severidad Gravedad de la alerta. Debe ser un entero entre [0-4]. El valor de 0 es más grave. Relevante y necesario solo para las reglas del tipo LogAlert. Int
skipQueryValidation Marca que indica si se debe validar o no la consulta proporcionada. El valor predeterminado es false. Solo es relevante para las reglas del tipo LogAlert. Bool
targetResourceTypes Lista del tipo de recurso de los recursos de destino en los que se crea o actualiza la alerta. Por ejemplo, si el ámbito es un grupo de recursos y targetResourceTypes es Microsoft.Compute/virtualMachines, se activará una alerta diferente para cada máquina virtual del grupo de recursos que cumpla los criterios de alerta. Relevante solo para las reglas del tipo LogAlert string[]
windowSize Período de tiempo (en formato de duración ISO 8601) en el que se ejecutará la consulta de alerta (tamaño de intervalo). Relevante y necesario solo para las reglas del tipo LogAlert. cuerda

Acciones

Nombre Descripción Valor
actionGroups Identificadores de recurso del grupo de acciones que se invocarán cuando se active la alerta. string[]
customProperties Propiedades de una carga de alerta. ActionsCustomProperties

ActionsCustomProperties

Nombre Descripción Valor
{propiedad personalizada} cuerda

ScheduledQueryRuleCriteria

Nombre Descripción Valor
allOf Lista de condiciones que se van a evaluar con respecto a los ámbitos especificados condición[]

Condición

Nombre Descripción Valor
Dimensiones Lista de condiciones de dimensiones dimensión[]
errorPeriods Número mínimo de infracciones necesarias en el período de tiempo de búsqueda seleccionado necesario para generar una alerta. Solo es relevante para las reglas del tipo LogAlert. conditionFailingPeriods
metricMeasureColumn Columna que contiene el número de medida de métrica. Solo es relevante para las reglas del tipo LogAlert. cuerda
metricName Nombre de la métrica que se va a enviar. Relevante y necesario solo para las reglas del tipo LogToMetric. cuerda
operador Operador criteria. Relevante y necesario solo para las reglas del tipo LogAlert. 'Equals'
'GreaterThan'
'GreaterThanOrEqual'
'LessThan'
'LessThanOrEqual'
consulta Alerta de consulta de registro cuerda
resourceIdColumn Columna que contiene el identificador del recurso. El contenido de la columna debe tener el formato URI como identificador de recurso. Solo es relevante para las reglas del tipo LogAlert. cuerda
umbral el valor de umbral de criterios que activa la alerta. Relevante y necesario solo para las reglas del tipo LogAlert. Int
timeAggregation Tipo de agregación. Relevante y necesario solo para las reglas del tipo LogAlert. 'Average'
'Count'
'Máximo'
"Mínimo"
'Total'

Dimensión

Nombre Descripción Valor
nombre Nombre de la dimensión string (obligatorio)
operador Operador para valores de dimensión 'Exclude'
'Include' (obligatorio)
valores Lista de valores de dimensión string[] (obligatorio)

ConditionFailingPeriods

Nombre Descripción Valor
minFailingPeriodsToAlert Número de infracciones para desencadenar una alerta. Debe ser menor o igual que numberOfEvaluationPeriods. El valor predeterminado es 1 Int
numberOfEvaluationPeriods Número de puntos de búsqueda agregados. El período de tiempo de búsqueda se calcula en función de la granularidad de agregación (windowSize) y del número seleccionado de puntos agregados. El valor predeterminado es 1 Int

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla Descripción
Creación de una regla de alertas para los elementos de continuidad empresarial de Azure

Implementación en Azure
Estas plantillas crean una regla de alertas y una MSI asignada por el usuario. También asigna el acceso del lector MSI a la suscripción para que la regla de alertas tenga acceso a consultar los elementos protegidos necesarios y los detalles más recientes del punto de recuperación.

Definición de recursos de Terraform (proveedor AzAPI)

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

  • grupos de recursos de

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

Formato de recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/scheduledQueryRules@2022-06-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      actions = {
        actionGroups = [
          "string"
        ]
        customProperties = {
          {customized property} = "string"
        }
      }
      autoMitigate = bool
      checkWorkspaceAlertsStorageConfigured = bool
      criteria = {
        allOf = [
          {
            dimensions = [
              {
                name = "string"
                operator = "string"
                values = [
                  "string"
                ]
              }
            ]
            failingPeriods = {
              minFailingPeriodsToAlert = int
              numberOfEvaluationPeriods = int
            }
            metricMeasureColumn = "string"
            metricName = "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
      skipQueryValidation = bool
      targetResourceTypes = [
        "string"
      ]
      windowSize = "string"
    }
    kind = "string"
  })
}

Valores de propiedad

scheduledQueryRules

Nombre Descripción Valor
tipo El tipo de recurso "Microsoft.Insights/scheduledQueryRules@2022-06-15"
nombre El nombre del recurso string (obligatorio)

Límite de caracteres: 1-260

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

No puede terminar con espacio o punto.
ubicación Ubicación geográfica donde reside el recurso 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 de recursos. Diccionario de nombres y valores de etiqueta.
amable Indica el tipo de regla de consulta programada. El valor predeterminado es LogAlert. "LogAlert"
"LogToMetric"
Propiedades Las propiedades de regla del recurso. ScheduledQueryRuleProperties (obligatorio)

ScheduledQueryRuleProperties

Nombre Descripción Valor
Acciones Acciones que se invocarán cuando se active la alerta. acciones de
autoMitigate Marca que indica si la alerta se debe resolver automáticamente o no. El valor predeterminado es true. Solo es relevante para las reglas del tipo LogAlert. Bool
checkWorkspaceAlertsStorageConfigured Marca que indica si esta regla de consulta programada debe almacenarse en el almacenamiento del cliente. El valor predeterminado es false. Solo es relevante para las reglas del tipo LogAlert. Bool
criterios Criterios de regla que definen las condiciones de la regla de consulta programada. ScheduledQueryRuleCriteria
descripción Descripción de la regla de consulta programada. cuerda
displayName Nombre para mostrar de la regla de alertas cuerda
Habilitado Marca que indica si esta regla de consulta programada está habilitada. El valor debe ser true o false Bool
evaluationFrequency Frecuencia con la que se evalúa la regla de consulta programada representada en formato de duración ISO 8601. Relevante y necesario solo para las reglas del tipo LogAlert. cuerda
muteActionsDuration Silenciar acciones durante el período de tiempo elegido (en formato de duración ISO 8601) después de activar la alerta. Solo es relevante para las reglas del tipo LogAlert. cuerda
overrideQueryTimeRange Si se especifica, invalida el intervalo de tiempo de consulta (el valor predeterminado es WindowSize*NumberOfEvaluationPeriods). Solo es relevante para las reglas del tipo LogAlert. cuerda
Ámbitos La lista de identificadores de recurso a la que se limita esta regla de consulta programada. string[]
severidad Gravedad de la alerta. Debe ser un entero entre [0-4]. El valor de 0 es más grave. Relevante y necesario solo para las reglas del tipo LogAlert. Int
skipQueryValidation Marca que indica si se debe validar o no la consulta proporcionada. El valor predeterminado es false. Solo es relevante para las reglas del tipo LogAlert. Bool
targetResourceTypes Lista del tipo de recurso de los recursos de destino en los que se crea o actualiza la alerta. Por ejemplo, si el ámbito es un grupo de recursos y targetResourceTypes es Microsoft.Compute/virtualMachines, se activará una alerta diferente para cada máquina virtual del grupo de recursos que cumpla los criterios de alerta. Relevante solo para las reglas del tipo LogAlert string[]
windowSize Período de tiempo (en formato de duración ISO 8601) en el que se ejecutará la consulta de alerta (tamaño de intervalo). Relevante y necesario solo para las reglas del tipo LogAlert. cuerda

Acciones

Nombre Descripción Valor
actionGroups Identificadores de recurso del grupo de acciones que se invocarán cuando se active la alerta. string[]
customProperties Propiedades de una carga de alerta. ActionsCustomProperties

ActionsCustomProperties

Nombre Descripción Valor
{propiedad personalizada} cuerda

ScheduledQueryRuleCriteria

Nombre Descripción Valor
allOf Lista de condiciones que se van a evaluar con respecto a los ámbitos especificados condición[]

Condición

Nombre Descripción Valor
Dimensiones Lista de condiciones de dimensiones dimensión[]
errorPeriods Número mínimo de infracciones necesarias en el período de tiempo de búsqueda seleccionado necesario para generar una alerta. Solo es relevante para las reglas del tipo LogAlert. conditionFailingPeriods
metricMeasureColumn Columna que contiene el número de medida de métrica. Solo es relevante para las reglas del tipo LogAlert. cuerda
metricName Nombre de la métrica que se va a enviar. Relevante y necesario solo para las reglas del tipo LogToMetric. cuerda
operador Operador criteria. Relevante y necesario solo para las reglas del tipo LogAlert. "Iguales"
"GreaterThan"
"GreaterThanOrEqual"
"LessThan"
"LessThanOrEqual"
consulta Alerta de consulta de registro cuerda
resourceIdColumn Columna que contiene el identificador del recurso. El contenido de la columna debe tener el formato URI como identificador de recurso. Solo es relevante para las reglas del tipo LogAlert. cuerda
umbral el valor de umbral de criterios que activa la alerta. Relevante y necesario solo para las reglas del tipo LogAlert. Int
timeAggregation Tipo de agregación. Relevante y necesario solo para las reglas del tipo LogAlert. "Promedio"
"Count"
"Máximo"
"Mínimo"
"Total"

Dimensión

Nombre Descripción Valor
nombre Nombre de la dimensión string (obligatorio)
operador Operador para valores de dimensión "Excluir"
"Include" (obligatorio)
valores Lista de valores de dimensión string[] (obligatorio)

ConditionFailingPeriods

Nombre Descripción Valor
minFailingPeriodsToAlert Número de infracciones para desencadenar una alerta. Debe ser menor o igual que numberOfEvaluationPeriods. El valor predeterminado es 1 Int
numberOfEvaluationPeriods Número de puntos de búsqueda agregados. El período de tiempo de búsqueda se calcula en función de la granularidad de agregación (windowSize) y del número seleccionado de puntos agregados. El valor predeterminado es 1 Int