Microsoft.Insights scheduledQueryRules 2020-05-01-preview

Artículo
09/19/2023

Definición de recursos de Bicep

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

Grupos de recursos: consulte los comandos de implementación del grupo de recursos.

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@2020-05-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    actions: [
      {
        actionGroupId: 'string'
        webHookProperties: {}
      }
    ]
    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 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 geográfica donde reside el recurso	string (obligatorio)
etiquetas	Etiquetas del recurso.	Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
properties	Las propiedades de regla del recurso.	ScheduledQueryRuleProperties (obligatorio)

ScheduledQueryRuleProperties

Nombre	Descripción	Valor
actions		Acción[]
criterios	Criterios de regla que definen las condiciones de la regla de consulta programada.	ScheduledQueryRuleCriteria
description	Descripción de la regla de consulta programada.	string
DisplayName	Nombre para mostrar de la regla de alertas	string
enabled	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 en formato de duración ISO 8601.	string
muteActionsDuration	Silenciar acciones durante el período de tiempo elegido (en formato de duración ISO 8601) después de que se desencadene la alerta.	string
overrideQueryTimeRange	Si se especifica, invalida el intervalo de tiempo de consulta (el valor predeterminado es WindowSize*NumberOfEvaluationPeriods).	string
ámbitos	La lista de identificadores de recurso a la que se limita esta regla de consulta programada.	string[]
severity	Gravedad de la alerta. Debe ser un entero entre [0-4]. El valor de 0 es más grave	int
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.	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).	string

Acción

Nombre	Descripción	Valor
actionGroupId	Id. de recurso del grupo de acciones que se invocará cuando se active la alerta.	string
webHookProperties	Propiedades de un objeto de webhook.	object

ScheduledQueryRuleCriteria

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

Condición

Nombre	Descripción	Valor
dimensions	Lista de condiciones de dimensiones	Dimensión[]
failingPeriods	Número mínimo de infracciones necesarias en la ventana de tiempo de búsqueda seleccionada necesaria para generar una alerta.	ConditionFailingPeriods
metricMeasureColumn	Columna que contiene el número de medida de métrica.	string
operator	Operador criteria.	'Equals' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' (obligatorio)
Query	Alerta de consulta de registro	string
resourceIdColumn	Columna que contiene el identificador de recurso. El contenido de la columna debe tener el formato URI como identificador de recurso.	string
threshold	el valor de umbral de criterios que activa la alerta.	int (obligatorio)
timeAggregation	Tipo de agregación	'Average' 'Count' 'Maximum' "Mínimo" 'Total' (obligatorio)

Dimensión

Nombre	Descripción	Value
name	Nombre de la dimensión	string (obligatorio)
operator	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. La ventana 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

Definición de recursos de plantilla de ARM

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

Grupos de recursos: consulte los comandos de implementación del grupo de recursos.

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": "2020-05-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "actions": [
      {
        "actionGroupId": "string",
        "webHookProperties": {}
      }
    ],
    "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 propiedad

scheduledQueryRules

Nombre	Descripción	Value
type	Tipo de recurso	'Microsoft.Insights/scheduledQueryRules'
apiVersion	La versión de la API de recursos	"2020-05-01-preview"
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 geográfica donde reside el recurso	string (obligatorio)
etiquetas	Etiquetas del recurso.	Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
properties	Las propiedades de regla del recurso.	ScheduledQueryRuleProperties (obligatorio)

ScheduledQueryRuleProperties

Nombre	Descripción	Valor
actions		Acción[]
criterios	Criterios de regla que definen las condiciones de la regla de consulta programada.	ScheduledQueryRuleCriteria
description	Descripción de la regla de consulta programada.	string
DisplayName	Nombre para mostrar de la regla de alertas	string
enabled	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 en formato de duración ISO 8601.	string
muteActionsDuration	Silenciar acciones durante el período de tiempo elegido (en formato de duración ISO 8601) después de que se desencadene la alerta.	string
overrideQueryTimeRange	Si se especifica, invalida el intervalo de tiempo de consulta (el valor predeterminado es WindowSize*NumberOfEvaluationPeriods).	string
ámbitos	La lista de identificadores de recurso a la que se limita esta regla de consulta programada.	string[]
severity	Gravedad de la alerta. Debe ser un entero entre [0-4]. El valor de 0 es más grave	int
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.	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).	string

Acción

