Alerts - Change State

  • Referência
Service:
Monitor
API Version:
2023-07-12-preview

Altere o estado de um alerta.

POST https://management.azure.com/{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}/changestate?api-version=2023-07-12-preview&newState={newState}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
alertId
 path True

string

ID exclusiva de uma instância de alerta.
scope
 path True

string

aqui está resourceId para o qual o alerta é criado.
api-version
 query True

string

A versão da API a ser usada para esta operação.
newState
 query True

AlertState

Novo estado do alerta.

Corpo da solicitação

Nome Tipo Description
comments

string

Respostas

Nome Tipo Description
200 OK

alert

OK. Estado de alerta atualizado.
Other Status Codes

errorResponse

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

Exemplos

Resolve

Sample Request

POST https://management.azure.com/subscriptions/9e261de7-c804-4b9d-9ebf-6f50fe350a9a/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100/changestate?api-version=2023-07-12-preview&newState=Acknowledged

Sample Response

Status code:
200 
{
  "properties": {
    "essentials": {
      "severity": "Sev3",
      "signalType": "Log",
      "alertState": "Acknowledged",
      "monitorCondition": "Fired",
      "monitorService": "Application Insights",
      "targetResource": "/subscriptions/3b540246-808d-4331-99aa-917b808a9166/resourcegroups/servicedeskresourcegroup/providers/microsoft.insights/components/servicedeskappinsight",
      "targetResourceName": "servicedeskappinsight",
      "targetResourceGroup": "servicedeskresourcegroup",
      "targetResourceType": "components",
      "sourceCreatedId": "6cd6b2ce-8c54-468f-aff0-9d12aebb7e49",
      "smartGroupId": "23d6b2ce-8c54-468f-aff0-sd32aebb7e56",
      "smartGroupingReason": "Occurred frequently with other alerts",
      "alertRule": "https://servisdfsdfappinsight.portal.mms.microsoft.com/#Workspace/overview/settings/details/Edit Alert Rule/details/index?savedSearchId=&scheduleId=",
      "startDateTime": "2018-09-13T15:51:02Z",
      "lastModifiedDateTime": "2018-09-13T15:51:02Z",
      "lastModifiedUserName": "System",
      "monitorConditionResolvedDateTime": "2018-09-13T15:51:02Z",
      "actionStatus": {
        "isSuppressed": false
      },
      "description": "description of the alert"
    },
    "egressConfig": {},
    "context": {}
  },
  "id": "/subscriptions/9e261de7-c804-4b9d-9ebf-6f50fe350a9a/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100",
  "type": "Microsoft.AlertsManagement/alerts",
  "name": "cpu alert"
}

Definições

Nome Description
actionStatus

Status da ação
alert

Um alerta criado no serviço de gerenciamento de alertas.
alertProperties

Recipiente de propriedades de alerta
AlertState

Estado do objeto de alerta, que pode ser modificado pelo usuário.
comments

Alterar o motivo do estado do alerta
errorResponse

Uma resposta de erro do serviço.
errorResponseBody

Detalhes da resposta de erro.
essentials

Esse objeto contém campos consistentes em diferentes serviços de monitor.
MonitorCondition

Condição da regra no serviço monitor. Ele representa se as condições subjacentes cruzaram os limites de regra de alerta definidos.
MonitorService

Monitore o serviço no qual a regra (monitor) está definida.
Severity

Gravidade do alerta Sev0 sendo o mais alto e Sev4 sendo o mais baixo.
SignalType

O tipo de sinal no qual o alerta se baseia, que pode ser métricas, logs ou logs de atividades.

actionStatus

Status da ação

Nome Tipo Description
isSuppressed

boolean

Valor que indica se o alerta é suprimido.

alert

Um alerta criado no serviço de gerenciamento de alertas.

Nome Tipo Description
id

string

ID do recurso do Azure
name

string

Nome do recurso do Azure
properties

alertProperties

Recipiente de propriedades de alerta
type

string

Tipo de recurso do Azure

alertProperties

Recipiente de propriedades de alerta

Nome Tipo Description
context

object

Informações específicas para o serviço monitor que fornece mais detalhes contextuais sobre o alerta.
egressConfig

object

Configuração que seria usada para exibir os dados no portal.
essentials

