サブスクリプションを削除する

名前空間: microsoft.graph

サブスクリプションを削除します。

変更通知のサブスクライブをサポートするリソースの一覧については、[ アクセス許可] セクションの表を参照してください。

この API は、次の国内クラウド展開で使用できます。

アクセス許可

要求されたリソースとアクセス許可の種類 (委任またはアプリケーション) に応じて、以下の表で指定されているアクセス許可がこの API を呼び出すため必要な最小限の特権となります。 より多くの特権アクセス許可を選択する前に注意することを含め、詳細については、[アクセス許可] で次のアクセス許可を検索してください。

chatMessage

リソース データを含めるように chatMessage サブスクリプションを指定することもできます (includeResourceData を true に設定)。 その場合、暗号化が必要であり、そのようなサブスクリプションに encryptionCertificate が指定されていないと、サブスクリプションの作成は失敗します。

Prefer: include-unknown-enum-members 要求ヘッダーを使用して、chatMessage messageTypeのエボルベブル列挙型で次の値を取得します。 /teams/{id}/channels/{id}/messages および /chats/{id}/messages リソースのsystemEventMessage。

conversationMember

リソース データを含めるように conversationMember サブスクリプションを指定することができます (includeResourceData を true に設定)。 その場合、暗号化が必要であり、そのようなサブスクリプションに encryptionCertificate が指定されていないと、サブスクリプションの作成は失敗します。

チーム、チャネル、チャット

チーム、 チャネル、 チャット のサブスクリプションにリソース データを含めるように指定できます (includeResourceData を true に設定)。 その場合、暗号化が必要であり、そのようなサブスクリプションに encryptionCertificate が指定されていないと、サブスクリプションの作成は失敗します。

notifyOnUserSpecificProperties クエリ文字列パラメーターは、特定のチャットまたはユーザー レベルで変更をサブスクライブするときに使用できます。 サブスクリプションの作成時にクエリ文字列パラメーター notifyOnUserSpecificProperties を true に設定すると、2 種類のペイロードがサブスクライバーに送信されます。 1 つのタイプにはユーザー固有のプロパティが含まれており、もう 1 つはユーザー固有のプロパティなしで送信されます。 詳細については、「 Microsoft Graph を使用してチャットの変更通知を取得する」を参照してください。

aiInsights

Copilot AI 分析情報のサブスクリプションには、次の Copilot サービス プランを含む有効な Copilot ライセンスが必要です:

• Microsoft 365 Copilot Chat: 3f30311c-6b1e-48a4-ab79-725b469da960

aiInteraction

Copilot AI 対話のサブスクリプションには、次の Copilot サービス プランを含む有効な Copilot ライセンスが必要です:

• Microsoft 365 Copilot Chat: 3f30311c-6b1e-48a4-ab79-725b469da960

特定のユーザーが参加している Copilot AI 対話を対象とするサブスクリプションの場合、リソース パス内のユーザーには、有効な状態で以前のサービス プランが割り当てられている必要があります。

テナント全体の Copilot AI 対話を対象とするサブスクリプションの場合、テナントには、以前のすべての Copilot サービス プランを含む有効なライセンスがプロビジョニングされている必要があります。

driveItem

OneDrive アイテムのサブスクリプションには、さらに多くの制限が適用されます。 この制限は、サブスクリプションの作成および管理 (取得、更新、削除) に適用されます。

個人用 OneDrive では、そのドライブのルート フォルダーまたは任意のサブフォルダーにサブスクライブできます。 職場または学校の OneDrive では、ルート フォルダーのみを購読できます。 変更通知は、サブスクライブしたフォルダー、またはその階層内のファイル、フォルダー、またはその他の driveItem インスタンスについて、要求された種類の変更に対して送信されます。 個々のファイルなど、フォルダーではない drive または driveItem インスタンスをサブスクライブすることはできません。

連絡先、イベント、メッセージ

Outlook の連絡先、 イベント、 またはメッセージ リソースの変更をサブスクライブし、必要に応じて、暗号化されたリソース データを通知に含めるかどうかを POST 要求のペイロードで指定できます。

サブスクリプションの作成と管理 (取得、更新、および削除) には、リソースの読み取りスコープが必要です。 たとえば、メッセージに関する変更通知を受信するには、アプリに Mail.Read アクセス許可が必要です。 Outlook 変更通知は、委任されたアクセス許可スコープとアプリケーション アクセス許可スコープをサポートします。 次の制限がある点に注意してください。

• 委任されたアクセス許可では、サインインしているユーザーのメールボックス内のフォルダーにあるアイテムのみをサブスクライブできます。 たとえば、委任されたアクセス許可 Calendars.Read を使用して、別のユーザーのメールボックス内のイベントをサブスクライブすることはできません。

• 共有または委任フォルダーの Outlook 連絡先、イベント、メッセージの変更通知をサブスクライブするには、次のようにします。

  • 対応するアプリケーション アクセス許可を使用して、テナントの任意のユーザーのフォルダーまたはメールボックス内にあるアイテムの変更をサブスクライブします。
  • Outlook の共有アクセス許可 (Contacts.Read.Shared、Calendars.Read.Shared、Mail.Read.Shared、およびそれに相当する読み取り/書き込みアクセス許可) は、共有フォルダーまたは委任フォルダー内のアイテムの変更通知のサブスクライブをサポートし ていない ため、使用しないでください。

onlineMeetings, プレゼンス

onlineMeetings および プレゼンス サブスクリプションでは、リソース データを含む通知の暗号化が必要です。 通知でリソース データが必要な場合は encryptionCertificate と encryptionCertificateId が指定されていない場合、サブスクリプションの作成が失敗します。 詳細については、以下を参照してください:

• リソース データを使用して Microsoft Graph の変更通知を設定します (リッチ通知)。
• オンライン会議の変更通知を受け取る。

virtualEventWebinar

仮想イベントのサブスクリプションは、基本的な通知のみをサポートし、仮想イベントの少数のエンティティに制限されます。 サポートされているサブスクリプションの種類の詳細については、「 Microsoft Teams 仮想イベント更新プログラムの変更通知の取得」を参照してください。

HTTP 要求

DELETE /subscriptions/{subscription-id}

要求ヘッダー

要求本文

このメソッドには、要求本文を指定しません。

応答

成功した場合、このメソッドは 204 No Content 応答コードを返します。

エラーがどのように返されるかの詳細については、「エラー応答」を参照してください。

例

要求

次の例は要求を示しています。

DELETE https://graph.microsoft.com/beta/subscriptions/7f105c7d-2dc5-4530-97cd-4e7ae6534c07

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Subscriptions["{subscription-id}"].DeleteAsync();

// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Subscriptions().BySubscriptionId("subscription-id").Delete(context.Background(), nil)

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.subscriptions().bySubscriptionId("{subscription-id}").delete();

const options = {
	authProvider,
};

const client = Client.init(options);

await client.api('/subscriptions/7f105c7d-2dc5-4530-97cd-4e7ae6534c07')
	.version('beta')
	.delete();

<?php
use Microsoft\Graph\Beta\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$graphServiceClient->subscriptions()->bySubscriptionId('subscription-id')->delete()->wait();

Import-Module Microsoft.Graph.Beta.ChangeNotifications

Remove-MgBetaSubscription -SubscriptionId $subscriptionId

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

await graph_client.subscriptions.by_subscription_id('subscription-id').delete()

応答

次の例は応答を示しています。

HTTP/1.1 204 No Content