subscription-Ressourcentypsubscription resource type

Mit einem Abonnement kann eine Client-App Benachrichtigungen zu Datenänderungen in Microsoft Graph erhalten.A subscription allows a client app to receive notifications about changes to data in Microsoft Graph. Für die folgenden Ressourcen sind derzeit Abonnements aktiviert:Currently, subscriptions are enabled for the following resources:

  • [Nachrichten][], [Ereignisse][] oder [Kontakte][] in OutlookA message, event, or contact in Outlook
  • [Unterhaltungen][] einer Office 365-GruppeA conversation of an Office 365 group
  • Inhalte in der Hierarchie eines driveItem-Stammordners in OneDrive for Business bzw. eines driveItem-Stammordners oder -Unterordners im persönlichen OneDrive eines BenutzersContent in the hierarchy of a root folder driveItem in OneDrive for Business, or of a root folder or subfolder driveItem in a user's personal OneDrive
  • [Benutzer][] oder [Gruppen][] in Azure Active DirectoryA user or group in Azure Active Directory
  • [Warnungen][] aus der Microsoft Graph-Sicherheits-APIAn alert 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: Benachrichtigungen für Laufwerkstammelemente unterstützen nur den updated-changeType.Note: Drive root item notifications support only the updated changeType. Benachrichtigungen für Benutzer und Gruppen unterstützen den updated- und den deleted-changeType.User and group notifications support updated and deleted changeType.
notificationUrlnotificationUrl stringstring Erforderlich.Required. Die URL des Endpunkts, der die Benachrichtigungen erhält.The URL of the endpoint that will receive the notifications. Diese URL muss das HTTPS-Protokoll verwenden.This URL must make use of the HTTPS protocol.
resourceresource stringstring Erforderlich.Required. Gibt die Ressource an, deren Änderungen überwacht werden.Specifies the resource that will be monitored for changes. Fügen Sie nicht die Basis-URL hinzu (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, die zum Erstellen des Abonnements verwendet wird.Identifier of the application used to create the subscription. Schreibgeschützt.Read-only.
creatorIdcreatorId stringstring Bezeichner des Benutzers oder Dienstprinzipals, der das Abonnement erstellt hat.Identifier of the user or service principal that created the subscription. Wenn die App delegierte Berechtigungen zum Erstellen des Abonnements verwendet hat, enthält dieses Feld die ID des angemeldeten Benutzers, für den die App den Aufruf ausgeführt hat.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 hat, enthält dieses Feld die ID des Dienstprinzipals, der der App entspricht.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
Benutzer-, Gruppen-, andere VerzeichnisressourcenUser, group, other directory resources 4230 Minuten (unter 3 Tage)4230 minutes (under 3 days)
E-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)
SicherheitswarnungenSecurity alerts 43200 Minuten (unter 30 Tage)43200 minutes (under 30 days)

Hinweis: Vorhandene Anwendungen und neue Anwendungen sollten den unterstützten Wert nicht überschreiten.Note: Existing applications and new applications should not exceed the supported value. In Zukunft schlagen alle Anforderungen zur Erstellung oder Verlängerung eines Abonnements, die über den Maximalwert hinausgehen, fehl.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.
Abonnements auflistenList subscriptions subscriptionsubscription Listet aktive Abonnements auf.Lists active subscriptions.
Abonnement abrufenGet 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.