サブスクリプションを更新するUpdate subscription

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

サブスクリプションを更新するには、サブスクリプションの有効期限を延長します。Renew a subscription by extending its expiry time.

サブスクリプションは、リソースの種類によって異なる時間が経過すると有効期限が切れます。Subscriptions expire after a length of time that varies by resource type. 変更通知が失われないようにするために、アプリは有効期限が切れる前にサブスクリプションを更新する必要があります。In order to avoid missing change notifications, an app should renew its subscriptions well in advance of their expiry date. リソースの種類ごとのサブスクリプションの最大長のサブスクリプションを参照してください。See subscription for maximum length of a subscription for each resource type.

アクセス許可Permissions

要求されたリソースとアクセス許可の種類 (委任またはアプリケーション) に応じて、以下の表で指定されているアクセス許可がこの API を呼び出すため必要な最小限の特権となります。Depending on the resource and the permission type (delegated or application) requested, the permission specified in the following table is the least privileged required to call this API. アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。To learn more, including how to choose permissions, see Permissions.

サポートされているリソースSupported resource 委任 (職場または学校のアカウント)Delegated (work or school account) 委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) アプリケーションApplication
callRecordcallRecord サポート対象外Not supported 非サポートNot supported CallRecords.Read.AllCallRecords.Read.All
contactcontact Contacts.ReadContacts.Read Contacts.ReadContacts.Read Contacts.ReadContacts.Read
driveItem (ユーザーの個人用 OneDrive)driveItem (user's personal OneDrive) サポート対象外Not supported Files.ReadWriteFiles.ReadWrite サポート対象外Not supported
driveItem (OneDrive for Business)driveItem (OneDrive for Business) Files.ReadWrite.AllFiles.ReadWrite.All サポート対象外Not supported Files.ReadWrite.AllFiles.ReadWrite.All
イベントevent Calendars.ReadCalendars.Read Calendars.ReadCalendars.Read Calendars.ReadCalendars.Read
グループgroup Group.Read.AllGroup.Read.All サポート対象外Not supported Group.Read.AllGroup.Read.All
グループ会話group conversation Group.Read.AllGroup.Read.All サポート対象外Not supported 非サポートNot supported
リストlist Sites.ReadWrite.AllSites.ReadWrite.All サポート対象外Not supported Sites.ReadWrite.AllSites.ReadWrite.All
メッセージmessage Mail.ReadBasic, Mail.ReadMail.ReadBasic, Mail.Read Mail.ReadBasic, Mail.ReadMail.ReadBasic, Mail.Read Mail.ReadBasic, Mail.ReadMail.ReadBasic, Mail.Read
セキュリティの警告security alert SecurityEvents.ReadWrite.AllSecurityEvents.ReadWrite.All サポート対象外Not supported SecurityEvents.ReadWrite.AllSecurityEvents.ReadWrite.All
ユーザーuser User.Read.AllUser.Read.All User.Read.AllUser.Read.All User.Read.AllUser.Read.All

注: OneDrive と Outlook のアイテムのサブスクリプションについては、追加の制限があります。Note: There are additional limitations for subscriptions on OneDrive and Outlook items. この制限は、サブスクリプションの作成および管理 (サブスクリプションの取得、更新、削除) に適用されます。The limitations apply to creating as well as managing subscriptions (getting, updating, and deleting subscriptions).

  • 個人用 OneDrive では、そのドライブのルート フォルダーまたは任意のサブフォルダーにサブスクライブできます。On personal OneDrive, you can subscribe to the root folder or any subfolder in that drive. OneDrive for Business の場合、サブスクライブできるのはルート フォルダーのみです。On OneDrive for Business, you can subscribe to only the root folder. 変更通知は、サブスクライブされたフォルダー、またはその階層にある任意のファイル、フォルダー、またはその他のファイル、フォルダー、またはその他のドライブアイテムオブジェクトに対して要求された種類の変更が送信されますChange notifications are sent for the requested types of changes on the subscribed folder, or any file, folder, or other driveItem objects in its hierarchy. 個別のファイルなどのフォルダーではない、ドライブ インスタンスまたは driveItem インスタンスをサブスクライブすることはできません。You cannot subscribe to drive or driveItem instances that are not folders, such as individual files.

  • Outlook における委任されたアクセス許可では、サインインしているユーザーのメールボックス内のフォルダーにあるアイテムのみをサブスクライブできます。In Outlook, delegated permission supports subscribing to items in folders in only the signed-in user's mailbox. つまり、委任されたアクセス許可 Calendars.Read を使用して、別のユーザーのメールボックス内のイベントをサブスクライブすることなどはできません。That means, for example, you cannot use the delegated permission Calendars.Read to subscribe to events in another user's mailbox.

  • _共有または委任_フォルダーの Outlook 連絡先、イベント、メッセージの変更通知をサブスクライブするには、次のようにします。To subscribe to change notifications of Outlook contacts, events, or messages in shared or delegated folders:

    • 対応するアプリケーション アクセス許可を使用して、テナントの_任意_のユーザーのフォルダーまたはメールボックス内にあるアイテムの変更をサブスクライブします。Use the corresponding application permission to subscribe to changes of items in a folder or mailbox of any user in the tenant.
    • Outlook 共有アクセス許可 (Contacts.Read.Shared、Calendars.Read.Shared、Mail.Read.Shared、および対応する読み取り/書き込み) は使用しないでください。それらは、共有フォルダーまたは委任フォルダーにあるアイテムの変更通知のサブスクライブをサポートしていないからです。Do not use the Outlook sharing permissions (Contacts.Read.Shared, Calendars.Read.Shared, Mail.Read.Shared, and their read/write counterparts), as they do not support subscribing to change notifications on items in shared or delegated folders.

HTTP 要求HTTP request

PATCH /subscriptions/{id}

要求ヘッダーRequest headers

名前Name 種類Type 説明Description
AuthorizationAuthorization stringstring ベアラー {トークン}。必須。Bearer {token}. Required.

応答Response

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で subscription オブジェクトを返します。If successful, this method returns a 200 OK response code and subscription object in the response body.

エラーがどのように返されるかの詳細については、「エラー応答」を参照してください。For details about how errors are returned, see Error responses.

Example

要求Request

以下は、要求の例です。Here is an example of the request.

PATCH https://graph.microsoft.com/v1.0/subscriptions/{id}
Content-type: application/json

{
   "expirationDateTime":"2016-11-22T18:23:45.9356913Z"
}
応答Response

以下は、応答の例です。Here is an example of the response.

HTTP/1.1 200 OK
Content-type: application/json
Content-length: 252

{
  "id":"7f105c7d-2dc5-4530-97cd-4e7ae6534c07",
  "resource":"me/messages",
  "applicationId": "24d3b144-21ae-4080-943f-7067b395b913",
  "changeType":"created,updated",
  "clientState":"subscription-identifier",
  "notificationUrl":"https://webhook.azurewebsites.net/api/send/myNotifyClient",
  "expirationDateTime":"2016-11-22T18:23:45.9356913Z",
  "creatorId": "8ee44408-0679-472c-bc2a-692812af3437",
  "latestSupportedTlsVersion": "v1_2"
}