Compartir a través de


Scheduled Query Rules - Get

Obtiene una regla de búsqueda de registros.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}?api-version=2018-04-16

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

LogSearchRuleResource

Solicitud correcta para obtener una regla de búsqueda de registros

Other Status Codes

ErrorContract

Respuesta de error que describe el motivo del error de la operación.

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 rule

Solicitud de ejemplo

GET https://management.azure.com/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourcegroups/Rac46PostSwapRG/providers/Microsoft.Insights/scheduledQueryRules/logalertfoo?api-version=2018-04-16

Respuesta de muestra

{
  "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/scheduledQueryRules/logalertfoo",
  "name": "logalertfoo",
  "type": "Microsoft.Insights/scheduledQueryRules",
  "location": "West US",
  "tags": {},
  "properties": {
    "description": "log alert description",
    "enabled": "true",
    "lastUpdatedTime": "2017-06-23T21:23:52.0221265Z",
    "provisioningState": "Succeeded",
    "source": {
      "query": "requests",
      "queryType": "ResultCount",
      "dataSourceId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/components/sampleAI"
    },
    "schedule": {
      "frequencyInMinutes": 15,
      "timeWindowInMinutes": 15
    },
    "action": {
      "odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction",
      "severity": "1",
      "trigger": {
        "thresholdOperator": "GreaterThan",
        "threshold": 3
      },
      "aznsAction": {
        "actionGroup": [],
        "emailSubject": "Email Header",
        "customWebhookPayload": "{}"
      }
    }
  }
}

Definiciones

Nombre Description
AlertingAction

Especificar la acción debe realizarse cuando el tipo de regla es Alert

AlertSeverity

Nivel de gravedad de la alerta

AzNsActionGroup

Grupo de acciones de Azure

ConditionalOperator

Criterios de evaluación de condición de resultado.

Criteria

Especifica los criterios para convertir el registro en la métrica.

Dimension

Especifica los criterios para convertir el registro en la métrica.

enabled

Marca que indica si la regla de búsqueda de registros está habilitada. El valor debe ser true o false

ErrorContract

Describe el formato de respuesta de error.

ErrorResponse

Describe el formato de respuesta de error.

LogMetricTrigger

Descriptor de desencadenador de métricas de registro.

LogSearchRuleResource

Recurso regla de búsqueda de registros.

LogToMetricAction

Especifique la acción que se debe realizar cuando el tipo de regla convierta el registro en métrica.

metricTriggerType

Tipo de desencadenador de métrica: "Consecutivo" o "Total"

operator

Operador para valores de dimensión

provisioningState

Estado de aprovisionamiento de la regla de consulta programada

QueryType

Establecer el valor en "ResultAccount"

Schedule

Define la frecuencia con la que se ejecuta la búsqueda y el intervalo de tiempo.

Source

Especifica la consulta de búsqueda de registros.

TriggerCondition

Condición que da como resultado la regla de búsqueda de registros.

AlertingAction

Especificar la acción debe realizarse cuando el tipo de regla es Alert

Nombre Tipo Description
aznsAction

AzNsActionGroup

Referencia del grupo de acciones de Azure.

odata.type string:

Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction

Especifica la acción. Valores admitidos: AlertingAction, LogToMetricAction

severity

AlertSeverity

Gravedad de la alerta

throttlingInMin

integer

tiempo (en minutos) para el que las alertas deben limitarse o suprimirse.

trigger

TriggerCondition

Condición del desencadenador que da como resultado que la regla de alerta sea.

AlertSeverity

Nivel de gravedad de la alerta

Nombre Tipo Description
0

string

1

string

2

string

3

string

4

string

AzNsActionGroup

Grupo de acciones de Azure

Nombre Tipo Description
actionGroup

string[]

Referencia del grupo de acciones de Azure.

customWebhookPayload

string

Carga personalizada que se va a enviar para todos los URI de webhook en el grupo de acciones de Azure

emailSubject

string

Invalidación de asunto personalizado para todos los identificadores de correo electrónico en el grupo de acciones de Azure

ConditionalOperator

Criterios de evaluación de condición de resultado.

Nombre Tipo Description
Equal

string

GreaterThan

string

GreaterThanOrEqual

string

LessThan

string

LessThanOrEqual

string

Criteria

Especifica los criterios para convertir el registro en la métrica.

Nombre Tipo Description
dimensions

Dimension[]

Lista de dimensiones para crear la métrica

metricName

string

Nombre de la métrica

Dimension

Especifica los criterios para convertir el registro en la métrica.

Nombre Tipo Description
name

string

Nombre de la dimensión

operator

operator

Operador para valores de dimensión

values

string[]

Lista de valores de dimensión

enabled

