Abonnements auflisten

Namespace: microsoft.graph

Wichtig

APIs unter der /beta Version in Microsoft Graph können geändert werden. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in Version 1.0 verfügbar ist, verwenden Sie die Versionsauswahl .

Achtung

Vorhandene Apps, die dieses Feature mit baseTask oder baseTaskList verwenden, sollten aktualisiert werden, da der auf diesen Ressourcen basierende Aufgaben-API-Satz ab dem 31. Mai 2022 veraltet ist. Dieser API-Satz wird ab dem 31. August 2022 keine Daten mehr zurückgeben. Verwenden Sie den API-Satz, der auf todoTask basiert.

Dient zum Abrufen einer Liste von Webhook-Abonnements.

Der Inhalt der Antwort hängt vom Kontext der aufrufenden App ab. Ausführliche Informationen finden Sie in den Szenarien im Abschnitt Berechtigungen.

Berechtigungen

Diese API unterstützt die folgenden Berechtigungsbereiche. Weitere Informationen, unter anderem zur Auswahl von Berechtigungen, finden Sie im Artikel zum Thema Berechtigungen.

Unterstützte Ressource	Delegiert (Geschäfts-, Schul- oder Unikonto)	Delegiert (persönliches Microsoft-Konto)	Anwendung
baseTask (veraltet)	Tasks.ReadWrite, Subscription.Read.All	Tasks.ReadWrite, Subscription.Read.All	Nicht unterstützt
callRecord (/communications/callRecords)	Nicht unterstützt	Nicht unterstützt	CallRecords.Read.All
Kanal (/teams/getAllChannels – alle Kanäle in einer Organisation)	Nicht unterstützt	Nicht unterstützt	Channel.ReadBasic.All, ChannelSettings.Read.All
channel (/teams/{id}/channels)	Channel.ReadBasic.All, ChannelSettings.Read.All, Subscription.Read.All	Nicht unterstützt	Channel.ReadBasic.All, ChannelSettings.Read.All
chat (/Chats – alle Chats in einer Organisation)	Nicht unterstützt	Nicht unterstützt	Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
chat (/chats/{id})	Chat.ReadBasic, Chat.Read, Chat.ReadWrite, Subscription.Read.All	Nicht unterstützt	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	Nicht unterstützt	ChannelMessage.Read.Group*, ChannelMessage.Read.All
ChatMessage (/Teams/getAllMessages – alle Kanalnachrichten in der Organisation)	Nicht unterstützt	Nicht unterstützt	ChannelMessage.Read.All
ChatMessage (/Chats/{ID}/Messages)	Chat.Read, Chat.ReadWrite, Subscription.Read.All	Nicht unterstützt	Chat.Read.All
ChatMessage (/Chats/getAllMessages – Alle Chatnachrichten in der Organisation)	Nicht unterstützt	Nicht unterstützt	Chat.Read.All
chatMessage (/users/{id}/chats/getAllMessages –- Chatnachrichten für alle Chats, an denen ein bestimmter Benutzer beteiligt ist)	Chat.Read, Chat.ReadWrite, Subscription.Read.All	Nicht unterstützt	Chat.Read.All, Chat.ReadWrite.All
contact	Contacts.Read, Subscription.Read.All	Contacts.Read, Subscription.Read.All	Contacts.Read
conversationMember (/chats/getAllMembers)	Nicht unterstützt	Nicht unterstützt	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	Nicht unterstützt	ChatMember.Read.Chat , Chat.Manage.Chat, ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
conversationMember (/teams/getAllMembers)	Nicht unterstützt	Nicht unterstützt	TeamMember.Read.All, TeamMember.ReadWrite.All
conversationMember (/teams/{id}/members)	TeamMember.Read.All, Subscription.Read.All	Nicht unterstützt	TeamMember.Read.All
conversationMember (/teams/{id}/channels/getAllMembers)	Nicht unterstützt	Nicht unterstützt	ChannelMember.Read.All
driveItem (persönliche OneDrive-Umgebung eines Benutzers)	Nicht unterstützt	Files.ReadWrite, Subscription.Read.All	Nicht unterstützt
driveItem (OneDrive for Business)	Files.ReadWrite.All, Subscription.Read.All	Nicht unterstützt	Files.ReadWrite.All
event	Calendars.Read, Subscription.Read.All	Calendars.Read, Subscription.Read.All	Calendars.Read
group	Group.Read.All, Subscription.Read.All	Nicht unterstützt	Group.Read.All
group conversation	Group.Read.All, Subscription.Read.All	Nicht unterstützt	Nicht unterstützt
list	Sites.ReadWrite.All, Subscription.Read.All	Nicht unterstützt	Sites.ReadWrite.All
message	Mail.ReadBasic, Mail.Read, Subscription.Read.All	Mail.ReadBasic, Mail.Read, Subscription.Read.All	Mail.Read
Onlinebesprechung	Nicht unterstützt	Nicht unterstützt	OnlineMeetings.Read.All, OnlineMeetings.ReadWrite.All
presence	Presence.Read.All, Subscription.Read.All	Nicht unterstützt	Nicht unterstützt
Drucker	Nicht unterstützt	Nicht unterstützt	Printer.Read.All, Printer.ReadWrite.All
printTaskDefinition	Nicht unterstützt	Nicht unterstützt	PrintTaskDefinition.ReadWrite.All
security alert	SecurityEvents.ReadWrite.All, Subscription.Read.All	Nicht unterstützt	SecurityEvents.ReadWrite.All
Team (/teams – alle Teams in einer Organisation)	Nicht unterstützt	Nicht unterstützt	Team.ReadBasic.All, TeamSettings.Read.All
team (/teams/{id})	Team.ReadBasic.All, TeamSettings.Read.All, Subscription.Read.All	Nicht unterstützt	Team.ReadBasic.All, TeamSettings.Read.All
todoTask	Tasks.ReadWrite, Subscription.Read.All	Tasks.ReadWrite, Subscription.Read.All	Nicht unterstützt
user	User.Read.All, Subscription.Read.All	User.Read.All	User.Read.All

