BackupRestore-Restore.ReadWrite.All

Allows the app to search the backup snapshots for Microsoft 365 resources, and restore Microsoft 365 resources from a backed-up snapshot, 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.ReadWrite.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	bebd0841-a3d8-4313-a51d-731112c8ee41	9f89e109-94b9-4c9b-b4fc-98cdaa54f574
DisplayText	Read restore all sessions and start restore sessions from backups	Read restore sessions and start restore sessions from backups
Description	Allows the app to search all backup snapshots for Microsoft 365 resources, and restore Microsoft 365 resources from a backed-up snapshot, without a signed-in user.	Allows the app to search the backup snapshots for Microsoft 365 resources, and restore Microsoft 365 resources from a backed-up snapshot, 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
	DELETE /solutions/backupRestore/restoreSessions/{restoreSessionBaseId}
	GET /solutions/backupRestore/restorePoints?$expand=protectionUnit($filter=id eq '{ProtectionUnitID}')&$filter=protectionDateTime lt YYYY-MM-DDTHH:mm:ssZ
	PATCH /solutions/backupRestore/exchangeRestoreSessions/{exchangeRestoreSessionId}
	PATCH /solutions/backupRestore/oneDriveForBusinessRestoreSessions/{oneDriveForBusinessRestoreSessionId}
	PATCH /solutions/backupRestore/sharePointRestoreSessions/{sharePointRestoreSessionId}
	POST /solutions/backupRestore/exchangeRestoreSessions
	POST /solutions/backupRestore/oneDriveForBusinessRestoreSessions
	POST /solutions/backupRestore/restoreSessions/{restoreSessionBaseId}/activate
	POST /solutions/backupRestore/sharePointRestoreSessions

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

	Methods
	DELETE /solutions/backupRestore/exchangeRestoreSessions/{exchangeRestoreSessionId}/mailboxRestoreArtifactsBulkAdditionRequests/{mailboxRestoreArtifactsBulkAdditionRequestId}
	DELETE /solutions/backupRestore/oneDriveForBusinessRestoreSessions/{oneDriveForBusinessRestoreSessionId}/driveRestoreArtifactsBulkAdditionRequests/{driveRestoreArtifactsBulkAdditionRequestId}
	DELETE /solutions/backupRestore/restoreSessions/{restoreSessionBaseId}
	DELETE /solutions/backupRestore/sharePointRestoreSessions/{sharePointRestoreSessionId}/siteRestoreArtifactsBulkAdditionRequests/{siteRestoreArtifactsBulkAdditionRequestId}
	GET /solutions/backupRestore/restorePoints?$expand=protectionUnit($filter=id eq '{ProtectionUnitID}')&$filter=protectionDateTime lt YYYY-MM-DDTHH:mm:ssZ
	PATCH /solutions/backupRestore/exchangeRestoreSessions/{exchangeRestoreSessionId}
	PATCH /solutions/backupRestore/oneDriveForBusinessRestoreSessions/{oneDriveForBusinessRestoreSessionId}
	PATCH /solutions/backupRestore/sharePointRestoreSessions/{sharePointRestoreSessionId}
	POST /solutions/backupRestore/exchangeRestoreSessions
	POST /solutions/backupRestore/exchangeRestoreSessions/{exchangeRestoreSessionId}/mailboxRestoreArtifactsBulkAdditionRequests
	POST /solutions/backupRestore/oneDriveForBusinessRestoreSessions
	POST /solutions/backupRestore/oneDriveForBusinessRestoreSessions/{oneDriveForBusinessRestoreSessionId}/driveRestoreArtifactsBulkAdditionRequests
	POST /solutions/backupRestore/restoreSessions/{restoreSessionBaseId}/activate
	POST /solutions/backupRestore/sharePointRestoreSessions
	POST /solutions/backupRestore/sharePointRestoreSessions/{sharePointRestoreSessionId}/siteRestoreArtifactsBulkAdditionRequests

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

	Commands
	Get-MgSolutionBackupRestorePoint
	Initialize-MgBackupRestoreSession
	New-MgSolutionBackupRestoreExchangeRestoreSession
	New-MgSolutionBackupRestoreOneDriveForBusinessRestoreSession
	New-MgSolutionBackupRestoreSharePointRestoreSession
	Remove-MgSolutionBackupRestoreSession
	Update-MgSolutionBackupRestoreExchangeRestoreSession
	Update-MgSolutionBackupRestoreOneDriveForBusinessRestoreSession
	Update-MgSolutionBackupRestoreSharePointRestoreSession

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

	Commands
	Get-MgBetaSolutionBackupRestorePoint
	Initialize-MgBetaBackupRestoreSession
	New-MgBetaSolutionBackupRestoreExchangeRestoreSession
	New-MgBetaSolutionBackupRestoreOneDriveForBusinessRestoreSession
	New-MgBetaSolutionBackupRestoreSharePointRestoreSession
	Remove-MgBetaSolutionBackupRestoreSession
	Update-MgBetaSolutionBackupRestoreExchangeRestoreSession
	Update-MgBetaSolutionBackupRestoreOneDriveForBusinessRestoreSession
	Update-MgBetaSolutionBackupRestoreSharePointRestoreSession

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: driveRestoreArtifactsBulkAdditionRequest

