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

[アーティクル]
06/15/2022

名前空間: microsoft.graph

重要

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

注意事項

この機能を baseTask または baseTaskList で使用する既存のアプリは、これらのリソースに基づいて構築された To Do API セットが 2022 年 5 月 31 日の時点で非推奨になっているので、更新する必要があります。その API セットは、2022 年 8 月 31 日にデータを戻すことを停止します。 todoTask に基づいて構築された API セットを使用してください。

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

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

アクセス許可

この API は、次のアクセス許可スコープをサポートしています。アクセス許可の選択方法などに関する詳細については、「アクセス許可」を参照してください。

サポートされているリソース	委任 (職場または学校のアカウント)	委任 (個人用 Microsoft アカウント)	アプリケーション
baseTask (非推奨)	Tasks.ReadWrite, Subscription.Read.All	Tasks.ReadWrite, Subscription.Read.All	非サポート
callRecord (/communications/callRecords)	非サポート	非サポート	CallRecords.Read.All
チャネル (/teams/getAllChannels – 組織内のすべてのチャネル)	非サポート	非サポート	Channel.ReadBasic.All、ChannelSettings.Read.All
チャネル (/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
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 -- all channel messages in organization)	非サポート	非サポート	ChannelMessage.Read.All
chatMessage (/chats/{id}/messages)	Chat.Read, Chat.ReadWrite, Subscription.Read.All	非サポート	Chat.Read.All
chatMessage (/chats/getAllMessages -- all chat messages in organization)	非サポート	非サポート	Chat.Read.All
チャットメッセージ (/users/{id}/chats/getAllMessages -- 特定のユーザーが参加しているすべてのチャットのチャットメッセージ)	Chat.Read, Chat.ReadWrite, Subscription.Read.All	非サポート	Chat.Read.All、Chat.ReadWrite.All
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 (/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
driveItem (ユーザーの個人用 OneDrive)	サポート対象外	Files.ReadWrite, Subscription.Read.All	サポート対象外
driveItem (OneDrive for Business)	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
オンライン会議	非サポート	サポート対象外	OnlineMeetings.Read.All、OnlineMeetings.ReadWrite.All
プレゼンス	Presence.Read.All, Subscription.Read.All	非サポート	サポート対象外
プリンター	非サポート	非サポート	Printer.Read.All, Printer.ReadWrite.All
printTaskDefinition	非サポート	非サポート	PrintTaskDefinition.ReadWrite.All
セキュリティの警告	SecurityEvents.ReadWrite.All, Subscription.Read.All	サポート対象外	SecurityEvents.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
todoTask	Tasks.ReadWrite, Subscription.Read.All	Tasks.ReadWrite, Subscription.Read.All	非サポート
user	User.Read.All, Subscription.Read.All	User.Read.All	User.Read.All

注: * でマークされた権限は、リソース固有の同意を使用します。

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

基本シナリオ

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

呼び出し元アプリのコンテキスト	応答内容
サインインユーザーに代わってアプリが呼び出しを実行している (委任されたアクセス許可)。 - および - サブスクリプションの作成に必要な元のアクセス許可をアプリが持っている。メモ：これは、個人の 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


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var subscriptions = await graphClient.Subscriptions
    .Request()
    .GetAsync();

重要

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

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


const options = {
    authProvider,
};

const client = Client.init(options);

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

重要

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/beta/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/subscriptions"]]];
[urlRequest setHTTPMethod:@"GET"];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        NSError *jsonError = nil;
        MSCollection *collection = [[MSCollection alloc] initWithData:data error:&jsonError];
        MSGraphSubscription *subscription = [[MSGraphSubscription alloc] initWithDictionary:[[collection value] objectAtIndex: 0] error:&nserror];

}];

[meDataTask execute];

重要

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

SubscriptionCollectionPage subscriptions = graphClient.subscriptions()
    .buildRequest()
    .get();

重要

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

result, err := graphClient.Subscriptions().Get()

重要

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


Import-Module Microsoft.Graph.ChangeNotifications

Get-MgSubscription

重要

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 要求

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

要求ヘッダー

要求本文

応答

例

要求

応答

フィードバック

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