Eventos do Microsoft Entra

Artigo
06/14/2024

Este artigo fornece as propriedades e o esquema para eventos do Microsoft Entra, que são publicados pela API do Microsoft Graph. Para obter uma introdução aos esquemas de eventos, consulte Esquema CloudEvents.

Tipos de eventos disponíveis

Esses eventos são acionados quando um Usuário ou Grupo é criado, atualizado ou excluído na ID do Microsoft Entra ou operando sobre esses recursos usando a API do Microsoft Graph.

Nota

Atualmente, UserUpdated ou GroupUpdated evento é gerado quando um usuário ou um grupo é criado. É um problema conhecido e será corrigido na versão futura.

Nome do evento	Description
Microsoft.Graph.UserAtualizado	Acionado quando um usuário no Microsoft Entra ID é criado ou atualizado.
Microsoft.Graph.UserDeleted	Acionado quando um usuário no Microsoft Entra ID é excluído permanentemente.
Microsoft.Graph.GroupAtualizado	Acionado quando um grupo no Microsoft Entra ID é criado ou atualizado.
Microsoft.Graph.GroupDeleted	Acionado quando um grupo no Microsoft Entra ID é excluído permanentemente.

Nota

Por padrão, excluir um usuário ou um grupo é apenas uma operação de exclusão suave, o que significa que o usuário ou grupo é marcado como excluído, mas o usuário ou objeto de grupo ainda existe. O Microsoft Graph envia um evento atualizado quando os usuários são excluídos suavemente. Para excluir permanentemente um usuário, navegue até a página Excluir usuários no portal do Azure e selecione Excluir permanentemente. As etapas para excluir permanentemente um grupo são semelhantes.

Exemplo de evento

Quando um evento é acionado, o serviço Grade de Eventos envia dados sobre esse evento para os destinos de assinatura. Esta seção contém um exemplo da aparência desses dados para cada evento do Microsoft Entra.

Evento Microsoft.Graph.UserUpdated

{
  "id": "00d8a100-2e92-4bfa-86e1-0056dacd0fce",
  "type": "Microsoft.Graph.UserUpdated",
  "source": "/tenants/<tenant-id>/applications/<application-id>",
  "subject": "Users/<user-id>",
  "time": "2022-05-24T22:24:31.3062901Z",
  "datacontenttype": "application/json",
  "specversion": "1.0",
  "data": {
    "changeType": "updated",
    "clientState": "<guid>",
    "resource": "Users/<user-id>",
    "resourceData": {
      "@odata.type": "#Microsoft.Graph.User",
      "@odata.id": "Users/<user-id>",
      "id": "<user-id>",
      "organizationId": "<tenant-id>",
      "eventTime": "2022-05-24T22:24:31.3062901Z",
      "sequenceNumber": <sequence-number>
    },
    "subscriptionExpirationDateTime": "2022-05-24T23:21:19.3554403+00:00",
    "subscriptionId": "<microsoft-graph-subscription-id>",
    "tenantId": "<tenant-id>
  }
}

Evento Microsoft.Graph.UserDeleted

{
  "id": "00d8a100-2e92-4bfa-86e1-0056dacd0fce",
  "type": "Microsoft.Graph.UserDeleted",
  "source": "/tenants/<tenant-id>/applications/<application-id>",
  "subject": "Users/<user-id>",
  "time": "2022-05-24T22:24:31.3062901Z",
  "datacontenttype": "application/json",
  "specversion": "1.0",
  "data": {
    "changeType": "deleted",
    "clientState": "<guid>",
    "resource": "Users/<user-id>",
    "resourceData": {
      "@odata.type": "#Microsoft.Graph.User",
      "@odata.id": "Users/<user-id>",
      "id": "<user-id>",
      "organizationId": "<tenant-id>",
      "eventTime": "2022-05-24T22:24:31.3062901Z",
      "sequenceNumber": <sequence-number>
    },
    "subscriptionExpirationDateTime": "2022-05-24T23:21:19.3554403+00:00",
    "subscriptionId": "<microsoft-graph-subscription-id>",
    "tenantId": "<tenant-id>
  }
}

Evento Microsoft.Graph.GroupUpdated

