Recuperar dados do log de atividades usando a API REST do Azure Monitor

  • Artigo

O Log de Atividades do Azure é um log que fornece insights sobre as operações executadas em recursos em sua assinatura. As operações incluem criar, atualizar, excluir e outras ações executadas em recursos. O Log de Atividades é um log em toda a plataforma e não está limitado a um serviço específico. Este artigo explica como recuperar dados do log de atividades usando a API REST do Azure Monitor. Para obter mais informações sobre o log de atividades, confira Esquema de eventos do Log de Atividades do Azure.

Autenticação

Para recuperar logs de recursos, você precisa se autenticar com o Microsoft Entra. Para obter mais informações, consulte o passo a passo da API REST de monitoramento do Azure.

Recuperar dados do Log de Atividades

Use a API REST do Azure Monitor para consultar os dados do log de atividades.

O formato de solicitação a seguir é usado para solicitar dados do log de atividades.

GET /subscriptions/<subscriptionId>/providers/Microsoft.Insights/eventtypes/management/values \
?api-version=2015-04-01 \
&$filter=<filter> \
&$select=<select>
host: management.azure.com
authorization: Bearer <token>

$filter

$filter reduz o conjunto de dados coletados. Esse argumento é necessário e também requer pelo menos a data/hora de início. O argumento $filter filter aceita os seguintes padrões:

  • Listar eventos para um grupo de recursos: $filter=eventTimestamp ge '2014-07-16T04:36:37.6407898Z' and eventTimestamp le '2014-07-20T04:36:37.6407898Z' and resourceGroupName eq <resourceGroupName>.
  • Listar eventos para um recurso específico: $filter=eventTimestamp ge '2014-07-16T04:36:37.6407898Z' and eventTimestamp le '2014-07-20T04:36:37.6407898Z' and resourceUri eq <resourceURI>.
  • Listar eventos para uma assinatura em um intervalo de tempo: $filter=eventTimestamp ge '2014-07-16T04:36:37.6407898Z' and eventTimestamp le '2014-07-20T04:36:37.6407898Z'.
  • Listar eventos para um provedor de recursos: $filter=eventTimestamp ge '2014-07-16T04:36:37.6407898Z' and eventTimestamp le '2014-07-20T04:36:37.6407898Z' and resourceProvider eq <resourceProviderName>.
  • Listar eventos para uma ID de correlação: $filter=eventTimestamp ge '2014-07-16T04:36:37.6407898Z' and eventTimestamp le '2014-07-20T04:36:37.6407898Z' and correlationId eq '<correlationID>.

$select

$select busca uma lista especificada de propriedades para os eventos retornados. O argumento $select é uma lista separada por vírgulas de nomes de propriedade a serem retornados. Os valores válidos são: authorization, claims, correlationId, description, eventDataId, eventName, eventTimestamp, httpRequest, level, operationId, operationName, properties, resourceGroupName, resourceProviderName, resourceId, status, submissionTimestamp, subStatus e subscriptionId.

As solicitações de exemplo a seguir usam a API REST do Azure Monitor para consultar um log de atividades.

Obter logs de atividades com filtro:

O exemplo a seguir obtém os logs de atividades do grupo de recursos MSSupportGroup entre as datas 2023-03-21T20:00:00Z e 2023-03-24T20:00:00Z

GET https://management.azure.com/subscriptions/12345678-abcd-98765432-abcdef012345/providers/microsoft.insights/eventtypes/management/values?api-version=2015-04-01&$filter=eventTimestamp ge '2023-03-21T20:00:00Z' and eventTimestamp le '2023-03-24T20:00:00Z' and resourceGroupName eq 'MSSupportGroup'

Obter logs de atividades com filtro e selecionar:

O exemplo a seguir obtém os logs de atividade para o grupo de recursos MSSupportGroup, entre as datas 2023-03-21T20:00:00Z e 2023-03-24T20:00:00Z, retornando os elementos eventName,operationName,status,eventTimestamp,correlationId,submissionTimestamp e nível.

GET https://management.azure.com/subscriptions/12345678-abcd-98765432-abcdef012345/providers/microsoft.insights/eventtypes/management/values?api-version=2015-04-01&$filter=eventTimestamp ge '2023-03-21T20:00:00Z' and eventTimestamp le '2023-03-24T20:00:00Z'and resourceGroupName eq 'MSSupportGroup'&$select=eventName,operationName,status,eventTimestamp,correlationId,submissionTimestamp,level

Próximas etapas

Transmitir dados do log de atividades do Azure Monitor. Esquema de eventos do log de atividades do Azure.