Eventos do Microsoft Outlook

Artigo
06/01/2023

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

Tipos de evento disponíveis

Esses eventos são disparados quando um evento do Outlook ou um contato do Outlook é criado, atualizado ou excluído ou em operações com esses recursos usando a API do Microsoft Graph.

Nome do evento	Descrição
Microsoft.Graph.EventCreated	Disparado quando um evento no Outlook é criado.
Microsoft.Graph.EventUpdated	Disparado quando um evento no Outlook é atualizado.
Microsoft.Graph.EventDeleted	Disparado quando um evento no Outlook é excluído.
Microsoft.Graph.ContactCreated	Disparado quando um contato no Outlook é criado.
Microsoft.Graph.ContactUpdated	Disparado quando um contato no Outlook é atualizado.
Microsoft.Graph.ContactDeleted	Disparado quando um contato no Outlook é excluído.

Exemplo de evento

Quando um evento é disparado, o serviço Grade de Eventos envia dados sobre esse evento aos destinos assinantes. Esta seção mostra um exemplo de como seriam os dados de cada evento.

Evento Microsoft.Graph.EventCreated

{
	"id": "00d8a100-2e92-4bfa-86e1-0056dacd0fce",
	"type": "Microsoft.Graph.EventCreated",
	"source": "/tenants/<tenant-id>/applications/<application-id>",
	"subject": "Events/<event-id>",
	"time": "2022-05-24T22:24:31.3062901Z",
	"datacontenttype": "application/json",
	"specversion": "1.0",
	"data": {
		"@odata.type": "#Microsoft.OutlookServices.Notification",
		"Id": null,
		"SubscriptionExpirationDateTime": "2019-02-14T23:56:30.1307708Z",
		"ChangeType": "created",
		"subscriptionId": "MTE1MTVlYTktMjVkZS00MjY3LWI1YzYtMjg0NzliZmRhYWQ2",
		"resource": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Events('<event id>')",
		"clientState": "<client state>",
		"resourceData": {
			"Id": "<event id>",
			"@odata.etag": "<tag id>",
			"@odata.id": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Events('<event id>')",
			"@odata.type": "#Microsoft.OutlookServices.Event",
			"OtherResourceData": "<some other resource data>"
		}
	}
}

Evento Microsoft.Graph.EventUpdated

{
	"id": "00d8a100-2e92-4bfa-86e1-0056dacd0fce",
	"type": "Microsoft.Graph.EventUpdated",
	"source": "/tenants/<tenant-id>/applications/<application-id>",
	"subject": "Events/<event-id>",
	"time": "2022-05-24T22:24:31.3062901Z",
	"datacontenttype": "application/json",
	"specversion": "1.0",
	"data": {
		"@odata.type": "#Microsoft.OutlookServices.Notification",
		"Id": null,
		"SubscriptionExpirationDateTime": "2019-02-14T23:56:30.1307708Z",
		"ChangeType": "updated",
		"subscriptionId": "MTE1MTVlYTktMjVkZS00MjY3LWI1YzYtMjg0NzliZmRhYWQ2",
		"resource": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Events('<event id>')",
		"clientState": "<client state>",
		"resourceData": {
			"Id": "<event id>",
			"@odata.etag": "<tag id>",
			"@odata.id": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Events('<event id>')",
			"@odata.type": "#Microsoft.OutlookServices.Event",
			"OtherResourceData": "<some other resource data>"
		}
	}
}

Evento Microsoft.Graph.EventDeleted

{
	"id": "00d8a100-2e92-4bfa-86e1-0056dacd0fce",
	"type": "Microsoft.Graph.EventDeleted",
	"source": "/tenants/<tenant-id>/applications/<application-id>",
	"subject": "Events/<event-id>",
	"time": "2022-05-24T22:24:31.3062901Z",
	"datacontenttype": "application/json",
	"specversion": "1.0",
	"data": {
		"@odata.type": "#Microsoft.OutlookServices.Notification",
		"Id": null,
		"SubscriptionExpirationDateTime": "2019-02-14T23:56:30.1307708Z",
		"ChangeType": "deleted",
		"subscriptionId": "MTE1MTVlYTktMjVkZS00MjY3LWI1YzYtMjg0NzliZmRhYWQ2",
		"resource": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Events('<event id>')",
		"clientState": "<client state>",
		"resourceData": {
			"Id": "<event id>",
			"@odata.etag": "<tag id>",
			"@odata.id": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Events('<event id>')",
			"@odata.type": "#Microsoft.OutlookServices.Event",
			"OtherResourceData": "<some other resource data>"
		}
	}
}

Evento Microsoft.Graph.ContactCreated

