Scheduled Query Rules - Get

Referencia

Servicio:: Monitor

Versión de la API:: 2021-08-01

Recuperar una definición de regla de consulta programada.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}?api-version=2021-08-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
ruleName	path	True	string	Nombre de la regla.
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	ScheduledQueryRuleResource	Solicitud correcta para obtener una regla de consulta programada
Other Status Codes	ErrorContract	BadRequest

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Get a scheduled query rule for single resource

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourceGroups/QueryResourceGroupName/providers/Microsoft.Insights/scheduledQueryRules/perf?api-version=2021-08-01

Respuesta de muestra

status code:: 200

{
  "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf",
  "name": "perf",
  "type": "microsoft.insights/scheduledqueryrules",
  "location": "eastus",
  "tags": {},
  "properties": {
    "description": "Performance rule",
    "severity": 4,
    "enabled": true,
    "evaluationFrequency": "PT5M",
    "scopes": [
      "/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1/providers/Microsoft.Compute/virtualMachines/vm1"
    ],
    "windowSize": "PT10M",
    "criteria": {
      "allOf": [
        {
          "query": "Perf | where ObjectName == \"Processor\"",
          "timeAggregation": "Average",
          "metricMeasureColumn": "% Processor Time",
          "resourceIdColumn": "resourceId",
          "dimensions": [
            {
              "name": "ComputerIp",
              "operator": "Exclude",
              "values": [
                "192.168.1.1"
              ]
            },
            {
              "name": "OSType",
              "operator": "Include",
              "values": [
                "*"
              ]
            }
          ],
          "operator": "GreaterThan",
          "threshold": 70,
          "failingPeriods": {
            "numberOfEvaluationPeriods": 1,
            "minFailingPeriodsToAlert": 1
          }
        }
      ]
    },
    "muteActionsDuration": "PT30M",
    "actions": {
      "actionGroups": [
        "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
      ],
      "customProperties": {
        "key11": "value11",
        "key12": "value12"
      }
    },
    "autoMitigate": true,
    "isWorkspaceAlertsStorageConfigured": true,
    "checkWorkspaceAlertsStorageConfigured": true,
    "skipQueryValidation": true
  }
}

Definiciones

Nombre	Description
Actions	Acciones que se invocarán cuando se active la alerta.
AlertSeverity	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.
Condition	Condición de la regla de consulta programada.
conditionOperator	Operador criteria. Relevante y necesario solo para las reglas del tipo LogAlert.
createdByType	Tipo de identidad que creó el recurso.
Dimension	División de dimensiones y definición de filtrado
dimensionOperator	Operador para valores de dimensión
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorContract	Describe el formato de respuesta de error.
ErrorResponse	Respuesta de error
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. Solo es relevante para las reglas del tipo LogAlert.
Kind	Indica el tipo de regla de consulta programada. El valor predeterminado es LogAlert.
ScheduledQueryRuleCriteria	Criterios de regla que definen las condiciones de la regla de consulta programada.
ScheduledQueryRuleResource	Recurso de regla de consulta programada.
systemData	Metadatos relacionados con la creación y la última modificación del recurso.
timeAggregation	Tipo de agregación. Relevante y necesario solo para las reglas del tipo LogAlert.

Actions

Acciones que se invocarán cuando se active la alerta.

Nombre	Tipo	Description
actionGroups	string[]	Identificadores de recurso del grupo de acciones que se invocarán cuando se active la alerta.
customProperties	object	Las propiedades de una carga de alerta.

AlertSeverity

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.

Nombre	Tipo	Description
0	Integer
1	Integer
2	Integer
3	Integer
4	Integer

Condition

Condición de la regla de consulta programada.

Nombre	Tipo	Description
dimensions	Dimension[]	Lista de condiciones de dimensiones
failingPeriods	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. Solo es relevante para las reglas del tipo LogAlert.
metricMeasureColumn	string	Columna que contiene el número de medida de métrica. Solo es relevante para las reglas del tipo LogAlert.
metricName	string	Nombre de la métrica que se va a enviar. Relevante y solo es necesario para las reglas del tipo LogToMetric.
operator	conditionOperator	Operador criteria. Relevante y necesario solo para las reglas del tipo LogAlert.
query	string	Alerta de consulta de registro
resourceIdColumn	string	Columna que contiene el identificador de recurso. El contenido de la columna debe tener el formato URI como identificador de recurso. Solo es relevante para las reglas del tipo LogAlert.
threshold	number	el valor de umbral de criterios que activa la alerta. Relevante y necesario solo para las reglas del tipo LogAlert.
timeAggregation	timeAggregation	Tipo de agregación. Relevante y necesario solo para las reglas del tipo LogAlert.

