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

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

Получение свойств и связей подписок на веб-перехватчики с учетом идентификатора приложения, пользователя и его роли в клиенте.

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

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

Разрешения

Этот API поддерживает перечисленные ниже области разрешений. Дополнительные сведения, в том числе о выборе разрешений, см. в статье Разрешения.

Примечание. Разрешения, помеченные звездочкой (*), используют согласие для конкретных ресурсов.

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

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

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

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

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

HTTP-запрос

GET /subscriptions

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

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

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

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

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

Отклик

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

Пример

Запрос

GET https://graph.microsoft.com/v1.0/subscriptions

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

// To initialize your graphClient, see https://video2.skills-academy.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Subscriptions.GetAsync();

mgc subscriptions list

// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://video2.skills-academy.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')
	.get();

<?php
use Microsoft\Graph\GraphServiceClient;


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


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

Import-Module Microsoft.Graph.ChangeNotifications

Get-MgSubscription

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://video2.skills-academy.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/v1.0/$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 по страницам в приложении.