Перечисление подписок

Статья
07/26/2024

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

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Получите список подписок веб-перехватчиков.

Содержимое ответа зависит от контекста, в котором вызывается приложение; подробные сведения см. в разделе Разрешения.

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

Глобальная служба	Правительство США L4	Правительство США L5 (DOD)	Китай управляется 21Vianet
✅	✅	✅	✅

Разрешения

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

Примечание.

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

Поддерживаемый ресурс	Делегированное (рабочая или учебная учетная запись)	Делегированное (личная учетная запись Майкрософт)	Приложение
aiInteraction `copilot/users/{userId}/interactionHistory/getAllEnterpriseInteractions` Взаимодействие с ИИ Copilot, частью чего является конкретный пользователь.	AiEnterpriseInteraction.Read	Не поддерживается.	AiEnterpriseInteraction.Read.All, AiEnterpriseInteraction.Read.User
aiInteraction `copilot/interactionHistory/getAllEnterpriseInteractions` Взаимодействие с ИИ Copilot в организации.	Не поддерживается.	Не поддерживается.	AiEnterpriseInteraction.Read.All
ApprovalItems	Не поддерживается.	Не поддерживается.	ApprovalSolution.ReadWrite.All
callRecord	Не поддерживается.	Не поддерживается.	CallRecords.Read.All
callRecording `communications/onlineMeetings/getAllRecordings` Любая запись становится доступной в клиенте.	Не поддерживается.	Не поддерживается.	OnlineMeetingRecording.Read.All
callRecording `communications/onlineMeetings/{onlineMeetingId}/recordings` Любая запись становится доступной для определенного собрания.	OnlineMeetingRecording.Read.All	Не поддерживается.	OnlineMeetingRecording.Read.All
callRecording `users/{userId}/onlineMeetings/getAllRecordings` Запись звонка, которая становится доступной на собрании, организованном определенным пользователем.	OnlineMeetingRecording.Read.All	Не поддерживается.	OnlineMeetingRecording.Read.All
callRecording `appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllRecordings` Запись звонков, которая становится доступной на собрании, где установлено определенное приложение Teams.	Не поддерживается.	Не поддерживается.	OnlineMeetingRecording.Read.All, OnlineMeetingRecording.Read.Chat
callTranscript `communications/onlineMeetings/getAllTranscripts` Любая расшифровка становится доступной в клиенте.	Не поддерживается.	Не поддерживается.	OnlineMeetingTranscript.Read.All
callTranscript `communications/onlineMeetings/{onlineMeetingId}/transcripts` Любое расшифровка становится доступной для определенного собрания.	OnlineMeetingTranscript.Read.All	Не поддерживается.	OnlineMeetingTranscript.Read.All
callTranscript `users/{userId}/onlineMeetings/getAllTranscripts` Расшифровка звонка, которая становится доступной на собрании, организованном определенным пользователем.	OnlineMeetingTranscript.Read.All	Не поддерживается.	OnlineMeetingTranscript.Read.All
callTranscript `appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllTranscripts` Расшифровка звонка, которая становится доступной на собрании, где установлено определенное приложение Teams.	Не поддерживается.	Не поддерживается.	OnlineMeetingTranscript.Read.All, OnlineMeetingTranscript.Read.Chat
channel `/teams/getAllChannels` Все каналы в организации.	Не поддерживается.	Не поддерживается.	Channel.ReadBasic.All, ChannelSettings.Read.All
channel `/teams/{id}/channels` Все каналы в определенной команде в организации.	Channel.ReadBasic.All, ChannelSettings.Read.All, Subscription.Read.All	Не поддерживается.	Channel.ReadBasic.All, ChannelSettings.Read.All
chat `/chats` Все чаты в организации.	Не поддерживается.	Не поддерживается.	Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
chat `/chats/{id}` Определенный чат.	Chat.ReadBasic, Chat.Read, Chat.ReadWrite, Subscription.Read.All	Не поддерживается.	ChatSettings.Read.Chat, ChatSettings.ReadWrite.Chat, Chat.Manage.Chat, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
chat `/appCatalogs/teamsApps/{id}/installedToChats` Все чаты в организации, где установлено определенное приложение Teams.	Не поддерживается.	Не поддерживается.	Chat.ReadBasic.WhereInstalled, Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled
chat `/users/{id}/chats` Все чаты, частью которыми является конкретный пользователь.	Chat.ReadBasic, Chat.Read, Chat.ReadWrite	Не поддерживается.	Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
chatMessage `/teams/{id}/channels/{id}/messages` Все сообщения и ответы в определенном канале.	ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All, Subscription.Read.All	Не поддерживается.	ChannelMessage.Read.Group, ChannelMessage.Read.All
chatMessage `/teams/getAllMessages` Все сообщения канала в организации.	Не поддерживается.	Не поддерживается.	ChannelMessage.Read.All
chatMessage `/chats/{id}/messages` Все сообщения в чате.	Chat.Read, Chat.ReadWrite, Subscription.Read.All	Не поддерживается.	Chat.Read.All
chatMessage `/chats/getAllMessages` Все сообщения чата в организации.	Не поддерживается.	Не поддерживается.	Chat.Read.All
chatMessage `/users/{id}/chats/getAllMessages` Сообщения чата для всех чатов, в которые входит конкретный пользователь.	Chat.Read, Chat.ReadWrite, Subscription.Read.All	Не поддерживается.	Chat.Read.All, Chat.ReadWrite.All
chatMessage `/appCatalogs/teamsApps/{id}/installedToChats/getAllMessages` Сообщения чата для всех чатов в организации, где установлено определенное приложение Teams.	Не поддерживается.	Не поддерживается.	Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled
contact	Contacts.Read, Subscription.Read.All	Contacts.Read, Subscription.Read.All	Contacts.Read
conversationMember `/chats/getAllMembers` Участники всех чатов в организации.	Не поддерживается.	Не поддерживается.	ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
conversationMember `/chats/{id}/members` Участники определенного чата.	ChatMember.Read, ChatMember.ReadWrite, Chat.ReadBasic, Chat.Read, Chat.ReadWrite, Subscription.Read.All	Не поддерживается.	ChatMember.Read.Chat, Chat.Manage.Chat, ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
conversationMember `appCatalogs/teamsApps/{id}/installedToChats/getAllMembers` Участники чата для всех чатов в организации, в которой установлено определенное приложение Teams.	Не поддерживается.	Не поддерживается.	ChatMember.Read.WhereInstalled, ChatMember.ReadWrite.WhereInstalled, Chat.ReadBasic.WhereInstalled, Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled
conversationMember `/teams/getAllMembers` Участники во всех командах в организации.	Не поддерживается.	Не поддерживается.	TeamMember.Read.All, TeamMember.ReadWrite.All
conversationMember `/teams/{id}/members` Участники определенной команды.	TeamMember.Read.All, Subscription.Read.All	Не поддерживается.	TeamMember.Read.All
conversationMember `/teams/{id}/channels/getAllMembers` Участники всех частных каналов определенной команды.	Не поддерживается.	Не поддерживается.	ChannelMember.Read.All
conversationMember `/teams/getAllChannels/getAllMembers`	Не поддерживается.	Не поддерживается.	ChannelMember.Read.All
driveItem Личный oneDrive пользователя.	Не поддерживается.	Files.ReadWrite, Subscription.Read.All	Не поддерживается.
driveItem OneDrive для работы или учебы.	Files.ReadWrite.All, Subscription.Read.All	Не поддерживается.	Files.ReadWrite.All
event	Calendars.Read, Subscription.Read.All	Calendars.Read, Subscription.Read.All	Calendars.Read
group	Group.Read.All, Subscription.Read.All	Не поддерживается.	Group.Read.All
group conversation	Group.Read.All, Subscription.Read.All	Не поддерживается.	Не поддерживается.
list	Sites.ReadWrite.All, Subscription.Read.All	Не поддерживается.	Sites.ReadWrite.All
message	Mail.ReadBasic, Mail.Read, Subscription.Read.All	Mail.ReadBasic, Mail.Read, Subscription.Read.All	Mail.Read
offerShiftRequest `/teams/{id}/schedule/offerShiftRequests` Изменения в любом запросе на смену предложения в команде.	Schedule.Read.All, Schedule.ReadWrite.All	Не поддерживается.	Schedule.Read.All, Schedule.ReadWrite.All
собрание по сети	Не поддерживается.	Не поддерживается.	OnlineMeetings.Read.All, OnlineMeetings.ReadWrite.All
openShiftChangeRequest `/teams/{id}/schedule/openShiftChangeRequests` Изменения в любом запросе на открытые смены в команде.	Schedule.Read.All, Schedule.ReadWrite.All	Не поддерживается.	Schedule.Read.All, Schedule.ReadWrite.All
presence	Presence.Read.All, Subscription.Read.All	Не поддерживается.	Не поддерживается.
printer	Не поддерживается.	Не поддерживается.	Printer.Read.All, Printer.ReadWrite.All
printTaskDefinition	Не поддерживается.	Не поддерживается.	PrintTaskDefinition.ReadWrite.All
security alert	SecurityEvents.ReadWrite.All, Subscription.Read.All	Не поддерживается.	SecurityEvents.ReadWrite.All
shift `/teams/{id}/schedule/shifts` Изменения в любой смене в команде.	Schedule.Read.All, Schedule.ReadWrite.All	Не поддерживается.	Schedule.Read.All, Schedule.ReadWrite.All
swapShiftsChangeRequest `/teams/{id}/schedule/swapShiftsChangeRequests` Изменения в любом запросе на смену переключения в команде.	Schedule.Read.All, Schedule.ReadWrite.All	Не поддерживается.	Schedule.Read.All, Schedule.ReadWrite.All
team `/teams` Все команды в организации.	Не поддерживается.	Не поддерживается.	Team.ReadBasic.All, TeamSettings.Read.All
team `/teams/{id}` Определенная команда.	Team.ReadBasic.All, TeamSettings.Read.All, Subscription.Read.All	Не поддерживается.	Team.ReadBasic.All, TeamSettings.Read.All
timeOffRequest `/teams/{id}/schedule/timeOffRequests` Изменения в любом запросе на отгул в команде.	Schedule.Read.All, Schedule.ReadWrite.All	Не поддерживается.	Schedule.Read.All, Schedule.ReadWrite.All
todoTask	Tasks.ReadWrite, Subscription.Read.All	Tasks.ReadWrite, Subscription.Read.All	Не поддерживается.
user	User.Read.All, Subscription.Read.All	User.Read.All	User.Read.All
baseTask (не рекомендуется)	Tasks.ReadWrite, Subscription.Read.All	Tasks.ReadWrite, Subscription.Read.All	Не поддерживается.

