Scheduled Query Rules - Get

Referência

Service:: Monitor

API Version:: 2021-08-01

Recupere uma definição de regra de consulta agendada.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
ruleName	path	True	string	O nome da regra.
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	ScheduledQueryRuleResource	Solicitação bem-sucedida para obter uma regra de consulta agendada
Other Status Codes	ErrorContract	BadRequest

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get a scheduled query rule for single resource

Sample Request

HTTP

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

Sample Response

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
  }
}

Definições

Nome	Description
Actions	Ações a serem invocadas quando o alerta é acionado.
AlertSeverity	Severidade do alerta. Deve ser um inteiro entre [0-4]. O valor de 0 é mais grave. Relevante e necessário apenas para regras do tipo LogAlert.
Condition	Uma condição da regra de consulta agendada.
conditionOperator	O operador de critérios. Relevante e necessário apenas para regras do tipo LogAlert.
createdByType	O tipo de identidade que criou o recurso.
Dimension	Definição de divisão e filtragem de dimensões
dimensionOperator	Operador para valores de dimensão
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorContract	Descreve o formato da resposta de erro.
ErrorResponse	Resposta de erro
FailingPeriods	O número mínimo de violações necessárias na janela de tempo de pesquisa selecionada necessária para gerar um alerta. Relevante somente para regras do tipo LogAlert.
Kind	Indica o tipo de regra de consulta agendada. O padrão é LogAlert.
ScheduledQueryRuleCriteria	Os critérios de regra que definem as condições da regra de consulta agendada.
ScheduledQueryRuleResource	O recurso de regra de consulta agendada.
systemData	Metadados relativos à criação e à última modificação do recurso.
timeAggregation	Tipo de agregação. Relevante e necessário apenas para regras do tipo LogAlert.

Actions

Ações a serem invocadas quando o alerta é acionado.

Nome	Tipo	Description
actionGroups	string[]	IDs de recurso do Grupo de Ações a serem invocadas quando o alerta é acionado.
customProperties	object	As propriedades de um conteúdo de alerta.

AlertSeverity

Severidade do alerta. Deve ser um inteiro entre [0-4]. O valor de 0 é mais grave. Relevante e necessário apenas para regras do tipo LogAlert.

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

Condition

Uma condição da regra de consulta agendada.

Nome	Tipo	Description
dimensions	Dimension[]	Lista de condições de dimensões
failingPeriods	FailingPeriods	O número mínimo de violações necessárias na janela de tempo de pesquisa selecionada necessária para gerar um alerta. Relevante somente para regras do tipo LogAlert.
metricMeasureColumn	string	A coluna que contém o número da medida de métrica. Relevante somente para regras do tipo LogAlert.
metricName	string	O nome da métrica a ser enviada. Relevante e necessário somente para regras do tipo LogToMetric.
operator	conditionOperator	O operador de critérios. Relevante e necessário apenas para regras do tipo LogAlert.
query	string	Alerta de consulta de log
resourceIdColumn	string	A coluna que contém a ID do recurso. O conteúdo da coluna deve ser um uri formatado como id de recurso. Relevante somente para regras do tipo LogAlert.
threshold	number	o valor do limite de critérios que ativa o alerta. Relevante e necessário apenas para regras do tipo LogAlert.
timeAggregation	timeAggregation	Tipo de agregação. Relevante e necessário apenas para regras do tipo LogAlert.

conditionOperator

O operador de critérios. Relevante e necessário apenas para regras do tipo LogAlert.

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

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Dimension

Definição de divisão e filtragem de dimensões

Nome	Tipo	Description
name	string	Nome da dimensão
operator	dimensionOperator	Operador para valores de dimensão
values	string[]	Lista de valores de dimensão

dimensionOperator

Operador para valores de dimensão

Nome	Tipo	Description
Exclude	string
Include	string

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorContract

Descreve o formato da resposta de erro.

Nome	Tipo	Description
error	ErrorResponse	Resposta de erro Os detalhes do erro.

ErrorResponse