Marca que indica si la regla de búsqueda de registros está habilitada. El valor debe ser true o false

Nombre Tipo Description
false

string

true

string

ErrorContract

Describe el formato de respuesta de error.

Nombre Tipo Description
error

ErrorResponse

Los detalles del error.

ErrorResponse

Describe el formato de respuesta de error.

Nombre Tipo Description
code

string

Código de error

message

string

Mensaje de error que indica por qué se produjo un error en la operación.

LogMetricTrigger

Descriptor de desencadenador de métricas de registro.

Nombre Tipo Valor predeterminado Description
metricColumn

string

Evaluación de la métrica en una columna determinada

metricTriggerType

metricTriggerType

Consecutive

Tipo de desencadenador de métrica: "Consecutivo" o "Total"

threshold

number

Umbral del desencadenador de métrica.

thresholdOperator

ConditionalOperator

GreaterThanOrEqual

Operación de evaluación para la métrica -'GreaterThan' o 'LessThan' o 'Equal'.

LogSearchRuleResource

Recurso regla de búsqueda de registros.

Nombre Tipo Valor predeterminado 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 el 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 de Azure

kind

string

Metadatos usados por portal/herramientas/etc para representar diferentes experiencias de experiencia de usuario para los recursos del mismo tipo; Por ejemplo, ApiApps son un tipo de tipo Microsoft.Web/sites. Si se admite, el proveedor de recursos debe validar y conservar este valor.

location

string

Ubicación de los recursos

name

string

Nombre de recurso de Azure

properties.action Action:

Es necesario realizar acciones en la ejecución de reglas.

properties.autoMitigate

boolean

False

Marca que indica si la alerta se debe resolver automáticamente o no. El valor predeterminado es false.

properties.createdWithApiVersion

string

Versión de api usada al crear esta regla de alerta

properties.description

string

Descripción de la regla de búsqueda de registros.

properties.displayName

string

Nombre para mostrar de la regla de alertas

properties.enabled

enabled

Marca que indica si la regla de búsqueda de registros está habilitada. El valor debe ser true o false

properties.isLegacyLogAnalyticsRule

boolean

True si la regla de alertas es una regla heredada de Log Analytics

properties.lastUpdatedTime

string

Última vez que la regla se actualizó en IS08601 formato.

properties.provisioningState

provisioningState

Estado de aprovisionamiento de la regla de consulta programada

properties.schedule

Schedule

Programación (frecuencia, ventana de tiempo) para la regla. Obligatorio para el tipo de acción: AlertingAction

properties.source

Source

Origen de datos en el que la regla consultará datos

tags

object

Etiquetas del recurso

type

string

Tipo de recurso de Azure

LogToMetricAction

Especifique la acción que se debe realizar cuando el tipo de regla convierta el registro en métrica.

Nombre Tipo Description
criteria

Criteria[]

Criterios de métrica

odata.type string:

Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction

Especifica la acción. Valores admitidos: AlertingAction, LogToMetricAction

metricTriggerType

Tipo de desencadenador de métrica: "Consecutivo" o "Total"

Nombre Tipo Description
Consecutive

string

Total

string

operator

Operador para valores de dimensión

Nombre Tipo Description
Include

string

provisioningState

Estado de aprovisionamiento de la regla de consulta programada

Nombre Tipo Description
Canceled

string

Deploying

string

Failed

string

Succeeded

string

QueryType

Establecer el valor en "ResultAccount"

Nombre Tipo Description
ResultCount

string

Schedule

Define la frecuencia con la que se ejecuta la búsqueda y el intervalo de tiempo.

Nombre Tipo Description
frequencyInMinutes

integer

frequency (en minutos) en la que se debe evaluar la condición de regla.

timeWindowInMinutes

integer

Período de tiempo para el que se deben capturar los datos de la consulta (debe ser mayor o igual que frequencyInMinutes).

Source

Especifica la consulta de búsqueda de registros.

Nombre Tipo Description
authorizedResources

string[]

Lista de recursos a los que se hace referencia en la consulta

dataSourceId

string

Identificador URI de recurso sobre el que se va a ejecutar la consulta de búsqueda de registros.

query

string

Consulta de búsqueda de registros. Obligatorio para el tipo de acción: AlertingAction

queryType

QueryType

Establezca el valor en "ResultCount".

TriggerCondition

Condición que da como resultado la regla de búsqueda de registros.

Nombre Tipo Valor predeterminado Description
metricTrigger

LogMetricTrigger

Condición de desencadenador para la regla de consulta de métricas

threshold

number

Umbral de resultado o recuento en función de la regla que se debe desencadenar.

thresholdOperator

ConditionalOperator

GreaterThanOrEqual

Operación de evaluación para la regla: "GreaterThan" o "LessThan".