exchangeRestoreSession resource type

Article
05/31/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 restore-related tasks on artifacts that are protected by an Exchange protection policy. Restore session APIs are used by Exchange Online Admins to perform restore-related tasks on artifacts that are protected as part of a mailbox protection policy.

Inherits from restoreSessionBase.

Methods

Method	Return type	Description
Create	exchangeRestoreSession	Create a new exchangeRestoreSession.
List	exchangeRestoreSession collection	Get a list of the exchangeRestoreSession objects and their properties.
Update	exchangeRestoreSession	Update the properties of an exchangeRestoreSession.

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 last modification of this 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`. 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
mailboxRestoreArtifacts	mailboxRestoreArtifact collection	A collection of restore points and destination details that can be used to restore Exchange mailboxes.

JSON representation

The following JSON representation shows the resource type.

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