Примечание.

Следующие разрешения используют согласие для конкретного ресурса:

OnlineMeetingRecording.Read.Chat
OnlineMeetingTranscript.Read.Chat
ChatSettings.Read.Chat
ChatSettings.ReadWrite.Chat
Chat.Manage.Chat
ChannelMessage.Read.Group
ChatMember.Read.Chat
AiEnterpriseInteraction.Read.User

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

aiInteraction

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

Соединители Microsoft Graph в Microsoft 365 Copilot: 82d30987-df9b-4486-b146-198b21d164c7
Интеллектуальный поиск: 931e4a88-a67f-48b5-814f-16a5f1e6028d
Microsoft 365 Copilot в Microsoft Teams: b95945de-b3bd-46db-8437-f2beb6ea2347
Microsoft 365 Copilot в приложениях для повышения производительности: a62f8878-de10-42f3-b68f-6149a25ceb97
Microsoft 365 Copilot Chat: 3f30311c-6b1e-48a4-ab79-725b469da960
Соединители Power Platform в Microsoft 365 Copilot: 89f1c4c8-0878-40f7-804d-869c9128ab5d

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

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

Основные сценарии

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

Контекст приложения, отправившего вызов	Состав отклика
Приложение отправляет вызов от имени вошедшего пользователя (делегированное разрешение). -и- У приложения есть исходное разрешение, необходимое для создания подписки. Заметка: Этот сценарий применяется как к личным учетным записям Майкрософт, так и к рабочим и учебным учетным записям.	Подписки, созданные приложением только для вошедшего пользователя.
Приложение отправляет вызов от своего имени (разрешение приложения). -и- У приложения есть исходное разрешение, необходимое для создания подписки. Примечание. Этот сценарий применяется только к рабочим или учебным учетным записям.	Подписки, созданные приложением для себя или любого пользователя в каталоге.

