Scheduled Query Rules - Update

Atualize uma regra de consulta agendada.

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

Parâmetros do URI

Name In Required Type Description
resourceGroupName
path True
  • string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.

ruleName
path True
  • string

O nome da regra.

subscriptionId
path True
  • string

A identificação da assinatura do alvo.

api-version
query True
  • string

A versão API a ser utilizada para esta operação.

Corpo do Pedido

Name Type Description
properties.actions

Ações para invocar quando o alerta dispara.

properties.autoMitigate
  • boolean

A bandeira que indica se o alerta deve ser automaticamente resolvido ou não. O padrão é verdadeiro. Relevante apenas para regras do tipo LogAlert.

properties.checkWorkspaceAlertsStorageConfigured
  • boolean

A bandeira que indica se esta regra de consulta programada deve ser guardada no armazenamento do cliente. O padrão é falso. Relevante apenas para regras do tipo LogAlert.

properties.criteria

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

A bandeira que indica se esta regra de consulta agendada está ativada. Valor deve ser verdadeiro ou falso

properties.evaluationFrequency
  • string

Com que frequência a regra de consulta programada é avaliada representada no formato de duração ISO 8601. Relevante e requerido apenas para regras do tipo LogAlert.

properties.muteActionsDuration
  • string

Ações de silenciamento durante o período de tempo escolhido (no formato de duração ISO 8601) após o alerta ser disparado. Relevante apenas para regras do tipo LogAlert.

properties.overrideQueryTimeRange
  • string

Se especificado, então substitui o intervalo de tempo de consulta (por defeito é WindowSize*NumberOfEvaluationPeriods). Relevante apenas para regras do tipo LogAlert.

properties.scopes
  • string[]

A lista de identificação de recursos é a de que esta regra de consulta programada é traçada.

properties.severity

Gravidade do alerta. Deve ser um inteiro entre [0-4]. O valor de 0 é o mais severo. Relevante e requerido apenas para regras do tipo LogAlert.

properties.skipQueryValidation
  • boolean

A bandeira que indica se a consulta fornecida deve ser validada ou não. O padrão é falso. Relevante apenas para regras do tipo LogAlert.

properties.targetResourceTypes
  • string[]

Lista do tipo de recurso dos recursos-alvo(s) em que o alerta é criado/atualizado. Por exemplo, se o âmbito for um grupo de recursos e o targetResourceTypes for Microsoft.Compute/virtualMachines, então um alerta diferente será disparado para cada máquina virtual no grupo de recursos que satisfaça 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 será executada a consulta de Alerta (tamanho do contentor). Relevante e requerido apenas para regras do tipo LogAlert.

tags
  • object

Etiquetas de recursos

Respostas

Name Type Description
200 OK

Pedido de sucesso para atualizar uma regra de consulta agendada

Other Status Codes

Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Active Directory Oauth2 Flow

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

Scopes

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

Create or update a scheduled query rule

Sample Request

PATCH https://management.azure.com/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourceGroups/QueryResourceGroupName/providers/Microsoft.Insights/scheduledQueryRules/heartbeat?api-version=2021-02-01-preview
{
  "properties": {
    "enabled": false
  }
}

Sample Response

