Удаление подписки

Пространство имен: microsoft.graph

Удаление подписки.

Список ресурсов, поддерживающих подписку на уведомления об изменениях, см. в таблице раздела Разрешения .

Этот API доступен в следующих национальных облачных развертываниях.

Разрешения

В зависимости от ресурса и типа требующегося разрешения (делегированное или для приложения) разрешение, указанное в приведенной ниже таблице, является наименее привилегированным разрешением, необходимым для вызова этого API. Чтобы получить дополнительные сведения, в том числе о соблюдении осторожности перед выбором разрешений с повышенными привилегиями, найдите следующие разрешения в разделе Разрешения.

chatMessage

Подписки chatMessage можно указать для включения данных ресурсов (параметр includeResourceData имеет значение true). В этом случае требуется шифрование, и создание подписки завершается сбоем, если для таких подписок не указан сертификат шифрования .

Prefer: include-unknown-enum-members Используйте заголовок запроса, чтобы получить следующие значения в перечислении chatMessagemessageTypeс возможностью развития: systemEventMessage for /teams/{id}/channels/{id}/messages и /chats/{id}/messages resource.

conversationMember

Подписки conversationMember можно указать для включения данных ресурсов (параметр includeResourceData имеет значение true). В этом случае требуется шифрование, и создание подписки завершается сбоем, если для таких подписок не указан сертификат шифрования .

команда, канал и чат

Подписки команд, каналов и чатов можно указать для включения данных ресурсов (параметр includeResourceData имеет значение true). В этом случае требуется шифрование, и создание подписки завершается сбоем, если для таких подписок не указан сертификат шифрования .

Параметр строки запроса notifyOnUserSpecificProperties можно использовать при подписке на изменения в определенном чате или на уровне пользователя. Если параметр строки запроса notifyOnUserSpecificPropertiestrue задан во время создания подписки, подписчику отправляются два типа полезных данных. Один тип содержит свойства, зависящие от пользователя, а другой отправляется без них. Дополнительные сведения см. в статье Получение уведомлений об изменениях для чатов с помощью Microsoft Graph.

aiInsights

Для подписок на Copilot AI Insights требуется действительная лицензия Copilot, которая включает следующий план обслуживания Copilot:

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

aiInteraction

Для подписок на взаимодействие с ИИ Copilot требуется действительная лицензия Copilot, которая включает следующий план обслуживания Copilot:

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

Для подписок, предназначенных для взаимодействия с ИИ Copilot, частью которых является конкретный пользователь, пользователю в пути к ресурсу должны быть назначены предыдущие планы обслуживания в допустимом состоянии.

Для подписок, предназначенных для взаимодействия Copilot AI для всего клиента, клиент должен иметь действительные лицензии, которые включают все предыдущие планы обслуживания Copilot.

driveItem

К подпискам на элементы OneDrive применяются дополнительные ограничения. Ограничения применяются для создания, а также управления (получение, обновление и удаление) подписками.

В личном хранилище OneDrive можно подписаться на корневую папку или любую вложенную папку в этом хранилище. В OneDrive для работы или учебы можно подписаться только на корневую папку. Уведомления об изменениях отправляются для запрошенных типов изменений в папке с подпиской или любом файле, папке или других экземплярах driveItem в ее иерархии. Вы не можете подписаться на экземпляры drive или driveItem , которые не являются папками, например на отдельные файлы.

contact, event и message

Вы можете подписаться на изменения в ресурсах контактов, событий или сообщений Outlook и при необходимости указать в полезных данных запроса POST, включать ли зашифрованные данные ресурсов в уведомления.

Для операций создания и управления (получение, обновление и удаление) подписке требуется область чтения ресурса. Например, чтобы получать уведомления об изменениях в сообщениях, приложению необходимо разрешение Mail.Read. Уведомления об изменениях Outlook поддерживают области делегированных разрешений и разрешений приложений. Обратите внимание на указанные ниже ограничения.

• Делегированные разрешения поддерживают подписку на элементы в папках только в почтовом ящике пользователя, выполнившего вход. Например, вы не можете использовать делегированное разрешение Calendars.Read для подписки на события в почтовом ящике другого пользователя.

• Чтобы подписаться на уведомления об изменениях контактов Outlook, событий или сообщений в общих или делегированных папках:

  • Используйте соответствующее разрешение приложения для подписки на изменения элементов в папке или почтовом ящике любого пользователя в клиенте.
  • Не используйте разрешения на общий доступ Outlook (Contacts.Read.Shared, Calendars.Read.Shared, Mail.Read.Shared и их коллеги на чтение и запись), так как они не поддерживают подписку на уведомления об изменении элементов в общих или делегированных папках.

onlineMeetings, присутствие

OnlineMeeting и подписки присутствия требуют шифрования для уведомлений с данными ресурсов. Создание подписки завершается сбоем , если шифрованиеCertificate и 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