Skip to content

Latest commit

 

History

History
90 lines (75 loc) · 4.37 KB

sharepointrestoresession.md

File metadata and controls

90 lines (75 loc) · 4.37 KB
Raw
title description author ms.reviewer ms.localizationpriority ms.subservice doc_type toc.title
sharePointRestoreSession resource type
Represents restore-related tasks on artifacts that are protected by an SharePoint protection policy.
tushar20
manikantsinghms
medium
m365-backup-storage
resourcePageType
SharePoint restore session

sharePointRestoreSession resource type

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Represents restore-related tasks on artifacts that are protected by a SharePoint protection policy. Restore session APIs are used by SharePoint Online Admins to perform restore-related tasks on artifacts that are protected as part of a SharePoint protection policy.

Inherits from restoreSessionBase.

Methods

Method Return type Description
Create sharePointRestoreSession Create a new sharePointRestoreSession.
List siteRestoreArtifact collection List the siteRestoreArtifact objects for a sharePointRestoreSession for the tenant.
Update sharePointRestoreSession Update the properties of a sharePointRestoreSession object.

Properties

Property Type Description
id String The unique identifier of the restore session.
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 is completed with error.
lastModifiedBy identitySet Identity of the person who last modified this restore session.
lastModifiedDateTime DateTimeOffset Timestamp of last modification of this restore session.
status restoreSessionStatus Status of the restore session. The value is an aggregated status of restore artifacts. The possible values are: draft, activating, active, completedWithError, completed, unknownFutureValue, failed. Note that you must use the Prefer: include-unknown-enum-members request header to get the following value in this evolvable enum: failed.

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
siteRestoreArtifacts siteRestoreArtifact collection A collection of restore points and destination details that can be used to restore SharePoint sites.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.sharePointRestoreSession",
  "id": "String (identifier)",
  "status": "String",
  "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"
  }
}