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

名前空間: microsoft.graphNamespace: microsoft.graph

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

  • Microsoft Graph Security API の警告An alert from the Microsoft Graph Security API
  • Microsoft Teams での電話または会議の後に作成された callRecordA callRecord produced after a call or meeting in Microsoft Teams
  • Microsoft Teams のチームまたはチャネルを介して送信された chatMessageA chatMessage sent via teams or channels in Microsoft Teams
  • Microsoft 365 グループの会話A conversation in a Microsoft 365 group
  • OneDrive for Business のルート フォルダー driveItem の階層内にあるコンテンツ、またはユーザーの個人用 OneDrive のルート フォルダーまたはサブフォルダー driveItem の階層内にあるコンテンツContent in the hierarchy of a root folder driveItem in OneDrive for Business, or of a root folder or subfolder driveItem in a user's personal OneDrive
  • SharePoint [サイト][]の[リスト][]A list under a SharePoint site
  • Outlook のメッセージイベント、または[連絡先][]A message, event, or contact in Outlook
  • Azure Active Directory 内のユーザーまたはグループA user or group in Azure Active Directory

サポートされている各リソースの考えられるリソース パス値については、「 Microsoft Graph API を使用して変更通知を取得する」を参照してください。See Use the Microsoft Graph API to get change notifications for the possible resource path values for each supported resource.

メソッドMethods

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

プロパティProperties

プロパティProperty Type 説明Description
changeTypechangeType stringstring 必須です。Required. 登録しているリソース内の、変更通知を上げる変更の種類を示します。Indicates the type of change in the subscribed resource that will raise a change 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 and list change notifications support only the updated changeType. ユーザーとグループの変更通知では、updateddeleted changeType がサポートされます。User and group change notifications support updated and deleted changeType.
notificationUrlnotificationUrl stringstring 必須です。Required. 変更通知を受け取るエンドポイントの URL です。The URL of the endpoint that will receive the change notifications. この URL は HTTPS プロトコルを利用する必要があります。This URL must make use of the HTTPS protocol.
リソースresource stringstring 必須です。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/). サポートされているリソースについては、考えられるリソース パスのを参照してください。See the possible resource path values for each supported resource.
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 change notification. 最大の長さは 128 文字です。The maximum length is 128 characters. クライアントは、サブスクリプションと共に送信された clientState プロパティの値と、各変更通知と共に受信された clientState プロパティの値を比較することで、その変更通知がサービスから来たことを確認できます。The client can check that the change 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 change notification.
idid stringstring サブスクリプションの一意の識別子です。読み取り専用。Unique identifier for the subscription. Read-only.
applicationIdapplicationId stringstring サブスクリプションを作成するときに使用するアプリケーションの識別子。Identifier of the application used to create the subscription. 読み取り専用です。Read-only.
creatorIdcreatorId stringstring サブスクリプションを作成したユーザーまたはサービス プリンシパルの識別子。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.
includeResourceDataincludeResourceData ブール値Boolean true に設定すると、変更通知にはリソース データが含まれます (チャット メッセージのコンテンツなど)。When set to true, change notifications include resource data (such as content of a chat message). 省略可能。Optional.
encryptionCertificateencryptionCertificate 文字列string 変更通知のリソース データを暗号化するために使用される公開キーを持つ証明書の base64 エンコード表現。A base64-encoded representation of a certificate with a public key used to encrypt resource data in change notifications. 省略可能。Optional. includeResourceData が true の場合は必須です。Required when includeResourceData is true.
encryptionCertificateIdencryptionCertificateId 文字列string リソース データを復号化するために必要な証明書を識別するのに役立つカスタム アプリ提供の識別子。A custom app-provided identifier to help identify the certificate needed to decrypt resource data. 省略可能。Optional.
latestSupportedTlsVersionlatestSupportedTlsVersion StringString notificationUrl で指定された通知エンドポイントがサポートするトランスポート層セキュリティ (TLS) の最新バージョンを指定します。Specifies the latest version of Transport Layer Security (TLS) that the notification endpoint, specified by notificationUrl, supports. 使用可能な値: v1_0v1_1v1_2v1_3The possible values are: v1_0, v1_1, v1_2, v1_3.
通知エンドポイントが現在推奨バージョン (TLS 1.2) より低いバージョンをサポートしているユーザーの場合、TLS 1.2 へのアップグレードを完了する前に、このプロパティを設定されたタイムラインで指定すると、TLS の推奨されないバージョンを一時的に使用できます。For subscribers whose notification endpoint supports a version lower than the currently recommended version (TLS 1.2), specifying this property by a set timeline allows them to temporarily use their deprecated version of TLS before completing their upgrade to TLS 1.2. これらのサブスクライバーの場合、タイムラインごとにこのプロパティを設定しないと、サブスクリプション操作は失敗します。For these subscribers, not setting this property per the timeline would result in subscription operations failing.

通知エンドポイントが既に TLS 1.2 をサポートしているサブスクライバーの場合、このプロパティの設定はオプションです。For subscribers whose notification endpoint already supports TLS 1.2, setting this property is optional. このような場合、Microsoft Graph の既定では、プロパティが [v1_2] になります。In such cases, Microsoft Graph defaults the property to v1_2.

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

ResourceResource 最大有効期限Maximum expiration time
セキュリティの警告Security alert 43200 分 (30 日以内)43200 minutes (under 30 days)
Teams callRecordTeams callRecord 4230 分 (3 日以内)4230 minutes (under 3 days)
Teams chatMessageTeams chatMessage 60 分 (1 時間)60 minutes (1 hour)
グループ会話Group conversation 4230 分 (3 日以内)4230 minutes (under 3 days)
OneDrive driveItemOneDrive driveItem 4230 分 (3 日以内)4230 minutes (under 3 days)
SharePoint リストSharePoint list 4230 分 (3 日以内)4230 minutes (under 3 days)
Outlook メッセージイベント連絡先Outlook message, event, contact 4230 分 (3 日以内)4230 minutes (under 3 days)
ユーザーグループ、その他のディレクトリ リソースuser, group, other directory resources 4230 分 (3 日以内)4230 minutes (under 3 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

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",
  "includeResourceData": "boolean",
  "encryptionCertificate": "string",
  "encryptionCertificateId": "string",
  "latestSupportedTlsVersion": "string"
}