Tipos de eventos e esquema do Microsoft Entra no Azure Event Grid

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

Tipos de eventos Microsoft Entra disponíveis

A Microsoft Graph API publica os seguintes eventos Microsoft Entra no Azure Event Grid. Estes eventos são ativados quando um Utilizador ou Grupo é criado, atualizado ou eliminado no Microsoft Entra ID, ou quando esses recursos são modificados através da Microsoft Graph API.

Nota

Atualmente, um problema conhecido faz com que seja gerado um evento UserUpdated ou GroupUpdated quando é criado um utilizador ou um grupo.

Nome do evento Descrição
Microsoft.Graph.UserUpdated 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.GroupUpdated 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 defeito, eliminar um utilizador ou um grupo é uma operação de eliminação suave. O utilizador ou grupo está marcado como eliminado, mas o utilizador ou objeto de grupo ainda existe. A Microsoft Graph API envia um UserUpdated evento ou GroupUpdated quando um utilizador ou grupo é eliminado suavemente. Para eliminar permanentemente um utilizador, vá à página Eliminar utilizadores no portal Azure e selecione Eliminar permanentemente. As etapas para excluir permanentemente um grupo são semelhantes.

Exemplos de eventos Microsoft Entra

Quando um evento Microsoft Entra é ativado, o Azure Event Grid envia dados sobre esse evento para destinos subscritores. As secções seguintes mostram exemplos de cargas úteis JSON para cada tipo de evento.

evento Microsoft.Graph.UserUpdated

{
  "id": "0000aaaa-11bb-cccc-dd22-eeeeee333333",
  "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": "1111bbbb-22cc-dddd-ee33-ffffff444444",
  "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": "2222cccc-33dd-eeee-ff44-aaaaaa555555",
  "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 de Microsoft.Graph.GroupDeleted

{
  "id": "3333dddd-44ee-ffff-aa55-bbbbbbbb6666",
  "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 Microsoft Entra

Um evento Microsoft Entra tem as seguintes propriedades de topo:

Propriedade Tipo Descrição
source cadeia (de caracteres) A origem do evento do inquilino. Este campo não é editável. A API do Microsoft Graph fornece esse valor.
subject cadeia (de caracteres) Caminho definido pelo publicador para o assunto do evento.
type cadeia (de caracteres) Um dos tipos de evento desta fonte de evento.
time cadeia (de caracteres) A hora em que o evento é gerado, com base na hora UTC do fornecedor.
id cadeia (de caracteres) Identificador exclusivo do evento.
data objecto Carga útil do evento que contém os dados relativos à alteração do estado do recurso.
specversion cadeia (de caracteres) Versão da especificação do esquema CloudEvents.

Propriedades do objeto de dados

O data objeto num evento Microsoft Entra tem as seguintes propriedades:

Propriedade Tipo Descrição
changeType cadeia (de caracteres) O tipo de alteração do estado do recurso, como created, updated, ou deleted.
resource cadeia (de caracteres) O identificador de recurso para o qual o evento foi gerado.
clientState cadeia (de caracteres) Um segredo fornecido por si ao criar a subscrição da API Microsoft Graph.
@odata.type cadeia (de caracteres) O tipo de alteração da API do Microsoft Graph.
@odata.id cadeia (de caracteres) O identificador de recurso Microsoft Graph API para o qual o evento foi gerado.
id cadeia (de caracteres) O identificador de recurso para o qual o evento foi gerado.
organizationId cadeia (de caracteres) O identificador de inquilino do Microsoft Entra.
eventTime cadeia (de caracteres) A hora em que o estado do recurso foi alterado.
sequenceNumber cadeia (de caracteres) Um número sequencial.
subscriptionExpirationDateTime cadeia (de caracteres) A data e hora, no formato Request for Comments (RFC) 3339, à qual a subscrição da API Microsoft Graph expira.
subscriptionId cadeia (de caracteres) O identificador de subscrição da API Microsoft Graph.
tenantId cadeia (de caracteres) O identificador do tenant do Microsoft Entra.

Conteúdos relacionados

  • Last updated on