Partilhar via


Scheduled Query Rules - Update

Atualizar regra de pesquisa de registos.

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

Parâmetros do URI

Name Em Necessário Tipo 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

O ID da subscrição de destino.

api-version
query True

string

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

Corpo do Pedido

Name Tipo Description
properties.enabled

enabled

O sinalizador que indica se a regra de Pesquisa de Registos está ativada. O valor deve ser verdadeiro ou falso

tags

object

Etiquetas de recursos

Respostas

Name Tipo Description
200 OK

LogSearchRuleResource

Pedido com êxito para atualizar uma regra de Pesquisa de Registos

Other Status Codes

ErrorContract

Resposta de erro que descreve a razão pela qual a operação falhou.

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

Patch Log Search Rule

Pedido de amostra

PATCH https://management.azure.com/subscriptions/subid/resourcegroups/my-resource-group/providers/Microsoft.Insights/scheduledQueryRules/logalertfoo?api-version=2018-04-16

{
  "properties": {
    "enabled": "true"
  }
}

Resposta da amostra

{
  "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",
      "dataSourceId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/components/sampleAI",
      "queryType": "ResultCount"
    },
    "schedule": {
      "frequencyInMinutes": 15,
      "timeWindowInMinutes": 15
    },
    "action": {
      "odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction",
      "severity": "1",
      "aznsAction": {
        "actionGroup": [],
        "emailSubject": "Email Header",
        "customWebhookPayload": "{}"
      },
      "trigger": {
        "thresholdOperator": "GreaterThan",
        "threshold": 3,
        "metricTrigger": {
          "thresholdOperator": "GreaterThan",
          "threshold": 5,
          "metricTriggerType": "Consecutive",
          "metricColumn": "ColumnName"
        }
      }
    }
  }
}

Definições

Name Description
AlertingAction

Especificar a ação tem de ser tomada quando o tipo de regra é Alerta

AlertSeverity

Nível de Gravidade do Alerta

AzNsActionGroup

Grupo de ações do Azure

ConditionalOperator

Critérios de Avaliação da Condição de Resultado.

Criteria

Especifica os critérios para converter o registo em métrica.

Dimension

Especifica os critérios para converter o registo em métrica.

enabled

O sinalizador que indica se a regra de Pesquisa de Registos está ativada. O valor deve ser verdadeiro ou falso

ErrorContract

Descreve o formato de Resposta a erros.

ErrorResponse

Descreve o formato de Resposta a erros.

LogMetricTrigger

Um descritor de acionador de métricas de registo.

LogSearchRuleResource

O recurso da Regra de Pesquisa de Registos.

LogSearchRuleResourcePatch

O recurso de regra de pesquisa de registos para operações de patch.

LogToMetricAction

Especificar a ação tem de ser tomada quando o tipo de regra está a converter o registo em métrica

metricTriggerType

Tipo de Acionador de Métricas – "Consecutivo" ou "Total"

operator

Operador para valores de dimensão

provisioningState

Estado de aprovisionamento da regra de consulta agendada

QueryType

Definir o valor como "ResultAccount"

Schedule

Define a frequência de execução da pesquisa e o intervalo de tempo.

Source

Especifica a consulta de pesquisa de registos.

TriggerCondition

A condição que resulta na regra de Pesquisa de Registos.

AlertingAction

Especificar a ação tem de ser tomada quando o tipo de regra é Alerta

Name Tipo Description
aznsAction

AzNsActionGroup

Referência do grupo de ações do Azure.

odata.type string:

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

Especifica a ação. Valores suportados – AlertingAction, LogToMetricAction

severity

AlertSeverity

Gravidade do alerta

throttlingInMin

integer

tempo (em minutos) para o qual os Alertas devem ser limitados ou suprimidos.

trigger

TriggerCondition

A condição do acionador que resulta na regra de alerta.

AlertSeverity

Nível de Gravidade do Alerta

Name Tipo Description
0

string

1

string

2

string

3

string

4

string

AzNsActionGroup

Grupo de ações do Azure

Name Tipo Description
actionGroup

string[]

Referência do Grupo de Ações do Azure.

customWebhookPayload

string

Payload personalizado a ser enviado para todo o URI do webhook no grupo de ações do Azure

emailSubject

string

Substituição personalizada do assunto para todos os IDs de e-mail no grupo de ações do Azure

ConditionalOperator

Critérios de Avaliação da Condição de Resultado.

Name Tipo Description
Equal

string

GreaterThan

string

GreaterThanOrEqual

string

LessThan

string

LessThanOrEqual

string

Criteria

Especifica os critérios para converter o registo em métrica.

Name Tipo Description
dimensions

Dimension[]

Lista de Dimensões para criar métricas

metricName

string

Nome da métrica

Dimension

Especifica os critérios para converter o registo em métrica.

Name Tipo Description
name

string

Nome da dimensão

operator

operator

Operador para valores de dimensão

values

string[]

Lista de valores de dimensão

enabled

