BackupRestore-Restore.Read.All

Allows the app to read restore sessions, on behalf of the signed in user.

Merill's Note

For an app to access data in Microsoft Graph, the user or administrator must grant it the permissions it needs. This article lists all the Microsoft Graph APIs and your tenant data that can be accessed by the application (vendor/developer) if you consent to the BackupRestore-Restore.Read.All permission.

If you need to create an audit report of the permissions granted to all the apps in your tenant, you can run the Export-MsIdAppConsentGrantReport command. See How To: Run a quick OAuth app audit of your tenant

Category	Application	Delegated
Identifier	87853aa5-0372-4710-b34b-cef27bb7156e	94b36f78-434f-4904-8c08-421d9a9c1dc2
DisplayText	Read all restore sessions	Read restore sessions
Description	Allows the app to read all restore sessions, without a signed-in user.	Allows the app to read restore sessions, on behalf of the signed in user.
AdminConsentRequired	Yes	Yes

Graph Methods

→ API supports delegated access (access on behalf of a user)
→ API supports app-only access (access without a user)

	Methods
	GET /solutions/backupRestore/exchangeRestoreSessions/{exchangeRestoreSessionId}/mailboxRestoreArtifacts
	GET /solutions/backupRestore/oneDriveForBusinessRestoreSessions/{oneDriveForBusinessRestoreSessionId}/driveRestoreArtifacts
	GET /solutions/backupRestore/restorePoints?$expand=protectionUnit($filter=id eq '{ProtectionUnitID}')&$filter=protectionDateTime lt YYYY-MM-DDTHH:mm:ssZ
	GET /solutions/backupRestore/restoreSessions
	GET /solutions/backupRestore/restoreSessions/{restoreSessionBaseId}
	GET /solutions/backupRestore/sharePointRestoreSessions/{sharePointRestoreSessionId}/siteRestoreArtifacts

→ API supports delegated access (access on behalf of a user)
→ API supports app-only access (access without a user)

	Methods
	GET /solutions/backupRestore/exchangeRestoreSessions/{exchangeRestoreSessionId}/mailboxRestoreArtifacts
	GET /solutions/backupRestore/oneDriveForBusinessRestoreSessions/{oneDriveForBusinessRestoreSessionId}/driveRestoreArtifacts
	GET /solutions/backupRestore/restorePoints?$expand=protectionUnit($filter=id eq '{ProtectionUnitID}')&$filter=protectionDateTime lt YYYY-MM-DDTHH:mm:ssZ
	GET /solutions/backupRestore/restoreSessions
	GET /solutions/backupRestore/restoreSessions/{restoreSessionBaseId}
	GET /solutions/backupRestore/sharePointRestoreSessions/{sharePointRestoreSessionId}/siteRestoreArtifacts

→ Command supports delegated access (access on behalf of a user)
→ Command supports app-only access (access without a user)

	Commands
	Get-MgSolutionBackupRestoreExchangeRestoreSessionMailboxRestoreArtifact
	Get-MgSolutionBackupRestoreOneDriveForBusinessRestoreSessionDriveRestoreArtifact
	Get-MgSolutionBackupRestorePoint
	Get-MgSolutionBackupRestoreSession
	Get-MgSolutionBackupRestoreSharePointRestoreSessionSiteRestoreArtifact

→ Command supports delegated access (access on behalf of a user)
→ Command supports app-only access (access without a user)

	Commands
	Get-MgBetaSolutionBackupRestoreExchangeRestoreSessionMailboxRestoreArtifact
	Get-MgBetaSolutionBackupRestoreOneDriveForBusinessRestoreSessionDriveRestoreArtifact
	Get-MgBetaSolutionBackupRestorePoint
	Get-MgBetaSolutionBackupRestoreSession
	Get-MgBetaSolutionBackupRestoreSharePointRestoreSessionSiteRestoreArtifact

Resources

Granting this permission allows the calling application to access (and/or update) the following information in your tenant.

Graph reference: driveRestoreArtifact

Property	Type	Description
id	String	The unique identifier of the restore artifact.
completionDateTime	DateTimeOffset	The time when restoration of restore artifact is completed. Inherited from restoreArtifactBase.
destinationType	destinationType	The restoration destination. Inherited from restoreArtifactBase. The possible values are: `new`, `inPlace`, `unknownFutureValue`.
error	publicError	Contains error details if the restoration fails. Inherited from restoreArtifactBase.
restoredSiteId	String	The new site identifier if destinationType is `new`, and the input site ID if the destinationType is `inPlace`.
restoredSiteName	String	The name of the restored site.
restoredSiteWebUrl	String	The web URL of the restored site.
startDateTime	DateTimeOffset	The time when the restoration started. Inherited from restoreArtifactBase.
status	artifactRestoreStatus	The individual restoration status of the restore artifact. Inherited from restoreArtifactBase. The possible values are: `added`, `scheduling`, `scheduled`, `inProgress`, `succeeded`, `failed`, `unknownFutureValue`.

Graph reference: exchangeRestoreSession

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`.

Graph reference: mailboxRestoreArtifact

Property	Type	Description
id	String	The unique identifier of the restore artifact.
completionDateTime	DateTimeOffset	The time when the restoration of the artifact is completed. Inherited from restoreArtifactBase.
destinationType	destinationType	Indicates the restoration destination. Inherited from restoreArtifactBase. The possible values are: `new`, `inPlace`, `unknownFutureValue`.
error	publicError	Contains error details if the restoration of the artifact fails. Inherited from restoreArtifactBase.
restoredFolderId	String	The new restored folder identifier for the user.
restoredFolderName	String	The new restored folder name.
startDateTime	DateTimeOffset	The time when the restoration of the artifact started. Inherited from restoreArtifactBase.
status	artifactRestoreStatus	The restoration status of the artifact. Inherited from restoreArtifactBase.T he possible values are: `added`, `scheduling`, `scheduled`, `inProgress`, `succeeded`, `failed`, `unknownFutureValue`.

Graph reference: oneDriveForBusinessRestoreSession

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.
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`.

Graph reference: restorePoint

Property	Type	Description
id	String	ID of the restore point.
protectionDateTime	DateTimeOffset	Date time when the restore point was created.
expirationDateTime	DateTimeOffset	Expiration date time of the restore point.
tags	restorePointTags	The type of the restore point. The possible values are: `none`, `fastRestore`, `unknownFutureValue`.

Graph reference: restoreSessionBase

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`.

Graph reference: sharePointRestoreSession

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`.

Graph reference: siteRestoreArtifact

Property	Type	Description
id	String	The unique identifier of the restore artifact.
completionDateTime	DateTimeOffset	The time when restoration of restore artifact is completed. Inherited from restoreArtifactBase.
destinationType	destinationType	Indicates the restoration destination. Inherited from restoreArtifactBase. The possible values are: `new`, `inPlace`, `unknownFutureValue`.
error	publicError	Contains error details if the restoration of the restore artifact fails. Inherited from restoreArtifactBase.
restoredSiteId	String	The new site identifier if the value of the destinationType property is `new`, and the existing site ID if the value is `inPlace`.
restoredSiteName	String	The name of the restored site.
restoredSiteWebUrl	String	The web URL of the restored site.
startDateTime	DateTimeOffset	The time when restoration of the restore artifact started. Inherited from restoreArtifactBase.
status	artifactRestoreStatus	The restoration status of the restore artifact. Inherited from restoreArtifactBase. The possible values are: `added`, `scheduling`, `scheduled`, `inProgress`, `succeeded`, `failed`, `unknownFutureValue`.

Table of Contents

BackupRestore-Restore.Read.All

Graph Methods

Resources