Abonnement abrufen

Namespace: microsoft.graph

Mit dieser API können Sie die Eigenschaften und Beziehungen eines Abonnements abrufen.

Im Abschnitt Berechtigungen der Tabelle finden Sie die Liste der Ressourcen, die das Abonnieren von Änderungsbenachrichtigungen unterstützen.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Berechtigungen

Abhängig von der Ressource und dem angeforderten Berechtigungstyp (delegiert oder Anwendung) ist die in der folgenden Tabelle angegebene Berechtigung die niedrigste Berechtigung, die zum Aufrufen dieser API erforderlich ist. Um mehr zu erfahren und vor der Wahl weiterer privilegierterer Berechtigungen mit Umsicht vorzugehen, suchen Sie unter Berechtigungen nach den folgenden Berechtigungen.

ChatMessage

chatMessage-Abonnements können so angegeben werden, dass sie Ressourcendaten enthalten (includeResourceData auf truefestgelegt). In diesem Fall ist eine Verschlüsselung erforderlich, und die Abonnementerstellung schlägt fehl, wenn für solche Abonnements kein encryptionCertificate angegeben ist.

Verwenden Sie den Prefer: include-unknown-enum-members Anforderungsheader, um die folgenden Werte in der erweiterbaren EnumerationchatMessagemessageType abzurufen: systemEventMessage for /teams/{id}/channels/{id}/messages und /chats/{id}/messages Ressource.

conversationMember

conversationMember-Abonnements können so angegeben werden, dass sie Ressourcendaten enthalten (includeResourceData auf truefestgelegt). In diesem Fall ist eine Verschlüsselung erforderlich, und die Abonnementerstellung schlägt fehl, wenn für solche Abonnements kein encryptionCertificate angegeben ist.

Team, Kanal und Chat

Team-, Kanal- und Chatabonnements können so angegeben werden, dass sie Ressourcendaten enthalten (includeResourceData auf truefestgelegt). In diesem Fall ist eine Verschlüsselung erforderlich, und die Abonnementerstellung schlägt fehl, wenn für solche Abonnements kein encryptionCertificate angegeben ist.

Sie können den Abfragezeichenfolgeparameter notifyOnUserSpecificProperties verwenden, wenn Sie Änderungen in einem bestimmten Chat oder auf Benutzerebene abonnieren. Wenn Sie den Abfragezeichenfolgenparameter notifyOnUserSpecificPropertiestrue während der Abonnementerstellung festlegen, werden zwei Arten von Nutzlasten an den Abonnenten gesendet. Ein Typ enthält benutzerspezifische Eigenschaften, der andere wird ohne diese gesendet. Weitere Informationen finden Sie unter Abrufen von Änderungsbenachrichtigungen für Chats mit Microsoft Graph.

aiInsights

Abonnements für Copilot AI Insights erfordern eine gültige Copilot-Lizenz, die den folgenden Copilot-Serviceplan umfasst:

• Microsoft 365 Copilot Chat: 3f30311c-6b1e-48a4-ab79-725b469da960

aiInteraction

Abonnements für Copilot KI-Interaktionen erfordern eine gültige Copilot-Lizenz, die den folgenden Copilot-Serviceplan umfasst:

• Microsoft 365 Copilot Chat: 3f30311c-6b1e-48a4-ab79-725b469da960

Bei Abonnements, die auf Copilot KI-Interaktionen abzielen, an denen ein bestimmter Benutzer beteiligt ist, müssen dem Benutzer im Ressourcenpfad die vorherigen Servicepläne zugewiesen sein, die sich in einem gültigen Zustand befinden.

Für Abonnements, die auf Copilot KI-Interaktionen für den gesamten Mandanten abzielen, muss der Mandant über gültige Lizenzen verfügen, die alle früheren Copilot-Servicepläne enthalten.

driveItem

Für Abonnements gelten weitere Einschränkungen für OneDrive-Elemente. Die Einschränkungen gelten für das Erstellen und Verwalten von Abonnements (das Erstellen, aktualisieren und löschen).

Auf einem persönlichen OneDrive können Sie den Stammordner oder einen beliebigen Unterordner in diesem Laufwerk abonnieren. Auf OneDrive für den Arbeitsplatz oder die Schule/Universität können Sie nur den Stammordner abonnieren. Änderungsbenachrichtigungen werden für die angeforderten Änderungstypen für den abonnierten Ordner oder eine Datei, einen Ordner oder eine andere driveItem-Instanz in seiner Hierarchie gesendet. Sie können keine Laufwerk - oder DriveItem-Instanzen abonnieren, die keine Ordner sind, wie z. B. einzelne Dateien.

Kontakt, Ereignis und Nachricht