O sinalizador que indica se a regra de Pesquisa de Registos está ativada. O valor deve ser verdadeiro ou falso

Name Tipo Description
false

string

true

string

ErrorContract

Descreve o formato de Resposta a erros.

Name Tipo Description
error

ErrorResponse

Os detalhes do erro.

ErrorResponse

Descreve o formato de Resposta a erros.

Name Tipo Description
code

string

Código de erro

message

string

Mensagem de erro a indicar por que motivo a operação falhou.

LogMetricTrigger

Um descritor de acionador de métricas de registo.

Name Tipo Default value Description
metricColumn

string

Avaliação da métrica numa coluna específica

metricTriggerType

metricTriggerType

Consecutive

Tipo de Acionador de Métricas – "Consecutivo" ou "Total"

threshold

number

O limiar do acionador de métricas.

thresholdOperator

ConditionalOperator

GreaterThanOrEqual

Operação de avaliação para Métrica -'GreaterThan' ou 'LessThan' ou 'Equal'.

LogSearchRuleResource

O recurso da Regra de Pesquisa de Registos.

Name Tipo Default value Description
etag

string

O campo etag não é necessário. Se for fornecido no corpo de 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 no 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 do recurso do Azure

kind

string

Metadados utilizados pelo portal/ferramentas/etc. para compor diferentes experiências de UX para recursos do mesmo tipo; Por exemplo, as ApiApps são uma espécie de tipo Microsoft.Web/sites. Se for suportado, o fornecedor de recursos tem de validar e manter este valor.

location

string

Localização do recurso

name

string

Nome do recurso do Azure

properties.action Action:

É necessário tomar medidas na execução de regras.

properties.autoMitigate

boolean

False

O sinalizador que indica se o alerta deve ser resolvido automaticamente ou não. A predefinição é falsa.

properties.createdWithApiVersion

string

A versão da API utilizada ao criar esta regra de alerta

properties.description

string

A descrição da regra de Pesquisa de Registos.

properties.displayName

string

O nome a apresentar da regra de alerta

properties.enabled

enabled

O sinalizador que indica se a regra de Pesquisa de Registos está ativada. O valor deve ser verdadeiro ou falso

properties.isLegacyLogAnalyticsRule

boolean

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

properties.lastUpdatedTime

string

A última vez que a regra foi atualizada no formato IS08601.

properties.provisioningState

provisioningState

Estado de aprovisionamento da regra de consulta agendada

properties.schedule

Schedule

Agendar (Frequência, Janela de Tempo) para a regra. Necessário para o tipo de ação – AlertingAction

properties.source

Source

Origem de Dados em relação à regra que irá Consultar Dados

tags

object

Etiquetas de recursos

type

string

Tipo de recurso do Azure

LogSearchRuleResourcePatch

O recurso de regra de pesquisa de registos para operações de patch.

Name Tipo Description
properties.enabled

enabled

O sinalizador que indica se a regra de Pesquisa de Registos está ativada. O valor deve ser verdadeiro ou falso

tags

object

Etiquetas de recursos

LogToMetricAction

Especificar a ação tem de ser tomada quando o tipo de regra está a converter o registo em métrica

Name Tipo Description
criteria

Criteria[]

Critérios de Métrica

odata.type string:

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

Especifica a ação. Valores suportados – AlertingAction, LogToMetricAction

metricTriggerType

Tipo de Acionador de Métricas – "Consecutivo" ou "Total"

Name Tipo Description
Consecutive

string

Total

string

operator

Operador para valores de dimensão

Name Tipo Description
Include

string

provisioningState

Estado de aprovisionamento da regra de consulta agendada

Name Tipo Description
Canceled

string

Deploying

string

Failed

string

Succeeded

string

QueryType

Definir o valor como "ResultAccount"

Name Tipo Description
ResultCount

string

Schedule

Define a frequência de execução da pesquisa e o intervalo de tempo.

Name Tipo Description
frequencyInMinutes

integer

frequência (em minutos) em que a condição de regra deve ser avaliada.

timeWindowInMinutes

integer

Período de tempo para o qual os dados têm de ser obtidos para consulta (deve ser maior ou igual a frequencyInMinutes).

Source

Especifica a consulta de pesquisa de registos.

Name Tipo Description
authorizedResources

string[]

Lista de Recursos referenciado na consulta

dataSourceId

string

O uri de recurso sobre o qual a consulta de pesquisa de registos deve ser executada.

query

string

Consulta de pesquisa de registos. Necessário para o tipo de ação – AlertingAction

queryType

QueryType

Defina o valor como "ResultCount".

TriggerCondition

A condição que resulta na regra de Pesquisa de Registos.

Name Tipo Default value Description
metricTrigger

LogMetricTrigger

Condição do acionador para a regra de consulta de métricas

threshold

number

Limiar de contagem ou resultado com base na regra que deve ser acionada.

thresholdOperator

ConditionalOperator

GreaterThanOrEqual

Operação de avaliação para a regra – "GreaterThan" ou "LessThan".