conditionOperator

Operador criteria. Relevante y necesario solo para las reglas del tipo LogAlert.

Nombre	Tipo	Description
Equals	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Dimension

División de dimensiones y definición de filtrado

Nombre	Tipo	Description
name	string	Nombre de la dimensión
operator	dimensionOperator	Operador para valores de dimensión
values	string[]	Lista de valores de dimensión

dimensionOperator

Operador para valores de dimensión

Nombre	Tipo	Description
Exclude	string
Include	string

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorContract

Describe el formato de respuesta de error.

Nombre	Tipo	Description
error	ErrorResponse	Respuesta de error Los detalles del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorResponse[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

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. Solo es relevante para las reglas del tipo LogAlert.

Nombre	Tipo	Valor predeterminado	Description
minFailingPeriodsToAlert	integer	1	Número de infracciones para desencadenar una alerta. Debe ser menor o igual que numberOfEvaluationPeriods. El valor predeterminado es 1.
numberOfEvaluationPeriods	integer	1	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 el número seleccionado de puntos agregados. El valor predeterminado es 1.

Kind

Indica el tipo de regla de consulta programada. El valor predeterminado es LogAlert.

Nombre	Tipo	Description
LogAlert	string
LogToMetric	string

ScheduledQueryRuleCriteria

Criterios de regla que definen las condiciones de la regla de consulta programada.

Nombre	Tipo	Description
allOf	Condition[]	Lista de condiciones que se van a evaluar con respecto a los ámbitos especificados

ScheduledQueryRuleResource

Recurso de regla de consulta programada.

Nombre	Tipo	Description
etag	string	El campo etag no es obligatorio. Si se proporciona en el cuerpo de la respuesta, también debe proporcionarse como encabezado según la convención de etag normal. Las etiquetas de entidad se usan para comparar dos o más entidades del mismo recurso solicitado. HTTP/1.1 usa etiquetas de entidad en etag (sección 14.19), If-Match (sección 14.24), If-None-Match (sección 14.26) y If-Range (sección 14.27) campos de encabezado.
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	Kind	Indica el tipo de regla de consulta programada. El valor predeterminado es LogAlert.
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso.
properties.actions	Actions	Acciones que se invocarán cuando se active la alerta.
properties.autoMitigate	boolean	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.
properties.checkWorkspaceAlertsStorageConfigured	boolean	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.
properties.createdWithApiVersion	string	La versión de api usada al crear esta regla de alertas
properties.criteria	ScheduledQueryRuleCriteria	Criterios de regla que definen las condiciones de la regla de consulta programada.
properties.description	string	Descripción de la regla de consulta programada.
properties.displayName	string	Nombre para mostrar de la regla de alertas
properties.enabled	boolean	Marca que indica si esta regla de consulta programada está habilitada. El valor debe ser true o false
properties.evaluationFrequency	string	Frecuencia con la que se evalúa la regla de consulta programada en formato de duración ISO 8601. Relevante y necesario solo para las reglas del tipo LogAlert.
properties.isLegacyLogAnalyticsRule	boolean	True si la regla de alertas es una regla de Log Analytics heredada
properties.isWorkspaceAlertsStorageConfigured	boolean	Marca que indica si esta regla de consulta programada se ha configurado para almacenarse en el almacenamiento del cliente. El valor predeterminado es false.
properties.muteActionsDuration	string	Silenciar acciones durante el período de tiempo elegido (en formato de duración ISO 8601) después de que se desencadene la alerta. Solo es relevante para las reglas del tipo LogAlert.
properties.overrideQueryTimeRange	string	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.
properties.scopes	string[]	La lista de identificadores de recurso a la que se limita esta regla de consulta programada.
properties.severity	AlertSeverity	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.
properties.skipQueryValidation	boolean	Marca que indica si la consulta proporcionada se debe validar o no. El valor predeterminado es false. Solo es relevante para las reglas del tipo LogAlert.
properties.targetResourceTypes	string[]	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. Solo es relevante para las reglas del tipo LogAlert.
properties.windowSize	string	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.
systemData	systemData	SystemData de ScheduledQueryRule.
tags	object	Etiquetas del recurso.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

timeAggregation

Tipo de agregación. Relevante y necesario solo para las reglas del tipo LogAlert.

Nombre	Tipo	Description
Average	string
Count	string
Maximum	string
Minimum	string
Total	string

Compartir a través de