Partilhar via

Scheduled Query Rules - List By Subscription

  • Referência
Serviço:
Monitor
Versão da API:
2021-08-01

Obter definições de regras de consulta agendadas numa subscrição.

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

Parâmetros do URI

Name Em Necessário Tipo Description
subscriptionId
 path True

string

O ID da subscrição de destino.
api-version
 query True

string

A versão da API a utilizar para esta operação.

Respostas

Name Tipo Description
200 OK

ScheduledQueryRuleResourceCollection

Pedido com êxito para uma lista de regras de consulta agendadas
Other Status Codes

ErrorContract

BadRequest

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

List scheduled query rules by subscription

Pedido de amostra

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

Resposta da amostra

Código de estado:
200 
{
  "value": [
    {
      "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"
        ],
        "targetResourceTypes": [
          "Microsoft.Compute/virtualMachines"
        ],
        "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
      }
    },
    {
      "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/MyResourceGroupName2/providers/microsoft.insights/scheduledqueryrules/heartbeat",
      "name": "heartbeat",
      "type": "microsoft.insights/scheduledqueryrules",
      "location": "eastus",
      "tags": {},
      "properties": {
        "description": "Health check rule",
        "severity": 4,
        "enabled": true,
        "evaluationFrequency": "PT5M",
        "scopes": [
          "/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147"
        ],
        "targetResourceTypes": [
          "Microsoft.Compute/virtualMachines"
        ],
        "windowSize": "PT10M",
        "criteria": {
          "allOf": [
            {
              "query": "Heartbeat",
              "timeAggregation": "Count",
              "dimensions": [],
              "operator": "GreaterThan",
              "threshold": 360,
              "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

Name Description
Actions

Ações a invocar quando o alerta é acionado.
AlertSeverity

Gravidade do alerta. Deve ser um número 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 filtragem e divisão de dimensões
dimensionOperator

Operador para valores de dimensão
ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.
ErrorContract

Descreve o formato da resposta de Erro.
ErrorResponse

Resposta a Erros
FailingPeriods

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

Indica o tipo de regra de consulta agendada. A predefinição é LogAlert.
ScheduledQueryRuleCriteria

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

O recurso da regra de consulta agendada.
ScheduledQueryRuleResourceCollection

Representa uma coleção de recursos de regras de consulta agendadas.
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 invocar quando o alerta é acionado.

Name Tipo Description
actionGroups

string[]

IDs de recursos do Grupo de Ações a invocar quando o alerta é acionado.
customProperties

object

As propriedades de um payload de alerta.

AlertSeverity

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

Name Tipo Description
0

Integer

1

Integer

2

Integer

3

Integer

4

Integer

Condition

Uma condição da regra de consulta agendada.

Name 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 emitir um alerta. Relevante apenas para regras do tipo LogAlert.
metricMeasureColumn

string

A coluna que contém o número da medida de métrica. Relevante apenas para regras do tipo LogAlert.
metricName

string

O nome da métrica a enviar. Relevante e necessário apenas 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 registo
resourceIdColumn

string

A coluna que contém o ID do recurso. O conteúdo da coluna tem de ser um URI formatado como id de recurso. Relevante apenas para regras do tipo LogAlert.
threshold

number

o valor do limiar 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.

Name Tipo Description
Equals

string

GreaterThan

string

GreaterThanOrEqual

string

LessThan

string

LessThanOrEqual

string

createdByType

O tipo de identidade que criou o recurso.

Name Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

Dimension

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

Name 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

Name Tipo Description
Exclude

string

Include

string

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informações adicionais.

ErrorContract

Descreve o formato da resposta de Erro.

Name Tipo Description
error

ErrorResponse

Resposta a Erros
Os detalhes do erro.

ErrorResponse

Resposta a Erros

Name 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 emitir um alerta. Relevante apenas para regras do tipo LogAlert.

Name Tipo Default value Description
minFailingPeriodsToAlert

integer

1

O número de violações para acionar um alerta. Deve ser menor ou igual a numberOfEvaluationPeriods. O valor predefinido é 1
numberOfEvaluationPeriods

integer

1

O número de pontos de pesquisa agregados. A janela de tempo de pesquisa é calculada com base na granularidade da agregação (windowSize) e no número selecionado de pontos agregados. O valor predefinido é 1

Kind

Indica o tipo de regra de consulta agendada. A predefinição é LogAlert.

Name Tipo Description
LogAlert

string

LogToMetric

string

ScheduledQueryRuleCriteria

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

Name Tipo Description
allOf

Condition[]

Uma lista de condições a avaliar em relação aos âmbitos especificados

ScheduledQueryRuleResource

O recurso da regra de consulta agendada.

Name Tipo Description
etag

string

O campo etag não é obrigatório. Se for fornecido no corpo da resposta, também tem de ser fornecido como um cabeçalho de acordo com a convenção de etag normal. As etiquetas de entidade são utilizadas para comparar duas ou mais entidades do mesmo recurso pedido. HTTP/1.1 utiliza etiquetas de entidade na etag (secção 14.19), If-Match (secção 14.24), If-None-Match (secção 14.26) e If-Range (secção 14.27) campos de cabeçalho.
id

string

ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind

Kind

Indica o tipo de regra de consulta agendada. A predefinição é LogAlert.
location

string

A localização geográfica onde reside o recurso
name

string

O nome do recurso
properties.actions

Actions

Ações a invocar quando o alerta é acionado.
properties.autoMitigate

boolean

O sinalizador que indica se o alerta deve ser resolvido automaticamente ou não. A predefinição é verdadeira. Relevante apenas para regras do tipo LogAlert.
properties.checkWorkspaceAlertsStorageConfigured

boolean

O sinalizador que indica se esta regra de consulta agendada deve ser armazenada no armazenamento do cliente. A predefinição é false. Relevante apenas para regras do tipo LogAlert.
properties.createdWithApiVersion

string

A versão da API utilizada ao criar esta 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 a apresentar da regra de alerta
properties.enabled

boolean

O sinalizador que indica se esta regra de consulta agendada está ativada. O valor deve ser verdadeiro ou falso
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

Verdadeiro se a regra de alerta for uma regra do Log Analytic legada
properties.isWorkspaceAlertsStorageConfigured

boolean

O sinalizador que indica se esta regra de consulta agendada foi configurada para ser armazenada no armazenamento do cliente. A predefinição é false.
properties.muteActionsDuration

string

Desativar o som das ações para o período de tempo escolhido (no formato de duração ISO 8601) após o alerta ser acionado. Relevante apenas para regras do tipo LogAlert.
properties.overrideQueryTimeRange

string

Se especificado, substitui o intervalo de tempo da consulta (a predefinição é WindowSize*NumberOfEvaluationPeriods). Relevante apenas para regras do tipo LogAlert.
properties.scopes

string[]

A lista de IDs de recursos para a qual esta regra de consulta agendada está confinada.
properties.severity

AlertSeverity

Gravidade do alerta. Deve ser um número 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 ou não ser validada. A predefinição é false. Relevante apenas para regras do tipo LogAlert.
properties.targetResourceTypes

string[]

Lista do tipo de recurso dos recursos de destino nos quais o alerta é criado/atualizado. Por exemplo, se o âmbito for um grupo de recursos e targetResourceTypes for Microsoft.Compute/virtualMachines, será acionado um alerta diferente para cada máquina virtual no grupo de recursos que cumpra os critérios de alerta. Relevante apenas para regras do tipo LogAlert
properties.windowSize

string

O período de tempo (no formato de duração ISO 8601) no qual a consulta Alerta será executada (tamanho da discretização). Relevante e necessário apenas para regras do tipo LogAlert.
systemData

systemData

SystemData de ScheduledQueryRule.
tags

object

Etiquetas de recursos.
type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ScheduledQueryRuleResourceCollection

Representa uma coleção de recursos de regras de consulta agendadas.

Name Tipo Description
nextLink

string

Fornece a ligação para obter o próximo conjunto de elementos.
value

ScheduledQueryRuleResource[]

Os valores dos recursos da regra de consulta agendada.

systemData

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

Name 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.

Name Tipo Description
Average

string

Count

string

Maximum

string

Minimum

string

Total

string