Alerts - Get All

Referência

Serviço:: Monitor

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

Listar todos os alertas existentes, onde os resultados podem ser filtrados com base em vários parâmetros (por exemplo, intervalo de tempo). 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 do URI

Name	Em	Necessário	Tipo	Description
scope	path	True	string	escopo aqui é resourceId para o qual o alerta é criado.
api-version	query	True	string minLength: 1	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	Filtrar por intervalo de tempo personalizado no formato / onde o tempo está (formato ISO-8601)'. Os valores permitidos estão dentro de 30 dias a partir do momento da 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 de 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 do monitor que é 'Acionado' ou 'Resolvido'. O valor padrão é selecionar todos.
monitorService	query		MonitorService	Filtrar por serviço de monitor que gera a instância de alerta. O valor padrão é selecionar tudo.
pageCount	query		integer (int64)	Determina o número de alertas retornados por página em resposta. O valor admissível situa-se entre 1 e 250. Quando o filtro "includeContent" é selecionado, o valor máximo permitido é 25. O valor padrão é 25.
select	query		string	Este filtro permite a seleção dos campos (separados por vírgula) que fariam parte da seção essencial. Isso permitiria projetar apenas os campos obrigatórios em vez de obter conteúdo inteiro. O padrão é buscar todos os campos na seção essencial.
severity	query		Severity	Filtrar por gravidade. O valor padrão é selecionar tudo.
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 dos resultados da consulta em crescente ou decrescente. O valor padrão é 'desc' para campos de tempo e 'asc' para outros.
targetResource	query		string	Filtrar por recurso de destino( que é ID ARM completo) O valor padrão é selecionar todos.
targetResourceGroup	query		string	Filtrar por nome do grupo de recursos de destino. O valor padrão é selecionar tudo.
targetResourceType	query		string	Filtrar por tipo de recurso de destino. O valor padrão é selecionar tudo.
timeRange	query		TimeRange	Filtre por intervalo de tempo pelos valores abaixo listados. O valor padrão é 1 dia.

Respostas

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

Exemplos

ListAlerts

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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

Name	Description
actionStatus	Estado da ação
alert	Um alerta criado no serviço de gerenciamento de alertas.
alertProperties	Saco de propriedade de alerta
alertsList	Liste 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 ao erro.
essentials	Este objeto contém campos consistentes em diferentes serviços de monitor.
MonitorCondition	Condição da regra no serviço de monitor. Representa se as condições subjacentes ultrapassaram os limites da regra de alerta definidos.
MonitorService	Serviço de monitoramento no qual a regra (monitor) está definida.
Severity	A gravidade do alerta é a mais elevada e a Sev4 a mais baixa.
SignalType	O tipo de sinal em que o alerta se baseia, que pode ser métricas, logs ou registros de atividades.
SortOrder	Classifique a ordem dos resultados da consulta em crescente ou decrescente. O valor padrão é 'desc' para campos de tempo e 'asc' para outros.
TimeRange	Filtre por intervalo de tempo pelos valores abaixo listados. O valor padrão é 1 dia.

actionStatus

Object

Estado da ação

Name	Tipo	Description
isSuppressed	boolean	Valor que indica se o alerta foi suprimido.

alert

Object

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

Name	Tipo	Description
id	string	ID do recurso do Azure
name	string	Nome do recurso do Azure
properties	alertProperties	Saco de propriedade de alerta
type	string	Tipo de recurso do Azure

alertProperties

Object

Saco de propriedade de alerta

Name	Tipo	Description
context	object	Informações específicas do serviço de monitorização que fornecem mais detalhes contextuais sobre o alerta.
egressConfig	object	Configuração que seria usada para exibir os dados no portal.
essentials	essentials	Este objeto contém campos consistentes em diferentes serviços de monitor.

alertsList

Object

Liste os alertas.

Name	Tipo	Description
nextLink	string	URL para buscar o próximo conjunto de alertas.
value	alert[]	Lista de indicações

AlertsSortByFields

Enumeração

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

Valor	Description
alertState
lastModifiedDateTime
monitorCondition
name
severity
startDateTime
targetResource
targetResourceGroup
targetResourceName
targetResourceType

AlertState

Enumeração

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

Valor	Description
Acknowledged
Closed
New

errorResponse

Object

Uma resposta de erro do serviço.

Name	Tipo	Description
error	errorResponseBody	Detalhes da resposta ao erro.

errorResponseBody

Object

Detalhes da resposta ao erro.

Name	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 a exibição na interface do usuário.
target	string	Destino do erro específico, por exemplo, nome da propriedade.

essentials

Object

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

Name	Tipo	Description
actionStatus	actionStatus	Estado da ação
alertRule	string	Rule(monitor) que disparou a instância de alerta. Dependendo do serviço de monitor, isso seria ID ARM ou 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 (date-time)	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 usuário seria 'sistema', caso contrário, nome do usuário.
monitorCondition	MonitorCondition	Condição da regra no serviço de monitor. Representa se as condições subjacentes ultrapassaram os limites da regra de alerta definidos.
monitorConditionResolvedDateTime	string (date-time)	Tempo resolvido (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 da regra não é mais atendida.
monitorService	MonitorService	Serviço de monitoramento no qual a regra (monitor) está definida.
severity	Severity	A gravidade do alerta é a mais elevada e a Sev4 a mais baixa.
signalType	SignalType	O tipo de sinal em que o alerta se baseia, que pode ser métricas, logs ou registros de atividades.
smartGroupId	string	ID exclusivo 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 exclusivo criado pelo serviço de monitor para cada instância de alerta. Isso poderia ser usado para rastrear o problema no serviço de monitor, no caso de Nagios, Zabbix, SCOM etc.
startDateTime	string (date-time)	Tempo 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

Enumeração

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

Valor	Description
Fired
Resolved

MonitorService

Enumeração

Serviço de monitoramento no qual a regra (monitor) está definida.

Valor	Description
ActivityLog Administrative
ActivityLog Autoscale
ActivityLog Policy
ActivityLog Recommendation
ActivityLog Security
Application Insights
Log Analytics
Nagios
Platform
Resource Health
SCOM
ServiceHealth
SmartDetector
VM Insights
Zabbix

Severity

Enumeração

A gravidade do alerta é a mais elevada e a Sev4 a mais baixa.

Valor	Description
Sev0
Sev1
Sev2
Sev3
Sev4

SignalType

Enumeração

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

Valor	Description
Log
Metric
Unknown

SortOrder

Enumeração

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

Valor	Description
asc
desc

TimeRange

Enumeração

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

Valor	Description
1d
1h
30d
7d

Partilhar via

Alerts - Get All

Parâmetros do URI

Respostas

Exemplos

ListAlerts

Pedido de amostra

Resposta da amostra

Definições

actionStatus

alert

alertProperties

alertsList

AlertsSortByFields

AlertState

errorResponse

errorResponseBody

essentials

MonitorCondition

MonitorService

Severity

SignalType

SortOrder

TimeRange

Recursos adicionais