Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Namespace: microsoft.graph
Represents restore-related tasks on artifacts that are protected by a OneDrive protection policy. Restore session APIs are used by SharePoint Admins to perform restore-related tasks on artifacts that are protected as part of a OneDrive protection policy.
Inherits from restoreSessionBase.
Methods
| Method | Return type | Description |
|---|---|---|
| Create | oneDriveForBusinessRestoreSession | Create a new oneDriveForBusinessRestoreSession. |
| List | oneDriveForBusinessRestoreSession collection | Get a list of the oneDriveForBusinessRestoreSession objects and their properties. |
| List granularDriveRestoreArtifacts | granularDriveRestoreArtifact collection | Get a list of the granularDriveRestoreArtifact objects and their properties. |
| Update | oneDriveForBusinessRestoreSession | Update the properties of a oneDriveForBusinessRestoreSession. |
Properties
| Property | Type | Description |
|---|---|---|
| id | String | The unique identifier of the restore session created. |
| completedDateTime | DateTimeOffset | The time of creation of the restore session. |
| createdBy | identitySet | The identity of person who created the restore session. |
| createdDateTime | DateTimeOffset | The time of completion of the restore session. |
| error | publicError | Contains error details if the restore session fails or completes with an error. |
| lastModifiedBy | identitySet | Identity of the person who last modified this restore session. |
| lastModifiedDateTime | DateTimeOffset | Timestamp of the last modification of this restore session. |
| policyId | String | The identifier of the protection policy that scopes the restore session. When supplied during creation or update, the service validates that the referenced protection units belong to the specified policy. Inherited from restoreSessionBase. |
| status | restoreSessionStatus | Status of the restore session. The value is an aggregated status of the restored artifacts. The possible values are: draft, activating, active, completedWithError, completed, unknownFutureValue, failed. You must use the Prefer: include-unknown-enum-members request header to get the following members in this evolvable enum: failed. |
| restoreJobType | restoreJobType | Indicates whether the restore session was created normally or by a bulk job. |
| restoreSessionArtifactCount | restoreSessionArtifactCount | The number of metadata artifacts that belong to this restore session. |
restoreSessionStatus values
| Member | Description |
|---|---|
| draft | All artifacts are added. |
| activating | All artifacts are scheduled. |
| active | All or any restore artifacts are scheduled or in progress. |
| completedWithError | Some artifacts failed to restore, and some succeeded. |
| completed | All restore artifacts successfully restored. |
| failed | All restore artifacts failed to restore. |
| unknownFutureValue | Evolvable enumeration sentinel value. Do not use. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| driveRestoreArtifacts | driveRestoreArtifact collection | A collection of restore points and destination details that can be used to restore a OneDrive for work or school drive. |
| driveRestoreArtifactsBulkAdditionRequests | driveRestoreArtifactsBulkAdditionRequest collection | A collection of user mailboxes and destination details that can be used to restore a OneDrive for work or school drive. |
| granularDriveRestoreArtifacts | granularDriveRestoreArtifact collection | A collection of browse session ID and item key details that can be used to restore OneDrive for work or school files and folders. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.oneDriveForBusinessRestoreSession",
"id": "String (identifier)",
"status": "String",
"restoreJobType": "String",
"restoreSessionArtifactCount": {
"@odata.type": "microsoft.graph.restoreSessionArtifactCount"
},
"createdDateTime": "String (timestamp)",
"createdBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"completedDateTime": "String (timestamp)",
"lastModifiedDateTime": "String (timestamp)",
"lastModifiedBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"error": {
"@odata.type": "microsoft.graph.publicError"
},
"policyId": "String"
}