Freigeben über


Abonnement aktualisieren

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Erneuert ein Abonnement durch Verlängern seiner Ablaufzeit.

In der Tabelle im Abschnitt Berechtigungen sind die Ressourcen aufgeführt, die das Abonnieren von Änderungsbenachrichtigungen unterstützen.

Abonnements laufen nach einem Zeitraum ab, der je nach Ressourcentyp variiert. Um zu vermeiden, dass Änderungsbenachrichtigungen fehlen, sollte eine App ihre Abonnements rechtzeitig vor dem Ablaufdatum verlängern. Informationen zur maximalen Länge eines Abonnements für jeden Ressourcentyp finden Sie unter Abonnement .

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

Globaler Dienst US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet

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.

Hinweis

Einige Ressourcen unterstützen Änderungsbenachrichtigungen in mehreren Szenarien, von denen jedes unterschiedliche Berechtigungen erfordert. Verwenden Sie in diesen Fällen den Ressourcenpfad, um die Szenarien zu unterscheiden.

Unterstützte Ressource Delegiert (Geschäfts-, Schul- oder Unikonto) Delegiert (persönliches Microsoft-Konto) Anwendung
approvalItems Nicht unterstützt Nicht unterstützt ApprovalSolution.ReadWrite.All
callRecord Nicht unterstützt Nicht unterstützt CallRecords.Read.All
callRecording
communications/onlineMeetings/getAllRecordings
Jede Aufzeichnung wird im Mandanten verfügbar.
Nicht unterstützt Nicht unterstützt OnlineMeetingRecording.Read.All
callRecording
communications/onlineMeetings/{onlineMeetingId}/recordings
Jede Aufzeichnung wird für eine bestimmte Besprechung verfügbar.
OnlineMeetingRecording.Read.All Nicht unterstützt OnlineMeetingRecording.Read.All
callRecording
users/{userId}/onlineMeetings/getAllRecordings
Eine Anrufaufzeichnung, die in einer Besprechung verfügbar wird, die von einem bestimmten Benutzer organisiert wird.
OnlineMeetingRecording.Read.All Nicht unterstützt OnlineMeetingRecording.Read.All
callRecording
appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllRecordings
Eine Anrufaufzeichnung, die in einer Besprechung verfügbar wird, in der eine bestimmte Teams-App installiert ist.
Nicht unterstützt Nicht unterstützt OnlineMeetingRecording.Read.All, OnlineMeetingRecording.Read.Chat
callTranscript
communications/onlineMeetings/getAllTranscripts
Jedes Transkript wird im Mandanten verfügbar.
Nicht unterstützt Nicht unterstützt OnlineMeetingTranscript.Read.All
callTranscript
communications/onlineMeetings/{onlineMeetingId}/transcripts
Jedes Transkript wird für eine bestimmte Besprechung verfügbar.
OnlineMeetingTranscript.Read.All Nicht unterstützt OnlineMeetingTranscript.Read.All
callTranscript
users/{userId}/onlineMeetings/getAllTranscripts
Ein Anruftranskript, das in einer Besprechung verfügbar wird, die von einem bestimmten Benutzer organisiert wird.
OnlineMeetingTranscript.Read.All Nicht unterstützt OnlineMeetingTranscript.Read.All
callTranscript
appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllTranscripts
Ein Anruftranskript, das in einer Besprechung verfügbar wird, in der eine bestimmte Teams-App installiert ist.
Nicht unterstützt Nicht unterstützt OnlineMeetingTranscript.Read.All, OnlineMeetingTranscript.Read.Chat
channel
/teams/getAllChannels
Alle Kanäle in einer Organisation.
Nicht unterstützt Nicht unterstützt Channel.ReadBasic.All, ChannelSettings.Read.All
channel
/teams/{id}/channels
Alle Kanäle in einem bestimmten Team in einer Organisation.
Channel.ReadBasic.All, ChannelSettings.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}
Ein bestimmter Chat.
Chat.ReadBasic, Chat.Read, Chat.ReadWrite Nicht unterstützt ChatSettings.Read.Chat, ChatSettings.ReadWrite.Chat, Chat.Manage.Chat, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
chat
/appCatalogs/teamsApps/{id}/installedToChats
Alle Chats in einer Organisation, in der eine bestimmte Teams-App installiert ist.
Nicht unterstützt Nicht unterstützt Chat.ReadBasic.WhereInstalled, Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled
chat
/users/{id}/chats
Alle Chats, an denen ein bestimmter Benutzer beteiligt ist.
Chat.ReadBasic, Chat.Read, Chat.ReadWrite Nicht unterstützt Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
chatMessage
/teams/{id}/channels/{id}/messages
Alle Nachrichten und Antworten in einem bestimmten Kanal.
ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.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
Alle Nachrichten in einem Chat.
Chat.Read, Chat.ReadWrite Nicht unterstützt Chat.Read.All
chatMessage
/chats/getAllMessages
Alle Chatnachrichten in einer Organisation.
Nicht unterstützt Nicht unterstützt Chat.Read.All
chatMessage
/users/{id}/chats/getAllMessages
Chatnachrichten für alle Chats, zu der ein bestimmter Benutzer gehört.
Chat.Read, Chat.ReadWrite Nicht unterstützt Chat.Read.All, Chat.ReadWrite.All
chatMessage
/appCatalogs/teamsApps/{id}/installedToChats/getAllMessages
Chatnachrichten für alle Chats in einer Organisation, in der eine bestimmte Teams-App installiert ist.
Nicht unterstützt Nicht unterstützt Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled
contact Contacts.Read Contacts.Read Contacts.Read
conversationMember
/chats/getAllMembers
Mitglieder aller Chats in einer Organisation.
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
Mitglieder eines bestimmten Chats.
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
/appCatalogs/teamsApps/{id}/installedToChats/getAllMembers
Chatmitglieder für alle Chats in einer Organisation, in der eine bestimmte Teams-App installiert ist.
Nicht unterstützt Nicht unterstützt ChatMember.Read.WhereInstalled, ChatMember.ReadWrite.WhereInstalled, Chat.ReadBasic.WhereInstalled, Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled
conversationMember
/teams/getAllMembers
Mitglieder in allen Teams in einer Organisation.
Nicht unterstützt Nicht unterstützt TeamMember.Read.All, TeamMember.ReadWrite.All
conversationMember
/teams/{id}/members
Mitglieder in einem bestimmten Team.
TeamMember.Read.All Nicht unterstützt TeamMember.Read.All
conversationMember
/teams/{id}/channels/getAllMembers
Mitglieder in allen privaten Kanälen eines bestimmten Teams.
Nicht unterstützt Nicht unterstützt ChannelMember.Read.All
conversationMember
/teams/getAllChannels/getAllMembers
Nicht unterstützt Nicht unterstützt ChannelMember.Read.All
driveItem (persönliche OneDrive-Umgebung eines Benutzers) Nicht unterstützt Files.ReadWrite Nicht unterstützt
driveItem (OneDrive für Arbeit oder Schule) Files.ReadWrite.All Nicht unterstützt Files.ReadWrite.All
event Calendars.Read Calendars.Read Calendars.Read
group Group.Read.All Nicht unterstützt Group.Read.All
group conversation Group.Read.All Nicht unterstützt Nicht unterstützt
list Sites.ReadWrite.All Nicht unterstützt Sites.ReadWrite.All
message Mail.ReadBasic, Mail.Read Mail.ReadBasic, Mail.Read Mail.Read
offerShiftRequest
/teams/{id}/schedule/offerShiftRequests
Änderungen an einer Angebotsverschiebungsanforderung in einem Team.
Schedule.Read.All, Schedule.ReadWrite.All Nicht unterstützt Schedule.Read.All, Schedule.ReadWrite.All
Onlinebesprechung Nicht unterstützt Nicht unterstützt OnlineMeetings.Read.All, OnlineMeetings.ReadWrite.All
openShiftChangeRequest
/teams/{id}/schedule/openShiftChangeRequests
Änderungen an allen offenen Schichtanforderungen in einem Team.
Schedule.Read.All, Schedule.ReadWrite.All Nicht unterstützt Schedule.Read.All, Schedule.ReadWrite.All
presence Presence.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 Nicht unterstützt SecurityEvents.ReadWrite.All
shift
/teams/{id}/schedule/shifts
Änderungen an jeder Verschiebung in einem Team.
Schedule.Read.All, Schedule.ReadWrite.All Nicht unterstützt Schedule.Read.All, Schedule.ReadWrite.All
swapShiftsChangeRequest
/teams/{id}/schedule/swapShiftsChangeRequests
Änderungen an allen Verschiebungsanforderungen in einem Team.
Schedule.Read.All, Schedule.ReadWrite.All Nicht unterstützt Schedule.Read.All, Schedule.ReadWrite.All
team
/teams
Alle Teams in einer Organisation.
Nicht unterstützt Nicht unterstützt Team.ReadBasic.All, TeamSettings.Read.All
team
/teams/{id}
Ein bestimmtes Team.
Team.ReadBasic.All, TeamSettings.Read.All Nicht unterstützt Team.ReadBasic.All, TeamSettings.Read.All
timeOffRequest
/teams/{id}/schedule/timeOffRequests
Änderungen an einer Anforderung für eine ausserplanende Zeit in einem Team.
Schedule.Read.All, Schedule.ReadWrite.All Nicht unterstützt Schedule.Read.All, Schedule.ReadWrite.All
todoTask Tasks.ReadWrite Tasks.ReadWrite Nicht unterstützt
user User.Read.All User.Read.All User.Read.All
virtualEventWebinar VirtualEvent.Read Nicht unterstützt VirtualEvent.Read.All
baseTask (veraltet) Tasks.ReadWrite Tasks.ReadWrite Nicht unterstützt

