Microsoft Outlook イベント

この記事では、Microsoft Graph API から発行される Microsoft Outlook イベントのプロパティとスキーマについて説明します。 イベント スキーマの概要については、CloudEvents スキーマに関する記事を参照してください。

使用可能なイベントの種類

これらのイベントがトリガーされるのは、Outlook イベントまたは Outlook の連絡先が作成、更新、または削除されたとき、または Microsoft Graph API を使ってそれらのリソースに対して操作したときです。

イベント名	説明
Microsoft.Graph.EventCreated	Outlook のイベントが作成されたときにトリガーされます。
Microsoft.Graph.EventUpdated	Outlook のイベントが更新されたときにトリガーされます。
Microsoft.Graph.EventDeleted	Outlook のイベントが削除されたときにトリガーされます。
Microsoft.Graph.ContactCreated	Outlook の連絡先が作成されたときにトリガーされます。
Microsoft.Graph.ContactUpdated	Outlook の連絡先が更新されたときにトリガーされます。
Microsoft.Graph.ContactDeleted	Outlook の連絡先が削除されたときにトリガーされます。

イベントの例

イベントがトリガーされると、Event Grid サービスにより、そのイベントに関するデータがサブスクライブしている宛先に送信されます。 このセクションには、各 Outlook イベントでそのデータがどのように見えるかの例が含まれています。

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>"
		}
	}
}

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>"
		}
	}
}

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>"
		}
	}
}

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>"
		}
	}
}

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>"
		}
	}
}

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>"
		}
	}
}

イベントのプロパティ

イベントのトップレベルのデータを次に示します。

プロパティ	Type	説明
source	string	テナント イベント ソース。 このフィールドは書き込み可能ではありません。 この値は Microsoft Graph API によって指定されます。
subject	string	発行元が定義したイベントの対象のパス。
type	string	このイベント ソース用イベントの種類のいずれか。
time	string	プロバイダーの UTC 時刻に基づくイベントの生成時刻。
id	string	イベントの一意識別子。
data	object	リソースの状態変更に関するデータを提供するイベント ペイロード。
specversion	string	CloudEvents スキーマ仕様バージョン。

---

データ オブジェクトには、次のプロパティがあります。

プロパティ	Type	説明
changeType	string	リソースの状態変更の種類。
resource	string	イベントが発生したリソースの識別子。
tenantId	string	ユーザーまたは連絡先が保持されている組織 ID。
clientState	string	Graph API サブスクリプションの作成時にユーザーが指定したシークレット。
@odata.type	string	Graph API の変更の種類。
@odata.id	string	イベントが発生した Graph API リソースの識別子。
id	string	イベントが発生したリソースの識別子。
organizationId	string	Outlook テナント識別子。
eventTime	string	そのリソースの状態が発生した時刻。
sequenceNumber	string	シーケンス番号です。
subscriptionExpirationDateTime	string	Graph API サブスクリプションが期限切れになる RFC 3339 形式の時刻。
subscriptionId	string	Graph API サブスクリプション識別子。
tenantId	string	Outlook テナント識別子。
otherResourceData	string	イベントに含まれる可能性のある、1 つ以上の動的プロパティを表すプレースホルダー。

次のステップ

• Azure Event Grid のパートナー イベントの概要については、パートナー イベントの概要に関する記事を参照してください。
• Outlook イベントを受け取るために Microsoft Graph API イベントをサブスクライブする方法については、Azure Graph API イベントをサブスクライブする方法に関する記事を参照してください。
• Azure Event Grid イベント ハンドラーの詳細については、イベント ハンドラーに関する記事を参照してください。
• Azure Event Grid サブスクリプションの作成の詳細については、「イベント サブスクリプションの作成」と「Event Grid サブスクリプション スキーマ」を参照してください。
• 配信する特定のイベントを選ぶようにイベント サブスクリプションを構成する方法の詳細については、イベントのフィルター処理に関する記事を参照してください。 イベントをフィルター処理する方法に関するページも参考になります。