Alerts - Get All

Referência

Serviço:: Monitor

Versão da API:: 2023-07-12-preview

Liste todos os alertas existentes, em que os resultados podem ser filtrados com base em vários parâmetros (por exemplo, intervalo de tempo). Em seguida, os resultados podem ser classificados com base em campos específicos, com o padrão sendo lastModifiedDateTime.

GET https://management.azure.com/{scope}/providers/Microsoft.AlertsManagement/alerts?api-version=2023-07-12-preview

Com parâmetros opcionais:

GET https://management.azure.com/{scope}/providers/Microsoft.AlertsManagement/alerts?targetResource={targetResource}&targetResourceType={targetResourceType}&targetResourceGroup={targetResourceGroup}&monitorService={monitorService}&monitorCondition={monitorCondition}&severity={severity}&alertState={alertState}&alertRule={alertRule}&smartGroupId={smartGroupId}&includeContext={includeContext}&includeEgressConfig={includeEgressConfig}&pageCount={pageCount}&sortBy={sortBy}&sortOrder={sortOrder}&select={select}&timeRange={timeRange}&customTimeRange={customTimeRange}&api-version=2023-07-12-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
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.
alertRule	query		string	Filtrar por regra de alerta específica. O valor padrão é selecionar todos.
alertState	query		AlertState	Filtre por estado da instância de alerta. O valor padrão é selecionar todos.
customTimeRange	query		string	Filtre por intervalo de tempo personalizado no formato/em que o tempo está (formato ISO-8601)'. Os valores permitidos estão dentro de 30 dias a partir do tempo de consulta. TimeRange ou customTimeRange podem ser usados, mas não ambos. O padrão é nenhum.
includeContext	query		boolean	Inclua o contexto que tem dados contextuais específicos para o serviço monitor. O valor padrão é false'
includeEgressConfig	query		boolean	Inclua a configuração de saída que seria usada para exibir o conteúdo no portal. O valor padrão é 'false'.
monitorCondition	query		MonitorCondition	Filtre por condição de monitor, que é 'Acionado' ou 'Resolvido'. O valor padrão é selecionar todos.
monitorService	query		MonitorService	Filtre pelo serviço monitor que gera a instância de alerta. O valor padrão é selecionar todos.
pageCount	query		integer int64	Determina o número de alertas retornados por página em resposta. O valor permitido está entre 1 e 250. Quando o filtro "includeContent" é selecionado, o valor máximo permitido é 25. O valor padrão é 25.
select	query		string	Esse filtro permite a seleção dos campos (separados por vírgula), que seriam parte da seção essencial. Isso permitiria projetar apenas os campos necessários em vez de obter todo o conteúdo. O padrão é buscar todos os campos na seção essentials.
severity	query		Severity	Filtrar por gravidade. O valor padrão é selecionar todos.
smartGroupId	query		string	Filtre a lista de alertas pela ID do Grupo Inteligente. O valor padrão é nenhum.
sortBy	query		AlertsSortByFields	Classifique os resultados da consulta por campo de entrada, o valor padrão é 'lastModifiedDateTime'.
sortOrder	query		SortOrder	Classifique a ordem de resultados da consulta em ordem crescente ou decrescente. O valor padrão é 'desc' para campos de tempo e 'asc' para outras pessoas.
targetResource	query		string	Filtrar por recurso de destino( que é a ID completa do ARM) O valor padrão é selecionar todos.
targetResourceGroup	query		string	Filtre pelo nome do grupo de recursos de destino. O valor padrão é selecionar todos.
targetResourceType	query		string	Filtrar por tipo de recurso de destino. O valor padrão é selecionar todos.
timeRange	query		TimeRange	Filtre por intervalo de tempo pelos valores listados abaixo. O valor padrão é 1 dia.

Respostas

Nome	Tipo	Description
200 OK	alertsList	OK. Objetos de alerta listados com êxito.
Other Status Codes	errorResponse	Resposta de erro que descreve por que a operação falhou.

Exemplos

ListAlerts

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alerts?api-version=2023-07-12-preview

Resposta de exemplo

Código de status:: 200

{
  "nextLink": "https://management.azure.com:443/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alerts?api-version=2018-05-05-preview&timeRange=1d&ctoken=%2bRID%3aPlwOAPHEGwB9UwEAAAAgCw%3d%3d%23RT%3a2%23TRC%3a500%23RTD%3aqtQyMDE4LTA2LTEyVDE1OjEyOjE1",
  "value": [
    {
      "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://servisdffsdf.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"
    },
    {
      "properties": {
        "essentials": {
          "severity": "Sev3",
          "signalType": "Log",
          "alertState": "New",
          "monitorCondition": "Fired",
          "monitorService": "Application Insights",
          "targetResource": "/subscriptions/3b540246-808d-4331-99aa-917b808a9166/resourcegroups/cind/providers/microsoft.operationalinsights/workspaces/servicedeskwcus",
          "targetResourceName": "servicedeskwcus",
          "targetResourceGroup": "servicedeskresourcegroup",
          "targetResourceType": "components",
          "sourceCreatedId": "6cd6b2ce-8c54-468f-aff0-9d12aebb7e49",
          "smartGroupId": "d1c49c89-ea95-4697-a299-c0f5ebac62f1",
          "smartGroupingReason": "Alerts that frequently occur together have been grouped.",
          "alertRule": "https://servicsdfsdf.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
alertsList	Listar os alertas.
AlertsSortByFields	Classifique os resultados da consulta por campo de entrada, o valor padrão é 'lastModifiedDateTime'.
AlertState	Estado do objeto de alerta, que pode ser modificado pelo usuário.
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.
SortOrder	Classifique a ordem de resultados da consulta em ordem crescente ou decrescente. O valor padrão é 'desc' para campos de tempo e 'asc' para outras pessoas.
TimeRange	Filtre por intervalo de tempo pelos valores listados abaixo. O valor padrão é 1 dia.

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.

alertsList

Listar os alertas.

Nome	Tipo	Description
nextLink	string	URL para buscar o próximo conjunto de alertas.
value	alert[]	Lista de alertas

AlertsSortByFields

Classifique os resultados da consulta por campo de entrada, o valor padrão é 'lastModifiedDateTime'.

Nome	Tipo	Description
alertState	string
lastModifiedDateTime	string
monitorCondition	string
name	string
severity	string
startDateTime	string
targetResource	string
targetResourceGroup	string
targetResourceName	string
targetResourceType	string

AlertState

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

Nome	Tipo	Description
Acknowledged	string
Closed	string
New	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

SortOrder

Classifique a ordem de resultados da consulta em ordem crescente ou decrescente. O valor padrão é 'desc' para campos de tempo e 'asc' para outras pessoas.

Nome	Tipo	Description
asc	string
desc	string

TimeRange

Filtre por intervalo de tempo pelos valores listados abaixo. O valor padrão é 1 dia.

Nome	Tipo	Description
1d	string
1h	string
30d	string
7d	string

Compartilhar via