essentials

Esse objeto contém campos consistentes em diferentes serviços de monitor.

AlertState

Estado do objeto de alerta, que pode ser modificado pelo usuário.

Nome Tipo Description
Acknowledged

string

Closed

string

New

string

comments

Alterar o motivo do estado do alerta

Nome Tipo Description
comments

string

errorResponse

Uma resposta de erro do serviço.

Nome Tipo Description
error

errorResponseBody

Detalhes da resposta de erro.

errorResponseBody

Detalhes da resposta de erro.

Nome Tipo Description
code

string

Código de erro, destinado a ser consumido programaticamente.
details

errorResponseBody[]

Uma lista de detalhes adicionais sobre o erro.
message

string

Descrição do erro, destinado à exibição na interface do usuário.
target

string

Destino do erro específico, por exemplo, o nome da propriedade.

essentials

Esse objeto contém campos consistentes em diferentes serviços de monitor.

Nome Tipo Description
actionStatus

actionStatus

Status da ação
alertRule

string

Regra(monitor) que disparou a instância de alerta. Dependendo do serviço de monitor, essa seria a ID do ARM ou o nome da regra.
alertState

AlertState

Estado do objeto de alerta, que pode ser modificado pelo usuário.
description

string

Descrição do alerta.
lastModifiedDateTime

string

Hora da última modificação (formato ISO-8601) da instância de alerta.
lastModifiedUserName

string

Usuário que modificou o alerta pela última vez, no caso de monitorar atualizações de serviço, o usuário seria 'system', caso contrário, o nome do usuário.
monitorCondition

MonitorCondition

Condição da regra no serviço monitor. Ele representa se as condições subjacentes cruzaram os limites de regra de alerta definidos.
monitorConditionResolvedDateTime

string

Hora resolvida (formato ISO-8601) da instância de alerta. Isso será atualizado quando o serviço monitor resolver a instância de alerta porque a condição de regra não é mais atendida.
monitorService

MonitorService

Monitore o serviço no qual a regra (monitor) está definida.
severity

Severity

Gravidade do alerta Sev0 sendo o mais alto e Sev4 sendo o mais baixo.
signalType

SignalType

O tipo de sinal no qual o alerta se baseia, que pode ser métricas, logs ou logs de atividades.
smartGroupId

string

ID exclusiva do grupo inteligente
smartGroupingReason

string

Motivo detalhado que descreve o motivo pelo qual essa instância de alerta é adicionada a um grupo inteligente
sourceCreatedId

string

ID exclusiva criada pelo serviço monitor para cada instância de alerta. Isso pode ser usado para acompanhar o problema no serviço monitor, no caso de Nagios, Zabbix, SCOM etc.
startDateTime

string

Hora de criação (formato ISO-8601) da instância de alerta.
targetResource

string

Recurso ARM de destino, no qual o alerta foi criado.
targetResourceGroup

string

Grupo de recursos do recurso ARM de destino, no qual o alerta foi criado.
targetResourceName

string

Nome do nome do recurso ARM de destino, no qual o alerta foi criado.
targetResourceType

string

Tipo de recurso do recurso ARM de destino, no qual o alerta foi criado.

MonitorCondition

Condição da regra no serviço monitor. Ele representa se as condições subjacentes cruzaram os limites de regra de alerta definidos.

Nome Tipo Description
Fired

string

Resolved

string

MonitorService

Monitore o serviço no qual a regra (monitor) está definida.

Nome Tipo Description
ActivityLog Administrative

string

ActivityLog Autoscale

string

ActivityLog Policy

string

ActivityLog Recommendation

string

ActivityLog Security

string

Application Insights

string

Log Analytics

string

Nagios

string

Platform

string

Resource Health

string

SCOM

string

ServiceHealth

string

SmartDetector

string

VM Insights

string

Zabbix

string

Severity

Gravidade do alerta Sev0 sendo o mais alto e Sev4 sendo o mais baixo.

Nome Tipo Description
Sev0

string

Sev1

string

Sev2

string

Sev3

string

Sev4

string

SignalType

O tipo de sinal no qual o alerta se baseia, que pode ser métricas, logs ou logs de atividades.

Nome Tipo Description
Log

string

Metric

string

Unknown

string