Microsoft.Insights scheduledQueryRules 2020-05-01-preview

Artículo
12/21/2024

Observaciones

Para obtener instrucciones sobre la implementación de soluciones de supervisión, consulte Creación de recursos de supervisión mediante Bicep.

Definición de recursos de Bicep

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

grupos de recursos: consulte comandos de implementación de grupos de recursos

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 lo siguiente a la plantilla de Bicep.

resource symbolicname 'Microsoft.Insights/scheduledQueryRules@2020-05-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    actions: [
      {
        actionGroupId: 'string'
        webHookProperties: {
          {customized property}: 'string'
        }
      }
    ]
    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'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propiedad

Acción

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

ActionWebHookProperties

Nombre	Descripción	Valor

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.	conditionFailingPeriods
metricMeasureColumn	Columna que contiene el número de medida de métrica.	cuerda
operador	Operador criteria.	'Equals' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' (obligatorio)
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.	cuerda
umbral	el valor de umbral de criterios que activa la alerta.	int (obligatorio)
timeAggregation	Tipo de agregación	'Average' 'Count' 'Máximo' "Mínimo" 'Total' (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

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)

Microsoft.Insights/scheduledQueryRules

Nombre	Descripción	Valor
ubicación	Ubicación geográfica donde reside el recurso	string (obligatorio)
nombre	El nombre del recurso	cuerda Restricciones: Patrón = `^[^#<>%&:\?/{}*]{1,260}$` (obligatorio)
Propiedades	Las propiedades de regla del recurso.	ScheduledQueryRuleProperties (obligatorio)
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas

ScheduledQueryRuleCriteria

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

ScheduledQueryRuleProperties

Nombre	Descripción	Valor
Acciones		acción de []
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.	cuerda
muteActionsDuration	Silenciar acciones durante el período de tiempo elegido (en formato de duración ISO 8601) después de activar la alerta.	cuerda
overrideQueryTimeRange	Si se especifica, invalida el intervalo de tiempo de consulta (el valor predeterminado es WindowSize*NumberOfEvaluationPeriods)	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	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).	cuerda

TrackedResourceTags

Nombre	Descripción	Valor

Definición de recursos de plantilla de ARM

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

grupos de recursos: consulte comandos de implementación de grupos de recursos

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 JSON a la plantilla.

{
  "type": "Microsoft.Insights/scheduledQueryRules",
  "apiVersion": "2020-05-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "actions": [
      {
        "actionGroupId": "string",
        "webHookProperties": {
          "{customized property}": "string"
        }
      }
    ],
    "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"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propiedad

Acción

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

ActionWebHookProperties

Nombre	Descripción	Valor

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.	conditionFailingPeriods
metricMeasureColumn	Columna que contiene el número de medida de métrica.	cuerda
operador	Operador criteria.	'Equals' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' (obligatorio)
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.	cuerda
umbral	el valor de umbral de criterios que activa la alerta.	int (obligatorio)
timeAggregation	Tipo de agregación	'Average' 'Count' 'Máximo' "Mínimo" 'Total' (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

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)

Microsoft.Insights/scheduledQueryRules

Nombre	Descripción	Valor
apiVersion	La versión de api	'2020-05-01-preview'
ubicación	Ubicación geográfica donde reside el recurso	string (obligatorio)
nombre	El nombre del recurso	cuerda Restricciones: Patrón = `^[^#<>%&:\?/{}*]{1,260}$` (obligatorio)
Propiedades	Las propiedades de regla del recurso.	ScheduledQueryRuleProperties (obligatorio)
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
tipo	El tipo de recurso	"Microsoft.Insights/scheduledQueryRules"

ScheduledQueryRuleCriteria

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

ScheduledQueryRuleProperties

Nombre	Descripción	Valor
Acciones		acción de []
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.	cuerda
muteActionsDuration	Silenciar acciones durante el período de tiempo elegido (en formato de duración ISO 8601) después de activar la alerta.	cuerda
overrideQueryTimeRange	Si se especifica, invalida el intervalo de tiempo de consulta (el valor predeterminado es WindowSize*NumberOfEvaluationPeriods)	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	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).	cuerda

TrackedResourceTags

Nombre	Descripción	Valor

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	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@2020-05-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      actions = [
        {
          actionGroupId = "string"
          webHookProperties = {
            {customized property} = "string"
          }
        }
      ]
      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

Acción

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

ActionWebHookProperties

Nombre	Descripción	Valor

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.	conditionFailingPeriods
metricMeasureColumn	Columna que contiene el número de medida de métrica.	cuerda
operador	Operador criteria.	'Equals' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' (obligatorio)
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.	cuerda
umbral	el valor de umbral de criterios que activa la alerta.	int (obligatorio)
timeAggregation	Tipo de agregación	'Average' 'Count' 'Máximo' "Mínimo" 'Total' (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

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)

Microsoft.Insights/scheduledQueryRules

Nombre	Descripción	Valor
ubicación	Ubicación geográfica donde reside el recurso	string (obligatorio)
nombre	El nombre del recurso	cuerda Restricciones: Patrón = `^[^#<>%&:\?/{}*]{1,260}$` (obligatorio)
Propiedades	Las propiedades de regla del recurso.	ScheduledQueryRuleProperties (obligatorio)
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta.
tipo	El tipo de recurso	"Microsoft.Insights/scheduledQueryRules@2020-05-01-preview"

ScheduledQueryRuleCriteria

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

ScheduledQueryRuleProperties

Nombre	Descripción	Valor
Acciones		acción de []
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.	cuerda
muteActionsDuration	Silenciar acciones durante el período de tiempo elegido (en formato de duración ISO 8601) después de activar la alerta.	cuerda
overrideQueryTimeRange	Si se especifica, invalida el intervalo de tiempo de consulta (el valor predeterminado es WindowSize*NumberOfEvaluationPeriods)	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	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).	cuerda

TrackedResourceTags

Nombre	Descripción	Valor

Compartir a través de

Microsoft.Insights scheduledQueryRules 2020-05-01-preview

Observaciones

Definición de recursos de Bicep

Formato de recurso

Valores de propiedad

Acción

ActionWebHookProperties

Condición

ConditionFailingPeriods

Dimensión

Microsoft.Insights/scheduledQueryRules

ScheduledQueryRuleCriteria

ScheduledQueryRuleProperties

TrackedResourceTags

Definición de recursos de plantilla de ARM

Formato de recurso

Valores de propiedad

Acción

ActionWebHookProperties

Condición

ConditionFailingPeriods

Dimensión

Microsoft.Insights/scheduledQueryRules

ScheduledQueryRuleCriteria

ScheduledQueryRuleProperties

TrackedResourceTags

Plantillas de inicio rápido

Definición de recursos de Terraform (proveedor AzAPI)

Formato de recurso

Valores de propiedad

Acción

ActionWebHookProperties

Condición

ConditionFailingPeriods

Dimensión

Microsoft.Insights/scheduledQueryRules

ScheduledQueryRuleCriteria

ScheduledQueryRuleProperties

TrackedResourceTags

Comentarios

Recursos adicionales