Контекст приложения, отправившего вызов

Состав отклика

Приложение отправляет вызов от имени вошедшего пользователя (делегированное разрешение).
-и-
У приложения есть исходное разрешение, необходимое для создания подписки.

Заметка: Этот сценарий применяется как к личным учетным записям Майкрософт, так и к рабочим и учебным учетным записям.

Подписки, созданные приложением только для вошедшего пользователя.

Приложение отправляет вызов от своего имени (разрешение приложения).
-и-
У приложения есть исходное разрешение, необходимое для создания подписки.

Примечание. Этот сценарий применяется только к рабочим или учебным учетным записям.

Подписки, созданные приложением для себя или любого пользователя в каталоге.

Расширенные сценарии

В некоторых случаях приложению нужно получить подписки, созданные другими приложениями. Например, пользователь хочет просмотреть все подписки, созданные каким-либо приложением от его имени. Или глобальный администратор, который хочет видеть все подписки из всех приложений в своем каталоге. В таких сценариях требуется делегированное разрешение Subscription.Read.All.

Контекст приложения, отправившего вызов	Состав отклика
Приложение отправляет вызов от имени вошедшего пользователя (делегированное разрешение). Пользователь не является администратором. -и- У приложения есть разрешение Subscription.Read.All Примечание. Этот сценарий применяется как к личным учетным записям Майкрософт, так и к рабочим и учебным учетным записям.	Подписки, созданные любым приложением только для вошедшего пользователя.
Приложение отправляет вызов от имени вошедшего пользователя (делегированное разрешение). Пользователь является глобальным администратором. -и- У приложения есть разрешение Subscription.Read.All Примечание. Этот сценарий применяется только к рабочим или учебным учетным записям.	Подписки, созданные любым приложением для любого пользователя в каталоге.