Hinweis

Für die folgenden Berechtigungen wird eine ressourcenspezifische Zustimmung verwendet:

  • OnlineMeetingRecording.Read.Chat
  • OnlineMeetingTranscript.Read.Chat
  • ChatSettings.Read.Chat
  • ChatSettings.ReadWrite.Chat
  • Chat.Manage.Chat
  • ChannelMessage.Read.Group
  • ChatMember.Read.Chat

ChatMessage

chatMessage-Abonnements können angegeben werden, um Ressourcendaten einzuschließen. Wenn angegeben wird, dass Ressourcendaten eingeschlossen werden sollen (includeResourceData festgelegt auf true), ist eine Verschlüsselung erforderlich. Die Abonnementerstellung schlägt fehl, wenn für solche Abonnements kein encryptionCertificate angegeben ist.

Sie müssen den Anforderungsheader Prefer: include-unknown-enum-members verwenden, um die folgenden Werte in chatMessagemessageTypeevolvable enum abzurufen: systemEventMessage for /teams/{id}/channels/{id}/messages und /chats/{id}/messages resource.

Hinweis

/teams/getAllMessages, /chats/getAllMessages, /me/chats/getAllMessages, /users/{id}/chats/getAllMessagesund /appCatalogs/teamsApps/{id}/installedToChats/getAllMessages sind getaktete APIs. Zahlungsmodelle und Lizenzierungsanforderungen können gelten. /teams/getAllMessagesund /chats/getAllMessages unterstützen sowohl als auch model=A die model=B Zahlungsmodelle , /me/chats/getAllMessages/users/{id}/chats/getAllMessagesund /appCatalogs/teamsApps/{id}/installedToChats/getAllMessages unterstützen nur model=B. Wenn Sie in Ihrer Abfrage kein Zahlungsmodell angeben, wird der Standardauswertungsmodus verwendet.

