サブスクリプションを一覧表示する

[アーティクル]
07/26/2024

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

Webhook サブスクリプションの一覧を取得します。

応答の内容は、アプリが呼び出しているコンテキストによって異なります。詳細については、「アクセス許可セクションのシナリオ」を参照してください。

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

グローバルサービス	米国政府機関 L4	米国政府機関 L5 (DOD)	21Vianet が運営する中国
✅	✅	✅	✅

アクセス許可

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

注:

一部のリソースでは、複数のシナリオで変更通知がサポートされており、それぞれに異なるアクセス許可が必要な場合があります。このような場合は、リソースパスを使用してシナリオを区別します。

サポートされているリソース	委任 (職場または学校のアカウント)	委任 (個人用 Microsoft アカウント)	アプリケーション
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
チャット `/chats` 組織内のすべてのチャット。	サポートされていません。	サポートされていません。	Chat.ReadBasic.All、 Chat.Read.All、 Chat.ReadWrite.All
チャット `/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
チャット `/appCatalogs/teamsApps/{id}/installedToChats` 特定の Teams アプリがインストールされている組織内のすべてのチャット。	サポートされていません。	サポートされていません。	Chat.ReadBasic.WhereInstalled、Chat.Read.WhereInstalled、Chat.ReadWrite.WhereInstalled
チャット `/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
イベント	Calendars.Read, Subscription.Read.All	Calendars.Read, Subscription.Read.All	Calendars.Read
グループ	Group.Read.All, Subscription.Read.All	サポートされていません。	Group.Read.All
グループ会話	Group.Read.All, Subscription.Read.All	サポートされていません。	サポートされていません。
リスト	Sites.ReadWrite.All, Subscription.Read.All	サポートされていません。	Sites.ReadWrite.All
メッセージ	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.Read.All, Subscription.Read.All	サポートされていません。	サポートされていません。
printer	サポートされていません。	サポートされていません。	Printer.Read.All, Printer.ReadWrite.All
printTaskDefinition	サポートされていません。	サポートされていません。	PrintTaskDefinition.ReadWrite.All
セキュリティの警告	SecurityEvents.ReadWrite.All, Subscription.Read.All	サポートされていません。	SecurityEvents.ReadWrite.All
シフト `/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

応答の結果は、呼び出し元アプリのコンテキストによって異なります。以下のセクションでは、一般的なシナリオについて説明します。

基本シナリオ

ほとんどの場合、アプリケーションは、現在サインインしているユーザーまたはディレクトリ内のすべてのユーザー (職場/学校アカウント) 用に最初に作成したサブスクリプションを取得したいと考えています。これらのシナリオでは、アプリがサブスクリプションを作成するために最初に使用したアクセス許可を超える特別なアクセス許可は必要ありません。

呼び出し元アプリのコンテキスト	応答内容
サインインユーザーに代わってアプリが呼び出しを実行している (委任されたアクセス許可)。 - および - サブスクリプションの作成に必要な元のアクセス許可をアプリが持っている。手記：このシナリオは、個人の Microsoft アカウントと職場/学校アカウントの両方に適用されます。	サインインしているユーザー専用にアプリによって作成されたサブスクリプション。
アプリがそのアプリのために呼び出しを実行している (アプリケーションのアクセス許可)。 - および - サブスクリプションの作成に必要な元のアクセス許可をアプリが持っている。注: このシナリオは、職場/学校アカウントにのみ適用されます。	アプリによって自身またはディレクトリ内の任意のユーザー用に作成されたサブスクリプション。

高度なシナリオ

場合によっては、アプリは、他のアプリによって作成されたサブスクリプションを取得しようとします。たとえば、ユーザーが、自分に代わって任意のアプリによって作成されたすべてのサブスクリプションを確認しようとすることがあります。または、ディレクトリ内のすべてのアプリのすべてのサブスクリプションを表示するグローバル管理者。このような場合、委任されたアクセス許可の Subscription.Read.All が必要になります。

呼び出し元アプリのコンテキスト	応答内容
サインインユーザーに代わってアプリが呼び出しを実行している (委任されたアクセス許可)。ユーザーは管理者ではない。 - および - Subscription.Read.All アクセス許可をアプリが持っている注: このシナリオは、個人の Microsoft アカウントと職場/学校アカウントの両方に適用されます。	任意のアプリによって作成された、サインインユーザーのみのサブスクリプション。
サインインユーザーに代わってアプリが呼び出しを実行している (委任されたアクセス許可)。ユーザーはグローバル管理者です。 - および - Subscription.Read.All アクセス許可をアプリが持っている注: このシナリオは、職場/学校アカウントにのみ適用されます。	任意のアプリによって作成された、ディレクトリ内の任意のユーザーのサブスクリプション。

HTTP 要求

GET /subscriptions

オプションのクエリパラメーター

このメソッドは、応答のカスタマイズに役立つ OData クエリパラメーターをサポートしていません。

要求ヘッダー

名前	型	説明
Authorization	string	ベアラー {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();

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ版で使用可能なすべての型、プロパティ、API がサポートされているわけではありません。 SDK を使用してベータ API にアクセスする方法の詳細については、「ベータ API で Microsoft Graph SDK を使用する」を参照してください。

プロジェクトに 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 データをページングする」を参照してください。

次の方法で共有

サブスクリプションを一覧表示する

アクセス許可

基本シナリオ

高度なシナリオ

HTTP 要求

オプションのクエリパラメーター

要求ヘッダー

要求本文

応答

例

要求

応答

フィードバック

その他のリソース

次の方法で共有

サブスクリプションを一覧表示する

アクセス許可

基本シナリオ

高度なシナリオ

HTTP 要求

オプションのクエリ パラメーター

要求ヘッダー

要求本文

応答

例

要求

応答

フィードバック

その他のリソース

オプションのクエリパラメーター