Hinweis: Mit * markierte Berechtigungen verwenden ressourcenspezifische Zustimmung.

Antwort-Ergebnisse basieren auf dem Kontext der aufrufenden App. In den folgenden Abschnitten werden die gängigen Szenarien beschrieben.

Grundlegende Szenarien

In den meisten Fällen möchte eine Anwendung diejenigen Abonnements abrufen, die sie ursprünglich für den derzeit angemeldeten Benutzer oder für alle Benutzer im Verzeichnis (Firmen-oder Schulkonten) erstellt hat. Für diese Szenarien werden keine speziellen Berechtigungen benötigt, welche diejenigen übersteigen, die die App ursprünglich dazu verwendet hat, um die Abonnements anzulegen.

Kontext der aufrufenden Anwendung	Die Antwort enthält
App ruft im Auftrag des angemeldeten Benutzers ab (delegierte Berechtigung). -und- Die App besitzt die ursprüngliche Berechtigung, die benötigt wurde, um das Abonnement zu erstellen. Hinweis: Dies gilt sowohl für persönliche Microsoft-Konten als auch für Geschäfts-/Schulkonten.	Abonnements, die von dieser App einzig für den angemeldeten Benutzer erstellt wurden.
Die App ruft im eigenen Namen ab (Anwendungsberechtigung). -und- Die App besitzt die ursprüngliche Berechtigung, die benötigt wurde, um das Abonnement zu erstellen. Hinweis: Dies gilt nur für Firmen- oder Schulkonten.	Abonnements, die von dieser App für sich selbst oder für alle Benutzer im Verzeichnis erstellt wurden.

Erweiterte Szenarien

In einigen Fällen möchte eine App von anderen Apps erstellte Abonnements abrufen. Ein Benutzer möchte z. B. alle Abonnements anzeigen, die mit jeglichen Apps in seinem Auftrag erstellt wurden. Oder ein Administrator könnte alle Abonnements einsehen wollen, die von allen Apps in seinem Verzeichnis eingerichtet wurden. Für derartige Szenarien wird eine delegierte Berechtigung Subscription.Read.All benötigt.

