restoreSessionBase resource type

Article
08/28/2024

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents a restore session for a protection unit that's protected by a protection policy. Restore session APIs are used by global admins, SharePoint Online admins, and Exchange Online admins to perform restore-related tasks on artifacts that are protected as part of protection policy.

Restoring to both a new location and the same URL in a single restore session is not supported.

Methods

Method	Return type	Description
List	restoreSessionBase collection	Get a list of restoreSessionBase objects and their properties.
Get	restoreSessionBase	Read the properties and relationships of a restoreSessionBase object.
Delete	None	Delete a restoreSessionBase object.
Activate	restoreSessionBase	Activate a draft restore session.

Properties

Property	Type	Description
id	String	The unique identifier of the restore session.
completedDateTime	DateTimeOffset	The time of completion of the restore session.
createdBy	identitySet	The identity of person who created the restore session.
createdDateTime	DateTimeOffset	The time of creation 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 the restore session.
lastModifiedDateTime	DateTimeOffset	Timestamp of the last modification of the restore session.
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 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. Don't use.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.restoreSessionBase",
  "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"
  }
}

Share via