Übersicht über die Benutzerkonfigurations-API in Microsoft Graph (Vorschau)

Die Benutzerkonfigurations-API in Microsoft Graph ermöglicht Es Ihrer Anwendung, Konfigurationsdaten pro Ordner zusammen mit den Inhalten eines Exchange Online Postfachs zu speichern und abzurufen. Ein userConfiguration-Objekt (folder associated item, FAI) wird einem bestimmten E-Mail-Ordner zugeordnet und durch einen Schlüssel identifiziert, der innerhalb dieses Ordners eindeutig ist. Jedes Objekt gilt für einen einzelnen Ordner und nicht für das gesamte Postfach. Dieser Bereich ermöglicht es Ihrer App, den Zustand in der Nähe des Inhalts zu halten, auf den sie sich bezieht.

Die API bietet Ihrer App die vollständige Kontrolle über das Erstellen, Lesen, Aktualisieren und Löschen von userConfiguration-Objekten und unterstützt mehrere Nutzlaststile, mit denen Sie das Format speichern können, das am besten zu Ihrem Szenario passt: beliebige Binärdaten, serialisiertes XML oder stark typisierte Schlüssel-Wert-Paare.

Gründe für die Integration in die Benutzerkonfigurations-API

Ordnerspezifischer Anwendungsstatus und -einstellungen speichern

Viele Anwendungen benötigen einen zuverlässigen Ort, um Einstellungen oder den Zustand eines bestimmten E-Mail-Ordners beizubehalten. Beispiele hierfür sind die zuletzt synchronisierte Element-ID für ein Posteingangssynchronisierungstool, anzeigen von Einstellungen für einen benutzerdefinierten Ordner oder Featureflags, die auf einen Ordner ausgerichtet sind. Die Benutzerkonfigurations-API bietet Ihrer App einen dedizierten, postfachresidenten Speicherort für diese Art von Daten, sodass Sie keinen separaten externen Speicher verwalten müssen.

Beibehalten von App-Metadaten zusammen mit Postfachinhalten

Benutzerkonfigurationsobjekte befinden sich im Postfach. Daher befinden sich die Daten in der Nähe des Inhalts, auf den sie sich beziehen, und die gleichen Zugriffssteuerungen, die die anderen Postfachinhalte des Benutzers schützen, schützen auch diese Daten. Durch dieses Speichermuster eignet sich die API gut für App-Metadaten, die an einen bestimmten Ordner gebunden bleiben sollten.

Auswählen des Nutzlastformats, das zu Ihren Daten passt

Die UserConfiguration-Ressource unterstützt drei Nutzlasteigenschaften, und Sie können die richtige Form für Ihr Szenario auswählen:

• Verwenden Sie binaryData für beliebige binäre Inhalte.
• Verwenden Sie xmlData für serialisiertes XML.
• Verwenden Sie structuredData , um typisierte Schlüssel-Wert-Paare zu speichern, ohne Ihr eigenes Format zu serialisieren. Die komplexen Typen structuredDataEntry und structuredDataEntryTypedValue modellieren die unterstützten Werttypen.

Ein einzelnes userConfiguration-Objekt kann eine beliebige Kombination dieser Eigenschaften enthalten. Sie können Nutzlaststile während der Weiterentwicklung Ihrer App kombinieren.

API-Referenz

Suchen Sie die API-Referenz für diesen Dienst? Weitere Informationen finden Sie unter dem Ressourcentyp userConfiguration und den unterstützten Methoden.

Nächste Schritte

• Untersuchen Sie den Ressourcentyp userConfiguration und die unterstützten Methoden (Create, Get, Update, Delete).
• Testen Sie die Benutzerkonfigurations-API in Graph Explorer.