Recommended
More Related Content
What's hot
What's hot (20)
Similar to Microsoft Graphの変更通知で遊ぶ
Similar to Microsoft Graphの変更通知で遊ぶ (20)
More from DevTakas
Microsoft Graphの変更通知で遊ぶ
- 2. 誰？ @DevTakas Angular / Azure / .NET Core / Azure DevOps / Microsoft Graph
- 4. おしながき 1. リソースの変更をどうやって検知することができるのか • Delta • Subscription 2. Subscriptionについて • 使えるリソースについて • 使いかた 3. Subscriptionを実装してみる 4. まとめ
- 5. (おさらい)Microsoft Graphとは • Microsoftが提供するサービス・データに アクセスできるエンドポイント • TeamsのチャットやOutlookのイベント、Excelデータ等々… • 単一エンドポイントhttps://graph.microsoft.comからアクセス
- 6. 1.リソースの変更をどうやって検知することができるのか ・Delta • Deltaクエリを利用する • Microsoftのドキュメント的には「変更履歴」 • 👇のクエリのように「delta」を利用する • https://graph.microsoft.com/v1.0/messages/delta/~~ • nextLink/deltaLinkプロパティにURLが返却される • そのURLにアクセスすると変更分のデータのみが返却される • サポートされるリソース • https://docs.microsoft.com/ja-jp/graph/delta-query-overview#supported-resources
- 8. 1.リソースの変更をどうやって検知することができるのか ・Deltaの特徴 • 状態トークンを含むURLを使用して変更リソースのみ取得 • つまり一発目のデータ取得は絶対に必要となる • クエリパラメータ込でデータ取得できる
- 9. 1.リソースの変更をどうやって検知することができるのか ・Subscription • Subscription(webhook)を利用する • Microsoftのドキュメント的には「変更通知」 • 👇のクエリのように「subscriptions」を利用する • https://graph.microsoft.com/v1.0/subscriptions • リソースの変更があった場合に指定したWeb APIがCallされる
- 10. 1.リソースの変更をどうやって検知することができるのか ・Subscriptionの特徴 • 一発目のデータ取得は不要 • 取得リソースの情報を取得することができない • 変更されたリソースのIDなどが通知される • 上記IDを利用し、Graph APIを使用して変更されたリソースを取得 • 有効期限は3日以内で指定する • （有効期限の更新はできる）
- 11. 2.Subscriptionについて ・使えるリソースについて • https://docs.microsoft.com/ja-jp/graph/api/subscription-post-subscriptions?view=graph-rest-1.0&tabs=http#resources-examples • 2019年12月の更新で、TeamsのchatMessageリソースがβに追加された • https://docs.microsoft.com/ja-jp/graph/changelog#change-notifications-webhooks
- 12. 2.Subscriptionについて ・使い方 • POST https://graph.microsoft.com/v1.0/subscriptions • bodyに購読したいリソースの情報などを格納する • Subscriptionは参照/作成/更新/削除が行える • 更新は有効期限の更新のみっぽい
- 14. 2.Subscriptionについて ・使い方 – bodyに格納する情報について(ひとまず作成する時のみ抜粋) • changeType - 変更の種類を指定 • 指定した種類によってwebhookが叩かれるタイミングが変化する • created: 指定されたリソースのデータ作成時 • updated:指定されたリソースのデータ更新時 • deleted:指定されたリソースのデータ削除時 • リソースによって指定できるものが異なっていたりする • driveリソースはupdateのみなど…
- 15. 2.Subscriptionについて ・使い方 – bodyに格納する情報について(ひとまず作成する時のみ抜粋) • notificationUrl：hookされる際に呼び出されるWebAPI • 通知エンドポイント • 検証依頼に応答できるWebAPIの必要がある 1. ValidationTokenクエリ付きのURLでアクセスされる 2. エンドポイントは下記の内容を返却する • 200ステータス • text/plainの検証トークン • 検証依頼に応答できた場合にSubscriptionが確立される
- 16. 2.Subscriptionについて ・使い方 – bodyに格納する情報について(ひとまず作成する時のみ抜粋) • resource：変更通知を行う元のリソース • 前ページに記載したドキュメントの通りに指定を行う • イベント：me/events • チャットの情報：chatMessage などなど…
- 17. 2.Subscriptionについて ・使い方 – bodyに格納する情報について(ひとまず作成する時のみ抜粋) • expirationDateTime：Subscriptionの有効期限を指定する • 3日以内の日付情報を指定する • この値はSubscriptionの更新クエリで更新することができる
- 18. 2.Subscriptionについて ・使い方 – どんなデータが通知されるのか { "value": [ { "subscriptionId": "86a8e9e3-dc4b-481e-a306-8c88734b3bdb", "subscriptionExpirationDateTime": "2020-04-06T13:54:06.928+00:00", "tenantId": "", "changeType": "updated", "resource": "Users/83b3c8a6d89d594e/Events/AQMkADAwATM3ZmYAZS1jNGMzL…", "resourceData": { "@odata.type": "#Microsoft.Graph.Event", "@odata.id": "Users/83b3c8a6d89d594e/Events/AQMkADAwATM3ZmYAZS1jNGM…", "@odata.etag": "W/"DwAAABYAAABd3/Ci/G7PSafc4e+O89crAAKe930M"", "id": "AQMkADAwATM3ZmYAZS…" }, "clientState": null } ] }
- 19. 2.Subscriptionについて ・使い方 – どんなデータが通知されるのか { "value": [ { "subscriptionId": "86a8e9e3-dc4b-481e-a306-8c88734b3bdb", "subscriptionExpirationDateTime": "2020-04-06T13:54:06.928+00:00", "tenantId": "", "changeType": "updated", "resource": "Users/83b3c8a6d89d594e/Events/AQMkADAwATM3ZmYAZS1jNGMzL…", "resourceData": { "@odata.type": "#Microsoft.Graph.Event", "@odata.id": "Users/83b3c8a6d89d594e/Events/AQMkADAwATM3ZmYAZS1jNGM…", "@odata.etag": "W/"DwAAABYAAABd3/Ci/G7PSafc4e+O89crAAKe930M"", "id": "AQMkADAwATM3ZmYAZS…" }, "clientState": null } ] } 更新されたリソースそのものではなく 更新されたリソースへのアクセス情報が通知される
- 20. 2.Subscriptionについて ・使い方 – どんなデータが通知されるのか 1. 通知を受け取る 2. 実行されたWebAPIなどでGraphリソースにアクセス • 通知でされたリソースのID情報などを使用 3. よしなに 上記のような利用の仕方になる。
- 21. 3.Subscriptionを実装してみる FrontPage ①SignalR Negotiate ①SignalR Negotiate ③Event Create/Update ④Graph Subscription ⑤SignalR Subscription ⑥Event Request Microsoft Graph ②Graph Subscription Setting
- 22. 4.まとめ • Graphリソースの変更を検知する方法は2つある • DeltaとSubscription • Deltaはクエリのみで完結する • Frontのみで解決するような処理の場合はこちらの方が良いかも • Subscriptionは通知先のWebAPIが必要となる • リソースの変更をトリガーにバッチ的に何かをしたいときは 断然こっちの選択肢になるはず • ただし、有効期限の寿命が短めなので更新フローを忘れずに！ • 規模が大きい会社は工夫が必要かも • 通知量の桁が大きい。EventGridやQueueに逃がしてから…という手も
- 23. 参考ページ • デルタ クエリを使用して、Microsoft Graph データの変更を追跡する • https://docs.microsoft.com/ja-jp/graph/delta-query-overview • Microsoft Graph API を使用して変更通知を取得する • https://docs.microsoft.com/ja-jp/graph/api/resources/webhooks?view=graph-rest-1.0 • ユーザー データの変更に関する通知の設定 • https://docs.microsoft.com/ja-jp/graph/webhooks#notification-endpoint-validation • 今回デモのリポジトリ… • https://github.com/Takas0522/GraphSubscriptionLearn