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

名前空間: microsoft.graph

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

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

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

アクセス許可

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

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

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 サービス プランを含む有効なライセンスがプロビジョニングされている必要があります。

基本シナリオ

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

高度なシナリオ

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

HTTP 要求

GET /subscriptions

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

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

要求ヘッダー

要求本文

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

応答

成功した場合、このメソッドは 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();

// 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)

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

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

const options = {
	authProvider,
};

const client = Client.init(options);

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

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


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


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

Import-Module Microsoft.Graph.Beta.ChangeNotifications

Get-MgBetaSubscription

# 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()

応答

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

注: ここに示す応答は、読みやすさのために短縮されている場合があります。

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