Nombre	Descripción	Valor
actionGroupId	Id. de recurso del grupo de acciones que se invocará cuando se active la alerta.	string
webHookProperties	Propiedades de un objeto de webhook.	object

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
dimensions	Lista de condiciones de dimensiones	Dimensión[]
failingPeriods	El número mínimo de infracciones necesarias en la ventana de tiempo de devolución de búsqueda seleccionada necesaria para generar una alerta.	ConditionFailingPeriods
metricMeasureColumn	Columna que contiene el número de medida de métrica.	string
operator	Operador criteria.	'Equals' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' (obligatorio)
Query	Alerta de consulta de registro	string
resourceIdColumn	Columna que contiene el identificador de recurso. El contenido de la columna debe tener el formato URI como identificador de recurso.	string
threshold	el valor de umbral de criterios que activa la alerta.	int (obligatorio)
timeAggregation	Tipo de agregación	'Average' 'Count' 'Maximum' 'Mínimo' 'Total' (obligatorio)

Dimensión

Nombre	Descripción	Value
name	Nombre de la dimensión	string (obligatorio)
operator	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. La ventana 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

Definición de recursos de Terraform (proveedor AzAPI)

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

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@2020-05-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      actions = [
        {
          actionGroupId = "string"
          webHookProperties = {}
        }
      ]
      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 propiedad

scheduledQueryRules

Nombre	Descripción	Value
type	Tipo de recurso	"Microsoft.Insights/scheduledQueryRules@2020-05-01-preview"
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 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 del recurso.	Diccionario de nombres y valores de etiqueta.
properties	Las propiedades de regla del recurso.	ScheduledQueryRuleProperties (obligatorio)

ScheduledQueryRuleProperties

Nombre	Descripción	Valor
actions		Acción[]
criterios	Criterios de regla que definen las condiciones de la regla de consulta programada.	ScheduledQueryRuleCriteria
description	Descripción de la regla de consulta programada.	string
DisplayName	Nombre para mostrar de la regla de alertas	string
enabled	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.	string
muteActionsDuration	Silenciar acciones durante el período de tiempo elegido (en formato de duración ISO 8601) después de que se desencadene la alerta.	string
overrideQueryTimeRange	Si se especifica, invalida el intervalo de tiempo de consulta (el valor predeterminado es WindowSize*NumberOfEvaluationPeriods)	string
ámbitos	La lista de identificadores de recurso a la que se limita esta regla de consulta programada.	string[]
severity	Gravedad de la alerta. Debe ser un entero entre [0-4]. El valor de 0 es más grave	int
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 desencadenará una alerta diferente para cada máquina virtual del grupo de recursos que cumpla los criterios de alerta.	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).	string

Acción

Nombre	Descripción	Valor
actionGroupId	Id. de recurso del grupo de acciones que se invocará cuando se active la alerta.	string
webHookProperties	Propiedades de un objeto de webhook.	object

ScheduledQueryRuleCriteria

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

Condición

Nombre	Descripción	Valor
dimensions	Lista de condiciones de dimensiones	Dimensión[]
failingPeriods	Número mínimo de infracciones necesarias en la ventana de tiempo de búsqueda seleccionada necesaria para generar una alerta.	ConditionFailingPeriods
metricMeasureColumn	Columna que contiene el número de medida de métrica.	string
operator	Operador criteria.	"Equals" "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" (obligatorio)
Query	Alerta de consulta de registro	string
resourceIdColumn	Columna que contiene el identificador de recurso. El contenido de la columna debe tener el formato URI como identificador de recurso.	string
threshold	el valor de umbral de criterios que activa la alerta.	int (obligatorio)
timeAggregation	Tipo de agregación	"Promedio" "Recuento" "Máximo" "Mínimo" "Total" (obligatorio)

Dimensión

Nombre	Descripción	Value
name	Nombre de la dimensión	string (obligatorio)
operator	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. La ventana 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

Share via

Microsoft.Insights scheduledQueryRules 2020-05-01-preview

Definición de recursos de Bicep

Observaciones

Formato de los recursos

Valores de propiedad

scheduledQueryRules

ScheduledQueryRuleProperties

Acción

ScheduledQueryRuleCriteria

Condición

Dimensión

ConditionFailingPeriods

Definición de recursos de plantilla de ARM

Observaciones

Formato de los recursos

Valores de propiedad

scheduledQueryRules

ScheduledQueryRuleProperties

Acción

ScheduledQueryRuleCriteria

Condición

Dimensión

ConditionFailingPeriods

Definición de recursos de Terraform (proveedor AzAPI)

Formato de los recursos

Valores de propiedad

scheduledQueryRules

ScheduledQueryRuleProperties

Acción

ScheduledQueryRuleCriteria

Condición

Dimensión

ConditionFailingPeriods

Comentarios

Comentarios

Recursos adicionales