{
  "id": "00d8a100-2e92-4bfa-86e1-0056dacd0fce",
  "type": "Microsoft.Graph.GroupUpdated",
  "source": "/tenants/<tenant-id>/applications/<application-id>",
  "subject": "Groups/<group-id>",
  "time": "2022-05-24T22:24:31.3062901Z",
  "datacontenttype": "application/json",
  "specversion": "1.0",
  "data": {
    "changeType": "updated",
    "clientState": "<guid>",
    "resource": "Groups/<group-id>",
    "resourceData": {
      "@odata.type": "#Microsoft.Graph.Group",
      "@odata.id": "Groups/<group-id>",
      "id": "<group-id>",
      "organizationId": "<tenant-id>",
      "eventTime": "2022-05-24T22:24:31.3062901Z",
      "sequenceNumber": <sequence-number>
    },
    "subscriptionExpirationDateTime": "2022-05-24T23:21:19.3554403+00:00",
    "subscriptionId": "<microsoft-graph-subscription-id>",
    "tenantId": "<tenant-id>
  }
}

Evento Microsoft.Graph.GroupDeleted

{
  "id": "00d8a100-2e92-4bfa-86e1-0056dacd0fce",
  "type": "Microsoft.Graph.GroupDeleted",
  "source": "/tenants/<tenant-id>/applications/<application-id>",
  "subject": "Groups/<group-id>",
  "time": "2022-05-24T22:24:31.3062901Z",
  "datacontenttype": "application/json",
  "specversion": "1.0",
  "data": {
    "changeType": "deleted",
    "clientState": "<guid>",
    "resource": "Groups/<group-id>",
    "resourceData": {
      "@odata.type": "#Microsoft.Graph.Group",
      "@odata.id": "Groups/<group-id>",
      "id": "<group-id>",
      "organizationId": "<tenant-id>",
      "eventTime": "2022-05-24T22:24:31.3062901Z",
      "sequenceNumber": <sequence-number>
    },
    "subscriptionExpirationDateTime": "2022-05-24T23:21:19.3554403+00:00",
    "subscriptionId": "<microsoft-graph-subscription-id>",
    "tenantId": "<tenant-id>
  }
}

Propriedades do evento

Um evento tem os seguintes dados de nível superior:

Propriedade	Type	Description
`source`	string	A origem do evento do locatário. Este campo não pode ser gravado. A API do Microsoft Graph fornece esse valor.
`subject`	string	Caminho definido pelo publicador para o assunto do evento.
`type`	string	Um dos tipos de evento para essa fonte de evento.
`time`	string	A hora em que o evento é gerado com base na hora UTC do provedor
`id`	string	Identificador exclusivo do evento.
`data`	objeto	Carga útil do evento que fornece os dados sobre a alteração do estado do recurso.
`specversion`	string	Versão da especificação do esquema CloudEvents.

O objeto de dados tem as seguintes propriedades:

Propriedade	Type	Description
`changeType`	string	O tipo de alteração do estado do recurso.
`resource`	string	O identificador de recurso para o qual o evento foi gerado.
`tenantId`	string	O ID da organização onde o usuário ou grupo é mantido.
`clientState`	string	Um segredo fornecido pelo usuário no momento da criação da assinatura da Graph API.
`@odata.type`	string	O tipo de alteração da API do Graph.
`@odata.id`	string	O identificador de recurso da API do Graph para o qual o evento foi gerado.
`id`	string	O identificador de recurso para o qual o evento foi gerado.
`organizationId`	string	O identificador de locatário do Microsoft Entra.
`eventTime`	string	A hora em que o estado do recurso foi alterado.
`sequenceNumber`	string	Um número sequencial.
`subscriptionExpirationDateTime`	string	A hora no formato RFC 3339 em que a assinatura da Graph API expira.
`subscriptionId`	string	O identificador de assinatura da API do Graph.
`tenantId`	string	O identificador de locatário do Microsoft Entra.

Próximos passos

Para obter uma introdução aos Eventos de Parceiros da Grade de Eventos do Azure, consulte Visão geral de Eventos de Parceiros
Para obter informações sobre como assinar a API do Microsoft Graph para receber eventos do Microsoft Entra, consulte Inscrever-se em eventos da API do Azure Graph.
Para obter informações sobre manipuladores de eventos da Grade de Eventos do Azure, consulte Manipuladores de eventos.
Para obter mais informações sobre como criar uma assinatura da Grade de Eventos do Azure, consulte Criar assinatura de evento e esquema de assinatura da Grade de Eventos.
Para obter informações sobre como configurar uma assinatura de evento para selecionar eventos específicos a serem entregues, consulte filtragem de eventos.

Partilhar via