{
  "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/heartbeat",
  "name": "heartbeat",
  "type": "microsoft.insights/scheduledqueryrules",
  "location": "eastus",
  "tags": {},
  "properties": {
    "description": "Health check rule",
    "severity": 4,
    "enabled": false,
    "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

Actions

Ações para invocar quando o alerta dispara.

AlertSeverity

Gravidade do alerta. Deve ser um inteiro entre [0-4]. O valor de 0 é o mais severo. Relevante e requerido apenas para regras do tipo LogAlert.

Condition

Uma condição da regra de consulta programada.

conditionOperator

O operador de critérios. Relevante e requerido 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

O erro de gestão de recursos informações adicionais.

ErrorContract

Descreve o formato de resposta de Erro.

ErrorResponse

Resposta a Erros

FailingPeriods

O número mínimo de violações necessárias dentro da janela de tempo de reversão selecionada necessária para levantar um alerta. Relevante apenas para regras do tipo LogAlert.

Kind

Indica o tipo de regra de consulta programada. 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 programado.

ScheduledQueryRuleResourcePatch

O recurso de regra de consulta programado para operações de correção.

systemData

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

timeAggregation

Tipo de agregação. Relevante e requerido apenas para regras do tipo LogAlert.

Actions

Ações para invocar quando o alerta dispara.

Name Type Description
actionGroups
  • string[]

O Grupo de Ação identifica-se para invocar quando o alerta disparar.

customProperties
  • object

As propriedades de uma carga de alerta.

AlertSeverity

Gravidade do alerta. Deve ser um inteiro entre [0-4]. O valor de 0 é o mais severo. Relevante e requerido apenas para regras do tipo LogAlert.

Name Type Description
0
  • string
1
  • string
2
  • string
3
  • string
4
  • string

Condition

Uma condição da regra de consulta programada.

Name Type Description
dimensions

Lista de condições de Dimensões

failingPeriods

O número mínimo de violações necessárias dentro da janela de tempo de reversão selecionada necessária para levantar um alerta. Relevante apenas para regras do tipo LogAlert.

metricMeasureColumn
  • string

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

metricName
  • string

O nome da métrica a ser enviada. Relevante e requerido apenas para regras do tipo LogToMetric.

operator

O operador de critérios. Relevante e requerido apenas para regras do tipo LogAlert.

query
  • string

Alerta de consulta de registo

resourceIdColumn
  • string

A coluna que contém o id de recursos. O conteúdo da coluna deve ser um uri formatado como id de recursos. Relevante apenas para regras do tipo LogAlert.

threshold
  • number

o valor limiar de critérios que ativa o alerta. Relevante e requerido apenas para regras do tipo LogAlert.

timeAggregation

Tipo de agregação. Relevante e requerido apenas para regras do tipo LogAlert.

conditionOperator

O operador de critérios. Relevante e requerido apenas para regras do tipo LogAlert.

Name Type Description
Equals
  • string
GreaterThan
  • string
GreaterThanOrEqual
  • string
LessThan
  • string
LessThanOrEqual
  • string

createdByType

O tipo de identidade que criou o recurso.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

Dimension

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

Name Type Description
name
  • string

Nome da dimensão

operator

Operador para valores de dimensão

values
  • string[]

Lista de valores de dimensão

dimensionOperator

Operador para valores de dimensão

Name Type Description
Exclude
  • string
Include
  • string

ErrorAdditionalInfo

O erro de gestão de recursos informações adicionais.

Name Type Description
info
  • object

A informação adicional.

type
  • string

O tipo de informação adicional.

ErrorContract

Descreve o formato de resposta de Erro.

Name Type Description
error

Resposta a Erros
Os detalhes do erro.

ErrorResponse

Resposta a Erros

Name Type Description
additionalInfo

O erro informação adicional.

code
  • string

O código de erro.

details

Os detalhes do erro.

message
  • string

A mensagem de erro.

target
  • string

O alvo do erro.

FailingPeriods

O número mínimo de violações necessárias dentro da janela de tempo de reversão selecionada necessária para levantar um alerta. Relevante apenas para regras do tipo LogAlert.

Name Type Description
minFailingPeriodsToAlert
  • integer

O número de violações para desencadear um alerta. Deve ser menor ou igual ao número DeevaluationPeriods. O valor predefinido é 1

numberOfEvaluationPeriods
  • integer

O número de pontos de recuo agregados. A janela de tempo de reexame é calculada com base na granularidade agregada (windowsSize) e no número selecionado de pontos agregados. O valor predefinido é 1

Kind

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

Name Type Description
LogAlert
  • string
LogToMetric
  • string

ScheduledQueryRuleCriteria

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

Name Type Description
allOf

Uma lista de condições para avaliar com os âmbitos especificados

ScheduledQueryRuleResource

O recurso de regra de consulta programado.

Name Type Description
etag
  • string

O campo etag não é necessário. Se for fornecido no organismo de resposta, deve também ser fornecido como cabeçalho de acordo com a convenção normal de etag. As etiquetas de entidade são utilizadas para comparar duas ou mais entidades do mesmo recurso solicitado. HTTP/1.1 utiliza etiquetas de entidade nos campos de cabeçalho 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).

id
  • string

Identificação de recursos totalmente qualificada para o recurso. Ex - /subscrições/{subscriçãoD}/resourceGroups/{resourceGroupName}/fornecedores/{resourceProviderNamespace}/{resourceType}/{resourceName}

kind

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

location
  • string

A geolocalização onde o recurso vive

name
  • string

O nome do recurso

properties.actions

Ações para invocar quando o alerta dispara.

properties.autoMitigate
  • boolean

A bandeira que indica se o alerta deve ser automaticamente resolvido ou não. O padrão é verdadeiro. Relevante apenas para regras do tipo LogAlert.

properties.checkWorkspaceAlertsStorageConfigured
  • boolean

A bandeira que indica se esta regra de consulta programada deve ser guardada no armazenamento do cliente. O padrão é falso. Relevante apenas para regras do tipo LogAlert.

properties.createdWithApiVersion
  • string

A versão api usada ao criar esta regra de alerta

properties.criteria

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

A bandeira que indica se esta regra de consulta agendada está ativada. Valor deve ser verdadeiro ou falso

properties.evaluationFrequency
  • string

Com que frequência a regra de consulta programada é avaliada representada no formato de duração ISO 8601. Relevante e requerido apenas para regras do tipo LogAlert.

properties.isLegacyLogAnalyticsRule
  • boolean

Verdade se a regra de alerta é a regra do log analítico legado

properties.isWorkspaceAlertsStorageConfigured
  • boolean

A bandeira que indica se esta regra de consulta agendada foi configurada para ser armazenada no armazenamento do cliente. O padrão é falso.

properties.muteActionsDuration
  • string

Ações de silenciamento durante o período de tempo escolhido (no formato de duração ISO 8601) após o alerta ser disparado. Relevante apenas para regras do tipo LogAlert.

properties.overrideQueryTimeRange
  • string

Se especificado, então substitui o intervalo de tempo de consulta (por defeito é WindowSize*NumberOfEvaluationPeriods). Relevante apenas para regras do tipo LogAlert.

properties.scopes
  • string[]

A lista de identificação de recursos é a de que esta regra de consulta programada é traçada.

properties.severity

Gravidade do alerta. Deve ser um inteiro entre [0-4]. O valor de 0 é o mais severo. Relevante e requerido apenas para regras do tipo LogAlert.

properties.skipQueryValidation
  • boolean

A bandeira que indica se a consulta fornecida deve ser validada ou não. O padrão é falso. Relevante apenas para regras do tipo LogAlert.

properties.targetResourceTypes
  • string[]

Lista do tipo de recurso dos recursos-alvo(s) em que o alerta é criado/atualizado. Por exemplo, se o âmbito for um grupo de recursos e o targetResourceTypes for Microsoft.Compute/virtualMachines, então um alerta diferente será disparado para cada máquina virtual no grupo de recursos que satisfaça 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 será executada a consulta de Alerta (tamanho do contentor). Relevante e requerido apenas para regras do tipo LogAlert.

systemData

SystemData of ScheduledQueryRule.

tags
  • object

Etiquetas de recursos.

type
  • string

O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft. Armazenamento/armazenamentoCotas"

ScheduledQueryRuleResourcePatch

O recurso de regra de consulta programado para operações de correção.

Name Type Description
properties.actions

Ações para invocar quando o alerta dispara.

properties.autoMitigate
  • boolean

A bandeira que indica se o alerta deve ser automaticamente resolvido ou não. O padrão é verdadeiro. Relevante apenas para regras do tipo LogAlert.

properties.checkWorkspaceAlertsStorageConfigured
  • boolean

A bandeira que indica se esta regra de consulta programada deve ser guardada no armazenamento do cliente. O padrão é falso. Relevante apenas para regras do tipo LogAlert.

properties.createdWithApiVersion
  • string

A versão api usada ao criar esta regra de alerta

properties.criteria

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

A bandeira que indica se esta regra de consulta agendada está ativada. Valor deve ser verdadeiro ou falso

properties.evaluationFrequency
  • string

Com que frequência a regra de consulta programada é avaliada representada no formato de duração ISO 8601. Relevante e requerido apenas para regras do tipo LogAlert.

properties.isLegacyLogAnalyticsRule
  • boolean

Verdade se a regra de alerta é a regra do log analítico legado

properties.isWorkspaceAlertsStorageConfigured
  • boolean

A bandeira que indica se esta regra de consulta agendada foi configurada para ser armazenada no armazenamento do cliente. O padrão é falso.

properties.muteActionsDuration
  • string

Ações de silenciamento durante o período de tempo escolhido (no formato de duração ISO 8601) após o alerta ser disparado. Relevante apenas para regras do tipo LogAlert.

properties.overrideQueryTimeRange
  • string

Se especificado, então substitui o intervalo de tempo de consulta (por defeito é WindowSize*NumberOfEvaluationPeriods). Relevante apenas para regras do tipo LogAlert.

properties.scopes
  • string[]

A lista de identificação de recursos é a de que esta regra de consulta programada é traçada.

properties.severity

Gravidade do alerta. Deve ser um inteiro entre [0-4]. O valor de 0 é o mais severo. Relevante e requerido apenas para regras do tipo LogAlert.

properties.skipQueryValidation
  • boolean

A bandeira que indica se a consulta fornecida deve ser validada ou não. O padrão é falso. Relevante apenas para regras do tipo LogAlert.

properties.targetResourceTypes
  • string[]

Lista do tipo de recurso dos recursos-alvo(s) em que o alerta é criado/atualizado. Por exemplo, se o âmbito for um grupo de recursos e o targetResourceTypes for Microsoft.Compute/virtualMachines, então um alerta diferente será disparado para cada máquina virtual no grupo de recursos que satisfaça 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 será executada a consulta de Alerta (tamanho do contentor). Relevante e requerido apenas para regras do tipo LogAlert.

tags
  • object

Etiquetas de recursos

systemData

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

Name Type Description
createdAt
  • string

O calendário da criação de recursos (UTC).

createdBy
  • string

A identidade que criou o recurso.

createdByType

O tipo de identidade que criou o recurso.

lastModifiedAt
  • string

O tempotamp de última modificação de recursos (UTC)

lastModifiedBy
  • string

A identidade que modificou o recurso pela última vez.

lastModifiedByType

O tipo de identidade que modificou o recurso pela última vez.

timeAggregation

Tipo de agregação. Relevante e requerido apenas para regras do tipo LogAlert.

Name Type Description
Average
  • string
Count
  • string
Maximum
  • string
Minimum
  • string
Total
  • string