サブスクリプション リソースの種類subscription resource type

サブスクリプションは、Microsoft Graph でデータへの変更に関する通知を受信するクライアント アプリケーションを許可します。A subscription allows a client app to receive notifications about changes to data in Microsoft Graph. 現時点では、サブスクリプションが有効になって次のリソース。Currently, subscriptions are enabled for the following resources:

  • メール、イベント、および Outlook の連絡先です。Mail, events, and contacts from Outlook.
  • Office グループからの会話。Conversations from Office Groups.
  • OneDrive からドライブのルート項目。Drive root items from OneDrive.
  • ユーザーと Azure Active Directory のグループ。Users and Groups from Azure Active Directory.
  • Graph セキュリティ API から通知されます。Alerts from the Microsoft Graph Security API.

JSON 表記JSON representation

以下は、リソースの JSON 表記です。Here is a JSON representation of the resource.

{
  "changeType": "string",
  "notificationUrl": "string",
  "resource": "string",
  "applicationId" : "string",
  "expirationDateTime": "String (timestamp)",
  "id": "string (identifier)",
  "clientState": "string",
  "creatorId": "string"
}

プロパティProperties

プロパティProperty Type 説明Description
changeTypechangeType stringstring 必須。Required. 登録しているリソース内の、通知を上げる変更の種類を示します。Indicates the type of change in the subscribed resource that will raise a notification. サポートされている値は createdupdateddeleted です。The supported values are: created, updated, deleted. コンマ区切りのリストを使用して複数値を結合できます。Multiple values can be combined using a comma-separated list.

メモ: ドライブのルート アイテムの通知だけをサポートして、 updated changeType です。Note: Drive root item notifications support only the updated changeType. ユーザーとグループの通知をサポートしてupdateddeletedchangeType です。User and group notifications support updated and deleted changeType.
notificationUrlnotificationUrl 文字列string 必須。Required. 通知を受信するエンドポイントの URL。The URL of the endpoint that will receive the notifications. この URL が、HTTPS を使用する必要がありますプロトコルです。This URL must make use of the HTTPS protocol.
resourceresource 文字列string 必須。Required. 変更の監視対象となるリソースを指定します。Specifies the resource that will be monitored for changes. ベース URL が含まれていない (https://graph.microsoft.com/v1.0/)。Do not include the base URL (https://graph.microsoft.com/v1.0/).
expirationDateTimeexpirationDateTime dateTimedateTime 必須。Required. webhook サブスクリプションの有効期限が切れる日時を指定します。Specifies the date and time when the webhook subscription expires. 時刻は UTC 表示で、登録したリソースごとに異なるサブスクリプション作成からの経過時間にもできます。The time is in UTC, and can be an amount of time from subscription creation that varies for the resource subscribed to. サポートされているサブスクリプションの最長時間については、次の表をご覧ください。See the table below for maximum supported subscription length of time.
clientStateclientState stringstring 省略可能。Optional. 各通知内のサービスによって送信される clientState プロパティの値を指定します。Specifies the value of the clientState property sent by the service in each notification. 最大の長さは 128 文字です。The maximum length is 128 characters. クライアントは、サブスクリプションと共に送信された clientState プロパティの値と、各通知と共に受信された clientState プロパティの値を比較することで、その通知がサービスから来たことを確認できます。The client can check that the notification came from the service by comparing the value of the clientState property sent with the subscription with the value of the clientState property received with each notification.
IDid 文字列string サブスクリプションの一意の識別子です。読み取り専用です。Unique identifier for the subscription. Read-only.
applicationIdapplicationId 文字列string サブスクリプションを作成するために使用するアプリケーションの識別子です。Identifier of the application used to create the subscription. 読み取り専用です。Read-only.
creatorIdcreatorId 文字列string ユーザーまたはサブスクリプションを作成するサービス ・ プリンシパルの識別子です。Identifier of the user or service principal that created the subscription. 使用するアプリケーションがサブスクリプションを作成するアクセス許可を委任する場合、このフィールドは、サインイン中のユーザーの代理で、アプリケーションが呼び出されるの id を含みます。If the app used delegated permissions to create the subscription, this field contains the id of the signed-in user the app called on behalf of. アプリケーションは、アプリケーションのアクセス許可を使用する場合、このフィールドには、アプリケーションに対応するサービス ・ プリンシパルの id が含まれています。If the app used application permissions, this field contains the id of the service principal corresponding to the app. 読み取り専用です。Read-only.

リソースの種類別のサブスクリプションの最大の長さMaximum length of subscription per resource type

リソースResource 最大有効期限Maximum Expiration Time
メールMail 4230 分 (3 日間で)4230 minutes (under 3 days)
予定表Calendar 4230 分 (3 日間で)4230 minutes (under 3 days)
連絡先Contacts 4230 分 (3 日間で)4230 minutes (under 3 days)
グループ会話Group conversations 4230 分 (3 日間で)4230 minutes (under 3 days)
ドライブ ルート項目Drive root items 4230 分 (3 日間で)4230 minutes (under 3 days)
セキュリティの警告Security alerts 43200 分 (30 日間で)43200 minutes (under 30 days)

注: 既存のアプリケーションと新しいアプリケーションは、サポートされている値を超える必要があります。Note: Existing applications and new applications should not exceed the supported value. 将来、作成するか、最大値を超えるサブスクリプションを更新するすべての要求は失敗します。In the future, any requests to create or renew a subscription beyond the maximum value will fail.

リレーションシップRelationships

なしNone

メソッドMethods

メソッドMethod 戻り値の型Return Type 説明Description
Create subscriptionCreate subscription subscriptionsubscription Microsoft Graph のデータが変更されたときに通知を受信するリスナー アプリケーションに登録します。Subscribes a listener application to receive notifications when Microsoft Graph data changes.
Update subscriptionUpdate subscription subscriptionsubscription 有効期限を更新することにより、サブスクリプションを更新します。Renews a subscription by updating its expiration time.
リストの購読List subscriptions subscriptionsubscription アクティブなサブスクリプションの一覧を表示します。Lists active subscriptions.
Get subscriptionGet subscription subscriptionsubscription サブスクリプション オブジェクトのプロパティと関係を読み取ります。Reads properties and relationships of subscription object.
サブスクリプションの削除Delete subscription なしNone サブスクリプション オブジェクトを削除します。Deletes a subscription object.