Ressourcentyp Abonnementsubscription resource type

Ein Abonnement ermöglicht eine Client-app zum Empfangen von Benachrichtigungen zu Änderungen an Daten in Microsoft Graph.A subscription allows a client app to receive notifications about changes to data in Microsoft Graph. Abonnements werden derzeit für die folgenden Ressourcen aktiviert:Currently, subscriptions are enabled for the following resources:

  • E-Mail-Nachrichten, Ereignisse und Kontakte aus Outlook.Mail, events, and contacts from Outlook.
  • Unterhaltungen aus Office-Gruppen.Conversations from Office Groups.
  • Laufwerk Stammelemente aus OneDrive.Drive root items from OneDrive.
  • Benutzer und Gruppen aus dem Azure Active Directory.Users and Groups from Azure Active Directory.
  • Benachrichtigungen über die Microsoft Graph-Sicherheit API.Alerts from the Microsoft Graph Security API.

JSON-DarstellungJSON representation

Es folgt eine JSON-Darstellung der Ressource.Here is a JSON representation of the resource.

{
  "changeType": "string",
  "notificationUrl": "string",
  "resource": "string",
  "applicationId" : "string",
  "expirationDateTime": "String (timestamp)",
  "id": "string (identifier)",
  "clientState": "string",
  "creatorId": "string"
}

EigenschaftenProperties

EigenschaftProperty TypType BeschreibungDescription
changeTypechangeType stringstring Erforderlich.Required. Gibt den Typ der Änderung in der abonnierten Ressource an, die eine Benachrichtigung auslöst.Indicates the type of change in the subscribed resource that will raise a notification. Unterstützte Werte sind: created, updated, deleted.The supported values are: created, updated, deleted. Es können mehrere Werte mithilfe einer durch Trennzeichen getrennten Liste zusammen verwendet werden.Multiple values can be combined using a comma-separated list.

Hinweis: Laufwerk Root Element Benachrichtigungen unterstützen nur die updated ChangeType.Note: Drive root item notifications support only the updated changeType. Unterstützung von Benutzer- und Benachrichtigungen updated und deleted ChangeType.User and group notifications support updated and deleted changeType.
notificationUrlnotificationUrl stringstring Erforderlich.Required. Die URL des Endpunkts, die Benachrichtigungen erhalten werden.The URL of the endpoint that will receive the notifications. Diese URL muss nutzen Sie die HTTPS Protokoll.This URL must make use of the HTTPS protocol.
resourceresource stringstring Erforderlich.Required. Gibt die Ressource, die für Änderungen überwacht werden.Specifies the resource that will be monitored for changes. Die base-URL nicht einschließen (https://graph.microsoft.com/v1.0/).Do not include the base URL (https://graph.microsoft.com/v1.0/).
expirationDateTimeexpirationDateTime dateTimedateTime Erforderlich. Required. Gibt Datum und Uhrzeit für das Ablaufen des Webhook-Abonnements an.Specifies the date and time when the webhook subscription expires. Die Zeit wird in UTC angegeben und kann eine Dauer aus der Erstellung des Abonnements sein, die von der abonnierten Ressource abweicht.The time is in UTC, and can be an amount of time from subscription creation that varies for the resource subscribed to. In der folgenden Tabelle finden Sie die maximale Dauer unterstützter Abonnements.See the table below for maximum supported subscription length of time.
clientStateclientState stringstring Optional.Optional. Gibt den Wert der clientState-Eigenschaft an, die in jeder Benachrichtigung vom Dienst gesendet wird.Specifies the value of the clientState property sent by the service in each notification. Die Höchstlänge beträgt 128 Zeichen.The maximum length is 128 characters. Der Client kann prüfen, ob die Benachrichtigung vom Dienst stammt, indem er den Wert der mit dem Abonnement gesendeten clientState-Eigenschaft mit dem Wert der mit jeder Benachrichtigung empfangenen clientState-Eigenschaft vergleicht.The client can check that the notification came from the service by comparing the value of the clientState property sent with the subscription with the value of the clientState property received with each notification.
idid stringstring Eindeutige ID für das Abonnement. Schreibgeschützt.Unique identifier for the subscription. Read-only.
applicationIdapplicationId stringstring Bezeichner der Anwendung verwendet, um das Abonnement zu erstellen.Identifier of the application used to create the subscription. Schreibgeschützt.Read-only.
creatorIdcreatorId stringstring Bezeichner des Benutzers oder der Dienstprinzipalnamen, die das Abonnement erstellt.Identifier of the user or service principal that created the subscription. Wenn die app verwendet Berechtigungen zum Erstellen des Abonnements delegiert, enthält dieses Feld die Id des angemeldeten Benutzers an, den die app im Auftrag von aufgerufen.If the app used delegated permissions to create the subscription, this field contains the id of the signed-in user the app called on behalf of. Wenn die app Anwendungsberechtigungen verwendet wird, enthält dieses Feld die Id des Prinzipals Service für die app.If the app used application permissions, this field contains the id of the service principal corresponding to the app. Schreibgeschützt.Read-only.

Maximale Abonnementdauer pro RessourcentypMaximum length of subscription per resource type

RessourceResource Maximal zulässige AblaufzeitMaximum Expiration Time
MailMail 4230 Minuten (unter 3 Tage)4230 minutes (under 3 days)
KalenderCalendar 4230 Minuten (unter 3 Tage)4230 minutes (under 3 days)
KontakteContacts 4230 Minuten (unter 3 Tage)4230 minutes (under 3 days)
GruppenunterhaltungenGroup conversations 4230 Minuten (unter 3 Tage)4230 minutes (under 3 days)
LaufwerkstammelementeDrive root items 4230 Minuten (unter 3 Tage)4230 minutes (under 3 days)
SicherheitshinweiseSecurity alerts 43200 Minuten (unter 30 Tage)43200 minutes (under 30 days)

Hinweis: Vorhandene Anwendungen und neuen Anwendungen sollte den unterstützten Wert nicht überschreiten.Note: Existing applications and new applications should not exceed the supported value. In der Zukunft fehl alle Anforderungen zum Erstellen oder erneuern Sie ein Abonnement über den Höchstwert hinaus.In the future, any requests to create or renew a subscription beyond the maximum value will fail.

BeziehungenRelationships

KeineNone

MethodenMethods

MethodeMethod RückgabetypReturn Type BeschreibungDescription
Create subscriptionCreate subscription Abonnementsubscription Abonniert eine Listener-Anwendung zum Empfangen von Benachrichtigungen, wenn Microsoft Graph-Daten geändert werden.Subscribes a listener application to receive notifications when Microsoft Graph data changes.
Update subscriptionUpdate subscription Abonnementsubscription Erneuert ein Abonnement durch Aktualisierung der Ablaufzeit.Renews a subscription by updating its expiration time.
Liste von AbonnementsList subscriptions subscriptionsubscription Listen aktiver Abonnements.Lists active subscriptions.
Get subscriptionGet subscription Abonnementsubscription Dient zum Lesen der Eigenschaften und der Beziehungen des subscription-Objekts.Reads properties and relationships of subscription object.
Delete subscriptionDelete subscription KeineNone Löscht ein subscription-Objekt.Deletes a subscription object.