Sie können Änderungen in Outlook-Kontakt-, Ereignis- oder Nachrichtenressourcen abonnieren und optional in der POST-Anforderungsnutzlast angeben, ob verschlüsselte Ressourcendaten in Benachrichtigungen eingeschlossen werden sollen.

Das Erstellen und Verwalten (Abrufen, Aktualisieren und Löschen) eines Abonnements erfordert einen Lesebereich für die Ressource. Beispiel: Zum Erhalten von Änderungsbenachrichtigungen zu Nachrichten benötigt Ihre App die Mail.Read-Berechtigung. Outlook-Änderungsbenachrichtigungen unterstützen delegierte und Anwendungsberechtigungsbereiche. Beachten Sie die folgenden Einschränkungen:

• Die delegierte Berechtigung unterstützt das Abonnieren von Objekten in Ordnern, die sich nur im Postfach des angemeldeten Benutzers befinden. Sie können z. B. die delegierte Berechtigung "Calendars.Read" nicht verwenden, um Ereignisse im Postfach eines anderen Benutzers zu abonnieren.

• So abonnieren Sie Änderungsbenachrichtigungen über Outlook-Kontakte, -Ereignisse oder -Nachrichten in freigegebenen oder delegierten Ordnern:

  • Verwenden Sie die entsprechende Anwendungsberechtigung, um Änderungen von Elementen in einem Ordner oder Postfach eines beliebigen Benutzers im Mandanten zu abonnieren.
  • Verwenden Sie die Outlook-Freigabeberechtigungen (Contacts.Read.Shared, Calendars.Read.Shared, Mail.Read.Shared und deren Gegenstücke zum Lesen/Schreiben) nicht, da sie das Abonnieren von Änderungsbenachrichtigungen für Elemente in freigegebenen oder delegierten Ordnern nicht unterstützen.

onlineBesprechungen, Anwesenheit

OnlineMeeting- und Präsenzabonnements erfordern eine Verschlüsselung für Benachrichtigungen mit Ressourcendaten. Die Abonnementerstellung schlägt fehl, wenn encryptionCertificate und encryptionCertificateId nicht angegeben sind, wenn Ressourcendaten in Benachrichtigungen gewünscht werden. Weitere Informationen finden Sie unter:

• Richten Sie Microsoft Graph-Änderungsbenachrichtigungen mit Ressourcendaten (Rich-Benachrichtigungen) ein.
• Abrufen von Änderungsbenachrichtigungen für Onlinebesprechungen.

virtualEventWebinar

Abonnements für virtuelle Ereignisse unterstützen nur grundlegende Benachrichtigungen und sind auf einige wenige Entitäten eines virtuellen Ereignisses beschränkt. Weitere Informationen zu den unterstützten Abonnementtypen finden Sie unter Abrufen von Änderungsbenachrichtigungen für Updates zu virtuellen Microsoft Teams-Ereignissen.

HTTP-Anforderung

GET /subscriptions/{id}

Optionale Abfrageparameter

Diese Methode unterstützt die OData-Abfrageparameter zur Anpassung der Antwort.

Anforderungsheader

Anforderungstext

Geben Sie keinen Anforderungstext für diese Methode an.

Antwort

Wenn die Methode erfolgreich verläuft, werden der Antwortcode 200 OK und ein subscription-Objekt im Antworttext zurückgegeben.

Beispiele

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

GET https://graph.microsoft.com/beta/subscriptions/{id}

// 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["{subscription-id}"].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().BySubscriptionId("subscription-id").Get(context.Background(), nil)

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Subscription result = graphClient.subscriptions().bySubscriptionId("{subscription-id}").get();

const options = {
	authProvider,
};

const client = Client.init(options);

let subscription = await client.api('/subscriptions/{id}')
	.version('beta')
	.get();

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


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


$result = $graphServiceClient->subscriptions()->bySubscriptionId('subscription-id')->get()->wait();

Import-Module Microsoft.Graph.Beta.ChangeNotifications

Get-MgBetaSubscription -SubscriptionId $subscriptionId

# 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.by_subscription_id('subscription-id').get()

Antwort

Das folgende Beispiel zeigt die Antwort.

HTTP/1.1 200 OK
Content-type: application/json

{
  "id":"7f105c7d-2dc5-4530-97cd-4e7ae6534c07",
  "resource":"me/messages",
  "applicationId" : "string",
  "changeType":"created,updated",
  "clientState":"secretClientValue",
  "notificationUrl":"https://webhook.azurewebsites.net/api/send/myNotifyClient",
  "lifecycleNotificationUrl":"https://webhook.azurewebsites.net/api/send/lifecycleNotifications",
  "expirationDateTime":"2016-11-20T18:23:45.9356913Z",
  "creatorId": "string",
  "latestSupportedTlsVersion": "v1_2",
  "encryptionCertificate": "",
  "encryptionCertificateId": "",
  "includeResourceData": false,
  "notificationContentType": "application/json"
}