Kontext der aufrufenden Anwendung	Die Antwort enthält
App ruft im Auftrag des angemeldeten Benutzers ab (delegierte Berechtigung). Der Benutzer besitzt keine Administratorrechte. -und- Die App verfügt über die Berechtigung Subscription.Read.All Hinweis: Dies gilt sowohl für persönliche Microsoft-Konten als auch für Firmen- oder Schulkonten.	Abonnements, die von jeglichen Apps einzig für den angemeldeten Benutzer erstellt wurden.
App ruft im Auftrag des angemeldeten Benutzers ab (delegierte Berechtigung). Der Benutzer ist ein Administrator. -und- Die App verfügt über die Berechtigung Subscription.Read.All Hinweis: Dies gilt nur für Firmen- oder Schulkonten.	Abonnements, die von jeglichen Apps für alle Benutzer im Verzeichnis erstellt wurden.

HTTP-Anforderung

GET /subscriptions

Optionale Abfrageparameter

Diese Methode unterstützt nicht die OData-Abfrageparameter, mit denen die Antwort angepasst werden kann.

Anforderungsheader

Name	Typ	Beschreibung
Authorization	string	Bearer {token}. Erforderlich.

Anforderungstext

Geben Sie für diese Methode keinen Anforderungstext an.

Antwort

Im Erfolgsfall erzeugt diese Methode einen 200 OKAntwortcode sowie eine Auflistung aller Abonnement-Objekte im Antworttext.

Beispiel

Anforderung

HTTP

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

C#

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

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

Wichtig

Microsoft Graph SDKs verwenden standardmäßig die Version 1.0 der API und unterstützen nicht alle Typen, Eigenschaften und APIs, die in der Betaversion verfügbar sind. Ausführliche Informationen zum Zugreifen auf die Beta-API mit dem SDK finden Sie unter Verwenden der Microsoft Graph-SDKs mit der Beta-API.

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.

JavaScript

const options = {
    authProvider,
};

const client = Client.init(options);

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

Wichtig

Microsoft Graph SDKs verwenden standardmäßig die Version 1.0 der API und unterstützen nicht alle Typen, Eigenschaften und APIs, die in der Betaversion verfügbar sind. Ausführliche Informationen zum Zugreifen auf die Beta-API mit dem SDK finden Sie unter Verwenden der Microsoft Graph-SDKs mit der Beta-API.

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.

Objective-C

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];

Wichtig

Microsoft Graph SDKs verwenden standardmäßig die Version 1.0 der API und unterstützen nicht alle Typen, Eigenschaften und APIs, die in der Betaversion verfügbar sind. Ausführliche Informationen zum Zugreifen auf die Beta-API mit dem SDK finden Sie unter Verwenden der Microsoft Graph-SDKs mit der Beta-API.

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.

Java

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

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

Wichtig

Microsoft Graph SDKs verwenden standardmäßig die Version 1.0 der API und unterstützen nicht alle Typen, Eigenschaften und APIs, die in der Betaversion verfügbar sind. Ausführliche Informationen zum Zugreifen auf die Beta-API mit dem SDK finden Sie unter Verwenden der Microsoft Graph-SDKs mit der Beta-API.

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.

Go

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

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

Wichtig

Microsoft Graph SDKs verwenden standardmäßig die Version 1.0 der API und unterstützen nicht alle Typen, Eigenschaften und APIs, die in der Betaversion verfügbar sind. Ausführliche Informationen zum Zugreifen auf die Beta-API mit dem SDK finden Sie unter Verwenden der Microsoft Graph-SDKs mit der Beta-API.

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.

PowerShell

Import-Module Microsoft.Graph.ChangeNotifications

Get-MgSubscription

Wichtig

Microsoft Graph SDKs verwenden standardmäßig die Version 1.0 der API und unterstützen nicht alle Typen, Eigenschaften und APIs, die in der Betaversion verfügbar sind. Ausführliche Informationen zum Zugreifen auf die Beta-API mit dem SDK finden Sie unter Verwenden der Microsoft Graph-SDKs mit der Beta-API.

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.

Antwort

Nachfolgend sehen Sie ein Beispiel der Antwort.

Hinweis: Die hier angezeigte Antwort kann zur besseren Lesbarkeit gekürzt werden.

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"
    }
  ]
}

Hinweis: Der Wert der Eigenschaft clientState wird aus Sicherheitsgründen nicht zurückgegeben.

Wenn eine Anforderung mehrere Seiten voller Daten erzeugt, so enthält die Antwort eine @odata.nextLink Eigenschaft, um die Ergebnisse besser verwalten zu können. Weitere Informationen finden Sie unter Paging der Microsoft Graph-Daten in Ihrer App.