Microsoft OneDrive events
This article provides the properties and schema for Microsoft OneDrive events, which are published by Microsoft Graph API. For an introduction to event schemas, see CloudEvents schema.
These events are triggered when a driveItem is updated by operating over those resources using Microsoft Graph API.
Event name | Description |
---|---|
Microsoft.Graph.DriveItemUpdated | This event is triggered when content 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 is updated. |
When an event is triggered, the Event Grid service sends data about that event to subscribing destinations. This section contains an example of what that data would look like for each Microsoft OneDrive event.
{
"id": "00d8a100-2e92-4bfa-86e1-0056dacd0fce",
"type": "Microsoft.Graph.DriveItemUpdated",
"source": "/tenants/<tenant-id>/applications/<application-id>",
"subject": "driveItem/<driveItem-id>",
"time": "2022-05-24T22:24:31.3062901Z",
"datacontenttype": "application/json",
"specversion": "1.0",
"data": {
"subscriptionId": "<microsoft-graph-subscription-id>",
"tenantId": "<tenant-id>",
"clientState": "<user-provided secret>",
"expirationDateTime": "2023-10-05T18:11:08.587Z",
"resource": "<guid>",
"siteUrl": "<sharepoint relative URL>",
"webId": "<guid>",
"resourceData": {
"@odata.type": "#Microsoft.Graph.driveItem"
},
}
}
An event has the following top-level data:
Property | Type | Description |
---|---|---|
source |
string | The tenant event source. This field isn't writeable. Microsoft Graph API provides this value. |
subject |
string | Publisher-defined path to the event subject. |
type |
string | One of the event types for this event source. |
time |
string | The time the event is generated based on the provider's UTC time |
id |
string | Unique identifier for the event. |
data |
object | Event payload that provides the data about the resource state change. |
specversion |
string | CloudEvents schema specification version. |
The data object has the following properties:
Property | Type | Description |
---|---|---|
changeType |
string | The type of resource state change. |
resource |
string | The resource identifier for which the event was raised. |
tenantId |
string | The organization ID where the driveItem is kept. |
clientState |
string | A secret provided by the user at the time of the Graph API subscription creation. |
@odata.type |
string | The Graph API change type. |
@odata.id |
string | The Graph API resource identifier for which the event was raised. |
id |
string | The resource identifier for which the event was raised. |
subscriptionExpirationDateTime |
string | The time in RFC 3339 format at which the Graph API subscription expires. |
subscriptionId |
string | The Graph API subscription identifier. |
tenantId |
string | The Microsoft Entra tenant identifier. |
- For an introduction to Azure Event Grid's Partner Events, see Partner Events overview
- For information on how to subscribe to Microsoft Graph API to receive events, see subscribe to Microsoft Graph API events.
- For information about Azure Event Grid event handlers, see event handlers.
- For more information about creating an Azure Event Grid subscription, see create event subscription and Event Grid subscription schema.
- For information about how to configure an event subscription to select specific events to be delivered, see event filtering. You might also want to refer to filter events.