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 de URI

Name In Required Type 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.

Corpo da solicitação

Name Type Description
properties.actions

Ações a serem invocadas quando o alerta for disparado.

properties.autoMitigate
  • boolean

O sinalizador que indica se o alerta deve ser resolvido automaticamente ou não. O padrão é true. 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. 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

O sinalizador que indica se esta 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.muteActionsDuration
  • string

Ações de mudo 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 de consulta (o padrão é WindowSize * NumberOfEvaluationPeriods). Relevante apenas para regras do tipo LogAlert.

properties.scopes
  • string[]

A lista de IDs de recurso da qual essa regra de consulta agendada tem como escopo.

properties.severity

Severidade do alerta. Deve ser um inteiro entre [0-4]. O valor 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 é falso. Relevante apenas para regras do tipo LogAlert.

properties.targetResourceTypes
  • string[]

Lista de tipos de recursos 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 atende aos 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 de alerta será executada (tamanho do compartimento). Relevante e necessário apenas para regras do tipo LogAlert.

tags
  • object

Marcações de recursos

Respostas

Name Type Description
200 OK

Solicitação bem-sucedida para atualizar uma regra de consulta agendada

Other Status Codes

Resposta de erro que descreve 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 representar sua conta de usuário

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 a serem invocadas quando o alerta for disparado.

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

Divisão de dimensão e definição de filtragem

dimensionOperator

Operador para valores de dimensão

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

ErrorContract

Descreve o formato da resposta de erro.

ErrorResponse

Resposta de erro

FailingPeriods

O número mínimo de violações necessárias dentro da janela de tempo de lookback selecionada necessária para a adoção de um alerta. Relevante apenas 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.

ScheduledQueryRuleResourcePatch

O recurso de regra de consulta agendada para operações de patch.

systemData

Metadados referentes à 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 for disparado.

Name Type Description
actionGroups
  • string[]

IDs de recurso do grupo de ações a serem invocadas quando o alerta for disparado.

customProperties
  • object

As propriedades de uma carga 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.

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

Condition

Uma condição da regra de consulta agendada.

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 lookback selecionada necessária para a adoção de 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 ser enviada. Relevante e necessário apenas para regras do tipo LogToMetric.

operator

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 do recurso. Relevante apenas para regras do tipo LogAlert.

threshold
  • number

o valor de limite de critérios que ativa o alerta. Relevante e necessário apenas para regras do tipo LogAlert.

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

Divisão de dimensão e definição de filtragem

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 gerenciamento de recursos informações adicionais.

Name Type Description
info
  • object

As informações adicionais.

type
  • string

O tipo de informações adicionais.

ErrorContract

Descreve o formato da resposta de erro.

Name Type Description
error

Resposta de erro
Os detalhes do erro.

ErrorResponse

Resposta de erro

Name Type Description
additionalInfo

As informações adicionais do erro.

code
  • string

O código de erro.

details

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 dentro da janela de tempo de lookback selecionada necessária para a adoção de um alerta. Relevante apenas para regras do tipo LogAlert.

Name Type Description
minFailingPeriodsToAlert
  • integer

O número de violações para disparar um alerta. Deve ser menor ou igual a numberOfEvaluationPeriods. O valor padrão é 1

numberOfEvaluationPeriods
  • integer

O número de pontos de lookback agregados. A janela de tempo de retorno é 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.

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 a serem avaliadas em relação aos escopos especificados

ScheduledQueryRuleResource

O recurso de regra de consulta agendada.

Name Type Description
etag
  • string

O campo ETag não é necessário. Se 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. Marcas de entidade são usadas para comparar duas ou mais entidades do mesmo recurso solicitado. O HTTP/1.1 usa marcas de entidade na ETag (seção 14,19), If-Match (seção 14,24), os campos de cabeçalho If-None-Match (seção 14,26) e 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

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

Ações a serem invocadas quando o alerta for disparado.

properties.autoMitigate
  • boolean

O sinalizador que indica se o alerta deve ser resolvido automaticamente ou não. O padrão é true. 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. O padrão é falso. Relevante apenas para regras do tipo LogAlert.

properties.createdWithApiVersion
  • string

A versão de 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

O sinalizador que indica se esta 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 uma regra analítica de log herdada

properties.isWorkspaceAlertsStorageConfigured
  • boolean

O sinalizador 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 mudo 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 de consulta (o padrão é WindowSize * NumberOfEvaluationPeriods). Relevante apenas para regras do tipo LogAlert.

properties.scopes
  • string[]

A lista de IDs de recurso da qual essa regra de consulta agendada tem como escopo.

properties.severity

Severidade do alerta. Deve ser um inteiro entre [0-4]. O valor 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 é falso. Relevante apenas para regras do tipo LogAlert.

properties.targetResourceTypes
  • string[]

Lista de tipos de recursos 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 atende aos 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 de alerta será executada (tamanho do compartimento). Relevante e necessário apenas para regras do tipo LogAlert.

systemData

SystemData ScheduledQueryRule.

tags
  • object

Marcas de recurso.

type
  • string

Tipo do recurso. Por ex.: "Microsoft. Compute/virtualMachines" ou "Microsoft. Armazenamento/storageAccounts "

ScheduledQueryRuleResourcePatch

O recurso de regra de consulta agendada para operações de patch.

Name Type Description
properties.actions

Ações a ser invocadas quando o alerta é a incêndio.

properties.autoMitigate
  • boolean

O sinalizador que indica se o alerta deve ser resolvido automaticamente ou não. O padrão é true. Relevante apenas 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 é falso. Relevante apenas para regras do tipo LogAlert.

properties.createdWithApiVersion
  • string

A versão da API usada ao criar essa 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

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 uma regra de Análise de Log herdado

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 é falso.

properties.muteActionsDuration
  • string

Ações de mute para o período de tempo escolhido (no formato de duração ISO 8601) depois que o alerta é acionado. Relevante apenas para regras do tipo LogAlert.

properties.overrideQueryTimeRange
  • string

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

properties.scopes
  • string[]

A lista de IDs de recurso para a que essa regra de consulta agendada está no escopo.

properties.severity

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 é falso. Relevante apenas para regras do tipo LogAlert.

properties.targetResourceTypes
  • string[]

Lista de tipos de recursos 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 atender aos 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 de alerta será executada (tamanho do compartimento). Relevante e necessário apenas para regras do tipo LogAlert.

tags
  • object

Marcações de recursos

systemData

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

Name Type Description
createdAt
  • string

O data/hora 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 data/hora da última modificação do recurso (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 necessário apenas para regras do tipo LogAlert.

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