Hinweis

Um ein Zahlungsmodell für eine abonnierte Ressource einer Änderungsbenachrichtigung hinzuzufügen oder zu ändern, müssen Sie ein neues Abonnement für Änderungsbenachrichtigungen mit dem neuen Zahlungsmodell erstellen. Das Aktualisieren einer vorhandenen Änderungsbenachrichtigung funktioniert nicht.

conversationMember

conversationMember-Abonnements können so angegeben werden, dass sie Ressourcendaten enthalten. Wenn angegeben wird, dass Ressourcendaten eingeschlossen werden sollen (includeResourceData festgelegt auf true), ist eine Verschlüsselung erforderlich. Die Abonnementerstellung schlägt fehl, wenn kein encryptionCertificate angegeben ist.

Hinweis

/teams/getAllMembers, /chats/getAllMembersund /appCatalogs/teamsApps/{id}/installedToChats/getAllMembers sind getaktete APIs. Zahlungsmodelle und Lizenzierungsanforderungen können gelten. /teams/getAllMembersund /chats/getAllMembers unterstützen sowohl als model=B auch model=A zahlungsmodelle. /appCatalogs/teamsApps/{id}/installedToChats/getAllMembers unterstützt nur model=B. Wenn Sie in Ihrer Abfrage kein Zahlungsmodell angeben, wird der Standardauswertungsmodus verwendet.

Hinweis

Um ein Zahlungsmodell für eine abonnierte Ressource einer Änderungsbenachrichtigung hinzuzufügen oder zu ändern, müssen Sie ein neues Abonnement für Änderungsbenachrichtigungen mit dem neuen Zahlungsmodell erstellen. Das Aktualisieren einer vorhandenen Änderungsbenachrichtigung funktioniert nicht.

Team, Kanal und Chat

Team-, Kanal- und Chatabonnements können so angegeben werden, dass sie Ressourcendaten enthalten. Wenn angegeben wird, dass Ressourcendaten eingeschlossen werden sollen (includeResourceData festgelegt auf true), ist eine Verschlüsselung erforderlich. Die Abonnementerstellung schlägt fehl, wenn kein encryptionCertificate angegeben ist.

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

Hinweis

/appCatalogs/teamsApps/{id}/installedToChats verfügt über Lizenzierungs- und Zahlungsanforderungen, die speziell nur model=Bunterstützt werden. Wenn kein Modell angegeben ist, wird der Auswertungsmodus verwendet.