Property	Type	Description
createdBy	identitySet	The identity of the person who created the bulk request. Inherited from restoreArtifactsBulkRequestBase.
createdDateTime	DateTimeOffset	The time when the bulk request was created. Inherited from restoreArtifactsBulkRequestBase.
destinationType	destinationType	Indicates the restoration destination. The possible values are: `new`, `inPlace`, `unknownFutureValue`. Inherited from restoreArtifactsBulkRequestBase.
directoryObjectIds	String collection	The list of directory object IDs that are added to the corresponding OneDrive for work or school restore session in a bulk operation. This property isn't implemented yet. Future value; don't use.
displayName	String	Name of the addition request. Inherited from restoreArtifactsBulkRequestBase.
drives	String collection	The list of email addresses that are added to the corresponding OneDrive for work or school restore session in a bulk operation.
error	publicError	Error details are populated for resource resolution failures. Inherited from restoreArtifactsBulkRequestBase.
id	String	The unique identifier of the bulk request associated with the restore session. Inherited from restoreArtifactsBulkRequestBase.
lastModifiedBy	identitySet	Identity of the person who last modified this entity. Inherited from restoreArtifactsBulkRequestBase.
lastModifiedDateTime	DateTimeOffset	Timestamp when this entity was last modified. Inherited from restoreArtifactsBulkRequestBase.
protectionTimePeriod	timePeriod	The start and end date time of the protection period. Inherited from restoreArtifactsBulkRequestBase.
protectionUnitIds	String collection	Indicates which protection units to restore. This property isn't implemented yet. Future value; don't use. Inherited from restoreArtifactsBulkRequestBase.
restorePointPreference	restorePointPreference	Indicates which restore point to return. The possible values are: `oldest`, `latest`, `unknownFutureValue`. Inherited from restoreArtifactsBulkRequestBase.
status	restoreArtifactsBulkRequestStatus	The status of the long-running operation. The possible values are: `unknown`, `active`, `completed`, `completedWithErrors`, `unknownFutureValue`. Inherited from restoreArtifactsBulkRequestBase.
tags	restorePointTags	The type of the restore point. The possible values are: `none`, `fastRestore`, `unknownFutureValue`. Inherited from restoreArtifactsBulkRequestBase.

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`. Use the `Prefer: include-unknown-enum-members` request header to get the following value in this evolvable enum: `failed`.

Graph reference: granularMailboxRestoreArtifact

Property	Type	Description
artifactCount	int	.
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.
searchResponseId	String	.
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: 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: mailboxRestoreArtifactsBulkAdditionRequest

Property	Type	Description
createdBy	identitySet	The identity of the person who created the bulk request. Inherited from restoreArtifactsBulkRequestBase.
createdDateTime	DateTimeOffset	The time when the bulk request was created. Inherited from restoreArtifactsBulkRequestBase.
destinationType	destinationType	Indicates the restoration destination. The possible values are: `new`, `inPlace`, `unknownFutureValue`. Inherited from restoreArtifactsBulkRequestBase.
directoryObjectIds	String collection	The list of directory object IDs that are added to the corresponding Exchange restore session in a bulk operation. This property isn't implemented yet. Future value; don't use.
displayName	String	Name of the addition request. Inherited from restoreArtifactsBulkRequestBase.
error	publicError	Error details are populated for resource resolution failures. Inherited from restoreArtifactsBulkRequestBase.
id	String	The unique identifier of the bulk request associated with the restore session. Inherited from restoreArtifactsBulkRequestBase.
lastModifiedBy	identitySet	Identity of the person who last modified this entity. Inherited from restoreArtifactsBulkRequestBase.
lastModifiedDateTime	DateTimeOffset	Timestamp when this entity was last modified. Inherited from restoreArtifactsBulkRequestBase.
mailboxes	String collection	The list of email addresses that are added to the corresponding Exchange restore session in a bulk operation.
protectionTimePeriod	timePeriod	The start and end date time of the protection period. Inherited from restoreArtifactsBulkRequestBase.
protectionUnitIds	String collection	Indicates which protection units to restore. This property isn't implemented yet. Future value; don't use. Inherited from restoreArtifactsBulkRequestBase.
restorePointPreference	restorePointPreference	Indicates which restore point to return. The possible values are: `oldest`, `latest`, `unknownFutureValue`. Inherited from restoreArtifactsBulkRequestBase.
status	restoreArtifactsBulkRequestStatus	The status of the long-running operation. The possible values are: `unknown`, `active`, `completed`, `completedWithErrors`, `unknownFutureValue`. Inherited from restoreArtifactsBulkRequestBase.
tags	restorePointTags	The type of the restore point. The possible values are: `none`, `fastRestore`, `unknownFutureValue`. Inherited from restoreArtifactsBulkRequestBase.

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`. Use the `Prefer: include-unknown-enum-members` request header to get the following value in this evolvable enum: `failed`.