Контекст приложения, отправившего вызов

Состав отклика

Приложение отправляет вызов от имени вошедшего пользователя (делегированное разрешение). Пользователь не является администратором.
-и-
У приложения есть разрешение Subscription.Read.All

Примечание. Этот сценарий применяется как к личным учетным записям Майкрософт, так и к рабочим и учебным учетным записям.

Подписки, созданные любым приложением только для вошедшего пользователя.

Приложение отправляет вызов от имени вошедшего пользователя (делегированное разрешение). Пользователь является глобальным администратором.
-и-
У приложения есть разрешение Subscription.Read.All

Примечание. Этот сценарий применяется только к рабочим или учебным учетным записям.

Подписки, созданные любым приложением для любого пользователя в каталоге.

HTTP-запрос

GET /subscriptions

Необязательные параметры запросов

Этот метод не поддерживает параметры запроса OData для настройки ответа.

Заголовки запросов

Имя	Тип	Описание
Authorization	string	Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.

Текст запроса

Не указывайте текст запроса для этого метода.

Отклик

В случае успеха этот метод возвращает код отклика 200 OK и список объектов subscription в тексте отклика.

Пример

Запрос

GET https://graph.microsoft.com/beta/subscriptions


// 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
var result = await graphClient.Subscriptions.GetAsync();

Важно!

Пакеты SDK для Microsoft Graph по умолчанию используют версию API версии 1.0 и поддерживают не все типы, свойства и API, доступные в бета-версии. Дополнительные сведения о доступе к бета-API с помощью SDK см. в статье Использование пакетов Microsoft Graph SDK с бета-API.

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.



mgc-beta subscriptions list

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.



// 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
subscriptions, err := graphClient.Subscriptions().Get(context.Background(), nil)

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

SubscriptionCollectionResponse result = graphClient.subscriptions().get();

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


const options = {
	authProvider,
};

const client = Client.init(options);

let subscriptions = await client.api('/subscriptions')
	.version('beta')
	.get();

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


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


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


$result = $graphServiceClient->subscriptions()->get()->wait();

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


Import-Module Microsoft.Graph.Beta.ChangeNotifications

Get-MgBetaSubscription

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


# 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

result = await graph_client.subscriptions.get()

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Отклик

Ниже показан пример отклика.

Примечание: Ответ, показанный здесь, может быть сокращен для читаемости.

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#subscriptions",
  "value": [
    {
      "id": "0fc0d6db-0073-42e5-a186-853da75fb308",
      "resource": "Users",
      "applicationId": "24d3b144-21ae-4080-943f-7067b395b913",
      "changeType": "updated,deleted",
      "clientState": null,
      "notificationUrl": "https://webhookappexample.azurewebsites.net/api/notifications",
      "lifecycleNotificationUrl":"https://webhook.azurewebsites.net/api/send/lifecycleNotifications",
      "expirationDateTime": "2018-03-12T05:00:00Z",
      "creatorId": "8ee44408-0679-472c-bc2a-692812af3437",
      "latestSupportedTlsVersion": "v1_2",
      "encryptionCertificate": "",
      "encryptionCertificateId": "",
      "includeResourceData": false,
      "notificationContentType": "application/json"
    }
  ]
}

Примечание. Значение свойства clientState не возвращается в целях безопасности.

Когда запрос возвращает несколько страниц данных, отклик включает свойство @odata.nextLink, помогающее управлять результатами. Дополнительные сведения см. в статье Разбиение данных Microsoft Graph по страницам в приложении.

Поделиться через

Перечисление подписок

Разрешения

aiInteraction

Основные сценарии

Расширенные сценарии

HTTP-запрос

Необязательные параметры запросов

Заголовки запросов

Текст запроса

Отклик

Пример

Запрос

Отклик

Обратная связь

Дополнительные ресурсы