subscription-Ressourcentypsubscription resource type

Namespace: microsoft.graphNamespace: microsoft.graph

Mit einem Abonnement kann eine Client-App Änderungsbenachrichtigungen zu Datenänderungen in Microsoft Graph erhalten.A subscription allows a client app to receive change 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:

  • [Warnungen][] aus der Microsoft Graph-Sicherheits-APIAn alert from the Microsoft Graph Security API
  • Ein callRecord, der nach einem Anruf oder einer Besprechung in Microsoft Teams erstellt wurdeA callRecord produced after a call or meeting in Microsoft Teams
  • Eine ChatMessage gesendet über Teams oder Kanäle in Microsoft TeamsA chatMessage sent via teams or channels in Microsoft Teams
  • Eine [Unterhaltung][] in einer Microsoft 365-GruppeA conversation in a Microsoft 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
  • Eine [Liste][] auf einer SharePoint-[Website][]A list under a SharePoint site
  • [Nachrichten][], [Ereignisse][] oder [Kontakte][] in OutlookA message, event, or contact in Outlook
  • [Benutzer][] oder [Gruppen][] in Azure Active DirectoryA user or group in Azure Active Directory

Unter Verwenden der Microsoft Graph-API, um Änderungsbenachrichtigungen zu erhalten finden Sie die möglichen Ressourcenpfadwerte für jede unterstützte Ressource.See Use the Microsoft Graph API to get change notifications for the possible resource path values for each supported resource.

MethodenMethods

MethodeMethod RückgabetypReturn Type BeschreibungDescription
Create subscriptionCreate subscription Abonnementsubscription Abonniert eine Listener-Anwendung zum Empfangen von Änderungsbenachrichtigungen, wenn Microsoft Graph-Daten geändert werden.Subscribes a listener application to receive change notifications when Microsoft Graph data changes.
Abonnement aktualisierenUpdate 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.

EigenschaftenProperties

EigenschaftProperty TypType BeschreibungDescription
changeTypechangeType stringstring Erforderlich.Required. Gibt den Typ der Änderung in der abonnierten Ressource an, die eine Änderungsbenachrichtigung auslöst.Indicates the type of change in the subscribed resource that will raise a change 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: Änderungsbenachrichtigungen für Laufwerkstammelemente und Listen unterstützen nur den updated-changeType.Note: Drive root item and list change notifications support only the updated changeType. Änderungsbenachrichtigungen für Benutzer und Gruppen unterstützen den updated- und den deleted-changeType.User and group change notifications support updated and deleted changeType.
notificationUrlnotificationUrl stringstring Erforderlich.Required. Die URL des Endpunkts, der die Änderungsbenachrichtigungen erhält.The URL of the endpoint that will receive the change 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/). Hier finden Sie die möglichen Werte für den Ressourcenpfad für jede unterstützte Ressource.See the possible resource path values for each supported resource.
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 Änderungsbenachrichtigung vom Dienst gesendet wird.Specifies the value of the clientState property sent by the service in each change notification. Die Höchstlänge beträgt 128 Zeichen.The maximum length is 128 characters. Der Client kann prüfen, ob die Änderungsbenachrichtigung vom Dienst stammt, indem er den Wert der mit dem Abonnement gesendeten clientState-Eigenschaft mit dem Wert der mit jeder Änderungsbenachrichtigung empfangenen clientState-Eigenschaft vergleicht.The client can check that the change 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 change 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.
includeResourceDataincludeResourceData Boolescher WertBoolean Wenn auf truefestgelegt wird, ändern Sie Benachrichtigungen, Ressourcendaten miteinschließen (z. b. den Inhalt einer Chatnachricht).When set to true, change notifications include resource data (such as content of a chat message). Optional.Optional.
encryptionCertificateencryptionCertificate Zeichenfolgestring Eine Base64-codierte Darstellung eines Zertifikats mit einem öffentlichen Schlüssel zum Verschlüsseln von Ressourcendaten in Änderungsbenachrichtigungen.A base64-encoded representation of a certificate with a public key used to encrypt resource data in change notifications. Optional.Optional. Erforderlich, wenn includeResourceData- wahr ist.Required when includeResourceData is true.
encryptionCertificateIdencryptionCertificateId Zeichenfolgestring Eine benutzerdefinierte App-bereitgestellte ID zur Identifizierung des Zertifikats, das zum Entschlüsseln von Ressourcendaten erforderlich ist.A custom app-provided identifier to help identify the certificate needed to decrypt resource data. Optional.Optional.
latestSupportedTlsVersionlatestSupportedTlsVersion StringString Gibt die aktuelle Version von Transport Layer Security (TLS) an, die von dem durch notificationUrl angegebenen Benachrichtigungsendpunkt unterstützt wird.Specifies the latest version of Transport Layer Security (TLS) that the notification endpoint, specified by notificationUrl, supports. Mögliche Werte sind: v1_0, v1_1, v1_2, v1_3.The possible values are: v1_0, v1_1, v1_2, v1_3.
Abonnenten, deren Benachrichtigungsendpunkt eine niedrigere als die aktuell empfohlene Version (TLS 1.2) unterstützt, können durch Festlegen dieser Eigenschaft anhand einer definierten Zeitachse vorübergehend ihre veraltete Version von TLS verwenden, bevor sie das Upgrade auf TLS 1.2 ausführen.For subscribers whose notification endpoint supports a version lower than the currently recommended version (TLS 1.2), specifying this property by a set timeline allows them to temporarily use their deprecated version of TLS before completing their upgrade to TLS 1.2. Bei diesen Abonnenten würden Abonnementvorgänge fehlschlagen, wenn diese Eigenschaft nicht durch eine Zeitachse festgelegt würde.For these subscribers, not setting this property per the timeline would result in subscription operations failing.

Für Abonnenten, deren Benachrichtigungsendpunkt TLS 1.2 bereits unterstützt, ist das Festlegen dieser Eigenschaft optional.For subscribers whose notification endpoint already supports TLS 1.2, setting this property is optional. In diesen Fällen ist die Eigenschaft von Microsoft Graph standardmäßig auf v1_2 festgelegt.In such cases, Microsoft Graph defaults the property to v1_2.

Maximale Abonnementdauer pro RessourcentypMaximum length of subscription per resource type

RessourceResource Maximal zulässige AblaufzeitMaximum expiration time
SicherheitswarnungSecurity alert 43200 Minuten (unter 30 Tage)43200 minutes (under 30 days)
Teams callRecord Teams callRecord 4230 Minuten (unter 3 Tage)4230 minutes (under 3 days)
Teams chatMessageTeams chatMessage 60 Minuten (1 Stunde)60 minutes (1 hour)
Gruppen UnterhaltungGroup conversation 4230 Minuten (unter 3 Tage)4230 minutes (under 3 days)
OneDrive driveItemOneDrive driveItem 4230 Minuten (unter 3 Tage)4230 minutes (under 3 days)
SharePoint- ListeSharePoint list 4230 Minuten (unter 3 Tage)4230 minutes (under 3 days)
Outlook- Nachrichten-, -Ereignis, KontaktOutlook message, event, contact 4230 Minuten (unter 3 Tage)4230 minutes (under 3 days)
Benutzer, Gruppe, sonstige Verzeichnisressourcenuser, group, other directory resources 4230 Minuten (unter 3 Tage)4230 minutes (under 3 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

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",
  "includeResourceData": "boolean",
  "encryptionCertificate": "string",
  "encryptionCertificateId": "string",
  "latestSupportedTlsVersion": "string"
}