Graph reference: protectionUnitBase

Property	Type	Description
id	String	The unique identifier of the protection unit.
policyId	String	The unique identifier of the protection policy based on which protection unit was created.
createdBy	identitySet	The identity of person who created the protection unit.
createdDateTime	DateTimeOffset	The time of creation of the protection unit.
error	publicError	Contains error details if an error occurred while creating a protection unit.
lastModifiedBy	identitySet	The identity of person who last modified the protection unit.
lastModifiedDateTime	DateTimeOffset	Timestamp of the last modification of this protection unit.
status	protectionUnitStatus	The status of the protection unit. The possible values are: `protectRequested`, `protected`, `unprotectRequested`, `unprotected`, `removeRequested`, `unknownFutureValue`.

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

Graph reference: siteRestoreArtifactsBulkAdditionRequest

Property	Type	Description
createdBy	identitySet	The identity of the person who created the bulk request. Inherited from restoreArtifactsBulkRequestBase.
createdDateTime	DateTimeOffset	The time when the bulk request was created. Inherited from restoreArtifactsBulkRequestBase.
destinationType	destinationType	Indicates the restoration destination. The possible values are: `new`, `inPlace`, `unknownFutureValue`. Inherited from restoreArtifactsBulkRequestBase.
displayName	String	Name of the addition request. Inherited from restoreArtifactsBulkRequestBase.
error	publicError	Error details are populated for resource resolution failures. Inherited from restoreArtifactsBulkRequestBase.
id	String	The unique identifier of the bulk request associated with the restore session. Inherited from restoreArtifactsBulkRequestBase.
lastModifiedBy	identitySet	Identity of the person who last modified this entity. Inherited from restoreArtifactsBulkRequestBase.
lastModifiedDateTime	DateTimeOffset	Timestamp when this entity was last modified. Inherited from restoreArtifactsBulkRequestBase.
protectionTimePeriod	timePeriod	The start and end date time of the protection period. Inherited from restoreArtifactsBulkRequestBase.
protectionUnitIds	String collection	Indicates which protection units to restore. This property isn't implemented yet. Future value; don't use. Inherited from restoreArtifactsBulkRequestBase.
restorePointPreference	restoreArtifactsBulkRequestStatus	Indicates which restore point to return. The possible values are `oldest`, `latest`, `unknownFutureValue`. Inherited from restoreArtifactsBulkRequestBase.
siteIds	String collection	The list of SharePoint site IDs that are added to the corresponding SharePoint restore session in a bulk operation. This property isn't implemented yet. Future value; don't use.
siteWebUrls	String collection	The list of SharePoint site URLs that are added to the corresponding SharePoint restore session in a bulk operation.
status	RestoreArtifactsBulkRequestStatus	The status of the long-running operation. The possible values are: `unknown`, `active`, `completed`, `completedWithErrors`, `unknownFutureValue`. Inherited from restoreArtifactsBulkRequestBase.
tags	restorePointTags	The type of the restore point. The possible values are: `none`, `fastRestore`, `unknownFutureValue`. Inherited from restoreArtifactsBulkRequestBase.

Table of Contents

BackupRestore-Restore.ReadWrite.All

Graph Methods

Resources