{
	"id": "00d8a100-2e92-4bfa-86e1-0056dacd0fce",
	"type": "Microsoft.Graph.ContactCreated",
	"source": "/tenants/<tenant-id>/applications/<application-id>",
	"subject": "Contacts/<contact-id>",
	"time": "2022-05-24T22:24:31.3062901Z",
	"datacontenttype": "application/json",
	"specversion": "1.0",
	"data": {
		"@odata.type": "#Microsoft.OutlookServices.Notification",
		"Id": null,
		"SubscriptionExpirationDateTime": "2019-02-14T23:56:30.1307708Z",
		"ChangeType": "created",
		"subscriptionId": "MTE1MTVlYTktMjVkZS00MjY3LWI1YzYtMjg0NzliZmRhYWQ2",
		"resource": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Contacts('<contact id>')",
		"clientState": "<client state>",
		"resourceData": {
			"Id": "<contact id>",
			"@odata.etag": "<tag id>",
			"@odata.id": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Contacts('<contact id>')",
			"@odata.type": "#Microsoft.OutlookServices.Contact",
			"OtherResourceData": "<some other resource data>"
		}
	}
}

Evento Microsoft.Graph.ContactUpdated

{
	"id": "00d8a100-2e92-4bfa-86e1-0056dacd0fce",
	"type": "Microsoft.Graph.ContactUpdated",
	"source": "/tenants/<tenant-id>/applications/<application-id>",
	"subject": "Contacts/<contact-id>",
	"time": "2022-05-24T22:24:31.3062901Z",
	"datacontenttype": "application/json",
	"specversion": "1.0",
	"data": {
		"@odata.type": "#Microsoft.OutlookServices.Notification",
		"Id": null,
		"SubscriptionExpirationDateTime": "2019-02-14T23:56:30.1307708Z",
		"ChangeType": "updated",
		"subscriptionId": "MTE1MTVlYTktMjVkZS00MjY3LWI1YzYtMjg0NzliZmRhYWQ2",
		"resource": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Contacts('<contact id>')",
		"clientState": "<client state>",
		"resourceData": {
			"Id": "<contact id>",
			"@odata.etag": "<tag id>",
			"@odata.id": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Contacts('<contact id>')",
			"@odata.type": "#Microsoft.OutlookServices.Contact",
			"OtherResourceData": "<some other resource data>"
		}
	}
}

Evento Microsoft.Graph.ContactDeleted

{
	"id": "00d8a100-2e92-4bfa-86e1-0056dacd0fce",
	"type": "Microsoft.Graph.ContactDeleted",
	"source": "/tenants/<tenant-id>/applications/<application-id>",
	"subject": "Contacts/<contact-id>",
	"time": "2022-05-24T22:24:31.3062901Z",
	"datacontenttype": "application/json",
	"specversion": "1.0",
	"data": {
		"@odata.type": "#Microsoft.OutlookServices.Notification",
		"Id": null,
		"SubscriptionExpirationDateTime": "2019-02-14T23:56:30.1307708Z",
		"ChangeType": "deleted",
		"subscriptionId": "MTE1MTVlYTktMjVkZS00MjY3LWI1YzYtMjg0NzliZmRhYWQ2",
		"resource": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Contacts('<contact id>')",
		"clientState": "<client state>",
		"resourceData": {
			"Id": "<contact id>",
			"@odata.etag": "<tag id>",
			"@odata.id": "https://outlook.office365.com/api/beta/Users('userId@tenantId')/Contacts('<contact id>')",
			"@odata.type": "#Microsoft.OutlookServices.Contact",
			"OtherResourceData": "<some other resource data>"
		}
	}
}

Propriedades do evento

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

Propriedade	Type	Descrição
`source`	string	A origem do evento do locatário. Este campo não é gravável. 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 dessa origem do 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	Conteúdo do evento que fornece os dados sobre a alteração de estado do recurso.
`specversion`	string	Versão de especificação do esquema CloudEvents.

O objeto de dados tem as seguintes propriedades:

Propriedade	Type	Descrição
`changeType`	string	O tipo de alteração de estado do recurso.
`resource`	string	O identificador de recurso para o qual o evento foi gerado.
`tenantId`	string	A ID da organização que contém o usuário ou o contato.
`clientState`	string	Um segredo fornecido pelo usuário no momento da criação da assinatura da API do Graph.
`@odata.type`	string	O tipo de alteração da API do Graph.
`@odata.id`	string	O identificador do 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 do locatário do Outlook.
`eventTime`	string	A hora em que o estado do recurso ocorreu.
`sequenceNumber`	string	Um número de sequência.
`subscriptionExpirationDateTime`	string	A hora no formato RFC 3339 em que a assinatura da API do Graph expira.
`subscriptionId`	string	O identificador da assinatura da API do Graph.
`tenantId`	string	O identificador do locatário do Outlook.
`otherResourceData`	string	Espaço reservado que representa uma ou mais propriedades dinâmicas que podem ser incluídas no evento.

Próximas etapas

Para obter uma introdução aos Eventos de Parceiros da Grade de Eventos do Azure, confira Visão geral dos Eventos de Parceiros
Para obter informações de como assinar a API do Microsoft Graph para receber eventos do Outlook, confira assinar eventos da API do Graph do Azure.
Para obter informações sobre os manipuladores de eventos da Grade de Eventos do Azure, confira Manipuladores de eventos.
Para obter mais informações de como criar uma assinatura da Grade de Eventos do Azure, confira Criar assinatura de evento e Esquema de assinatura da Grade de Eventos.
Para obter informações de como configurar uma assinatura de evento para selecionar eventos específicos a serem entregues, confira Filtragem de eventos. Você também pode conferir Filtrar eventos.

Share via