Resposta de erro

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorResponse[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

FailingPeriods

O número mínimo de violações necessárias na janela de tempo de pesquisa selecionada necessária para gerar um alerta. Relevante somente para regras do tipo LogAlert.

Nome	Tipo	Valor padrão	Description
minFailingPeriodsToAlert	integer	1	O número de violações para disparar um alerta. Deve ser menor ou igual a numberOfEvaluationPeriods. O valor padrão é 1
numberOfEvaluationPeriods	integer	1	O número de pontos de pesquisa agregados. A janela de tempo de pesquisa é calculada com base na granularidade de agregação (windowSize) e no número selecionado de pontos agregados. O valor padrão é 1

Kind

Indica o tipo de regra de consulta agendada. O padrão é LogAlert.

Nome	Tipo	Description
LogAlert	string
LogToMetric	string

ScheduledQueryRuleCriteria

Os critérios de regra que definem as condições da regra de consulta agendada.

Nome	Tipo	Description
allOf	Condition[]	Uma lista de condições a serem avaliadas em relação aos escopos especificados

ScheduledQueryRuleResource

O recurso de regra de consulta agendada.

Nome	Tipo	Description
etag	string	O campo de etag não é necessário. Se ele for fornecido no corpo da resposta, ele também deverá ser fornecido como um cabeçalho de acordo com a convenção de etag normal. As marcas de entidade são usadas para comparar duas ou mais entidades do mesmo recurso solicitado. HTTP/1.1 usa marcas de entidade na etag (seção 14.19), If-Match (seção 14.24), If-None-Match (seção 14.26) e campos de cabeçalho If-Range (seção 14.27).
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	Kind	Indica o tipo de regra de consulta agendada. O padrão é LogAlert.
location	string	A localização geográfica em que o recurso reside
name	string	O nome do recurso
properties.actions	Actions	Ações a serem invocadas quando o alerta é acionado.
properties.autoMitigate	boolean	O sinalizador que indica se o alerta deve ser resolvido automaticamente ou não. O padrão é true. Relevante somente para regras do tipo LogAlert.
properties.checkWorkspaceAlertsStorageConfigured	boolean	O sinalizador que indica se essa regra de consulta agendada deve ser armazenada no armazenamento do cliente. O padrão é false. Relevante somente para regras do tipo LogAlert.
properties.createdWithApiVersion	string	A versão da API usada ao criar essa regra de alerta
properties.criteria	ScheduledQueryRuleCriteria	Os critérios de regra que definem as condições da regra de consulta agendada.
properties.description	string	A descrição da regra de consulta agendada.
properties.displayName	string	O nome de exibição da regra de alerta
properties.enabled	boolean	O sinalizador que indica se essa regra de consulta agendada está habilitada. O valor deve ser true ou false
properties.evaluationFrequency	string	Com que frequência a regra de consulta agendada é avaliada representada no formato de duração ISO 8601. Relevante e necessário apenas para regras do tipo LogAlert.
properties.isLegacyLogAnalyticsRule	boolean	True se a regra de alerta for a regra herdada do Log Analytic
properties.isWorkspaceAlertsStorageConfigured	boolean	O sinalizador que indica se essa regra de consulta agendada foi configurada para ser armazenada no armazenamento do cliente. O padrão é false.
properties.muteActionsDuration	string	Ativar mudo de ações para o período de tempo escolhido (no formato de duração ISO 8601) depois que o alerta for acionado. Relevante somente para regras do tipo LogAlert.
properties.overrideQueryTimeRange	string	Se especificado, então substitui o intervalo de tempo da consulta (o padrão é WindowSize*NumberOfEvaluationPeriods). Relevante somente para regras do tipo LogAlert.
properties.scopes	string[]	A lista de IDs de recurso à qual essa regra de consulta agendada está no escopo.
properties.severity	AlertSeverity	Severidade do alerta. Deve ser um inteiro entre [0-4]. O valor de 0 é mais grave. Relevante e necessário apenas para regras do tipo LogAlert.
properties.skipQueryValidation	boolean	O sinalizador que indica se a consulta fornecida deve ser validada ou não. O padrão é false. Relevante somente para regras do tipo LogAlert.
properties.targetResourceTypes	string[]	Lista de tipos de recurso dos recursos de destino nos quais o alerta é criado/atualizado. Por exemplo, se o escopo for um grupo de recursos e targetResourceTypes for Microsoft.Compute/virtualMachines, um alerta diferente será acionado para cada máquina virtual no grupo de recursos que atenda aos critérios de alerta. Relevante somente para regras do tipo LogAlert
properties.windowSize	string	O período de tempo (no formato de duração ISO 8601) no qual a consulta de alerta será executada (tamanho do compartimento). Relevante e necessário apenas para regras do tipo LogAlert.
systemData	systemData	SystemData de ScheduledQueryRule.
tags	object	Marcas de recurso.
type	string	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

systemData

Metadados relativos à criação e à última modificação do recurso.

Nome	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

timeAggregation

Tipo de agregação. Relevante e necessário apenas para regras do tipo LogAlert.

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