Hinweis

Um ein Zahlungsmodell für eine abonnierte Ressource einer Änderungsbenachrichtigung hinzuzufügen oder zu ändern, müssen Sie ein neues Abonnement für Änderungsbenachrichtigungen mit dem neuen Zahlungsmodell erstellen. Das Aktualisieren einer vorhandenen Änderungsbenachrichtigung funktioniert nicht.

Anforderungsbeispiel

Geben Sie den model Abfrageparameter in der Ressourcen- Eigenschaft im Anforderungstext an.

POST https://graph.microsoft.com/v1.0/subscriptions
Content-type: application/json

{
   "changeType": "created",
   "notificationUrl": "https://webhook.azurewebsites.net/api/send/myNotifyClient",
   "resource": "chats/getAllMessages?model=A",
   "expirationDateTime":"2016-11-20T18:23:45.9356913Z",
   "clientState": "secretClientValue",
   "latestSupportedTlsVersion": "v1_2"
}

driveItem

Für Abonnements auf OneDrive-Elementen gelten weitere Einschränkungen. 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 Arbeit oder Schule können Sie nur den Stammordner abonnieren. Änderungsbenachrichtigungen werden für die angeforderten Änderungen am abonnierten Ordner oder einer beliebigen Datei, eines Ordners oder einer anderen driveItem-Instanz in seiner Hierarchie gesendet. Sie können keine drive- oder driveItem-Instanzen abonnieren, die keine Ordner sind, z. B. einzelne Dateien.

Kontakt, Ereignis und Nachricht

Sie können Änderungen an 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. Beispielsweise können Sie 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 nicht die Outlook-Freigabeberechtigungen (Contacts.Read.Shared, Calendars.Read.Shared, Mail.Read.Shared und deren Entsprechungen mit Lese-/Schreibzugriff), da sie das Abonnieren von Änderungsbenachrichtigungen für Elemente in freigegebenen oder delegierten Ordnern nicht unterstützen.

onlineMeetings, Anwesenheit

onlineMeetings und Anwesenheitsabonnements erfordern eine Verschlüsselung für Benachrichtigungen mit Ressourcendaten. Die Abonnementerstellung schlägt fehl, wenn encryptionCertificate und encryptionCertificateId nicht angegeben werden, wenn Ressourcendaten in Benachrichtigungen gewünscht werden. Ausführliche Informationen zu Anwesenheits- und Onlinebesprechungsabonnements finden Sie unter Abrufen von Änderungsbenachrichtigungen für Anwesenheitsupdates in Microsoft Teams und Abrufen von Änderungsbenachrichtigungen für Onlinebesprechungen.

virtualEventWebinar

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

HTTP-Anforderung

PATCH /subscriptions/{id}

Anforderungsheader

Name Typ Beschreibung
Authorization string Bearer {token}. Erforderlich. Erfahren Sie mehr über die Authentifizierung und Autorisierung.

Anforderungstext

Geben Sie im Anforderungstext nur die Werte für die Eigenschaften an, die aktualisiert werden sollen. Vorhandene Eigenschaften, die nicht im Anforderungstext enthalten sind, behalten ihre vorherigen Werte bei oder werden basierend auf Änderungen an anderen Eigenschaftswerten neu berechnet.

In der folgenden Tabelle sind die Eigenschaften angegeben, die aktualisiert werden können.

Name Typ Beschreibung
expirationDateTime DateTimeOffset Gibt das Datum und die Uhrzeit in UTC an, zu dem das Abonnement abläuft. Für das maximal unterstützte Abonnement variiert die Dauer je nach Ressource.

Antwort

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

Weitere Informationen dazu, wie Fehler zurückgegeben werden, finden Sie unter Fehlerantworten.

Beispiel

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

PATCH https://graph.microsoft.com/beta/subscriptions/{id}
Content-type: application/json

{
   "expirationDateTime":"2016-11-22T18:23:45.9356913Z"
}

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": "24d3b144-21ae-4080-943f-7067b395b913",
  "changeType":"created,updated",
  "clientState":"secretClientValue",
  "notificationUrl":"https://webhook.azurewebsites.net/api/send/myNotifyClient",
  "lifecycleNotificationUrl":"https://webhook.azurewebsites.net/api/send/lifecycleNotifications",
  "expirationDateTime":"2016-11-22T18:23:45.9356913Z",
  "creatorId": "8ee44408-0679-472c-bc2a-692812af3437",
  "latestSupportedTlsVersion": "v1_2",
  "encryptionCertificate": "",
  "encryptionCertificateId": "",
  "includeResourceData": false,
  "notificationContentType": "application/json"
}