BackupRestore-Restore.Read.All

Permission Details

Application Permission

Read all restore sessions

Allows the app to read all restore sessions, without a signed-in user.

Permission ID: 87853aa5-0372-4710-b34b-cef27bb7156e

Delegated Permission

Read restore sessions

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

Permission ID: 94b36f78-434f-4904-8c08-421d9a9c1dc2

Properties

Microsoft Graph v1.0 endpoint-derived-docs

Properties is shown from stable Microsoft Graph v1.0 metadata.

Property	Type	Description
`id`	`String`	The unique identifier of the restore session created.
`completedDateTime`	`DateTimeOffset`Nullable	The time of creation of the restore session.
`createdBy`	`identitySet`	The identity of person who created the restore session.
`createdDateTime`	`DateTimeOffset`Nullable	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`Nullable	Timestamp of last modification of this restore session.
`restoreJobType`	`restoreJobType`	Indicates whether the restore session was created normally or by a bulk job.
`restoreSessionArtifactCount`	`restoreSessionArtifactCount`	The number of metadata artifacts that belong to 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 members in this evolvable enum: failed.
`granularMailboxRestoreArtifacts`	`granularMailboxRestoreArtifact collection`
`mailboxRestoreArtifacts`	`mailboxRestoreArtifact collection`	A collection of restore points and destination details that can be used to restore Exchange mailboxes.
`mailboxRestoreArtifactsBulkAdditionRequests`	`mailboxRestoreArtifactsBulkAdditionRequest collection`	A collection of user mailboxes and destination details that can be used to restore Exchange mailboxes.

JSON Representation

Microsoft Graph v1.0 endpoint-derived-docs

JSON representation is shown from stable Microsoft Graph v1.0 metadata.

JSON representation

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

Relationships

Microsoft Graph v1.0 endpoint-derived-docs

Relationships is shown from stable Microsoft Graph v1.0 metadata.

Relationship	Type	Description
`mailboxRestoreArtifacts`	`mailboxRestoreArtifact collection`	A collection of restore points and destination details that can be used to restore Exchange mailboxes.
`mailboxRestoreArtifactsBulkAdditionRequests`	`mailboxRestoreArtifactsBulkAdditionRequest collection`	A collection of user mailboxes and destination details that can be used to restore Exchange mailboxes.
`granularMailboxRestoreArtifacts`	`granularMailboxRestoreArtifact collection`	Related granularMailboxRestoreArtifacts data exposed by this resource.

Graph Methods

Delegated access App-only access

Exact Microsoft Learn match

Microsoft Graph v1.0 endpoints are mapped directly from refreshed Microsoft Learn permissions tables.

Methods
GET `/solutions/backupRestore/exchangeRestoreSessions/{exchangeRestoreSessionId}/mailboxRestoreArtifacts`
GET `/solutions/backupRestore/exchangeRestoreSessions/{exchangeRestoreSessionId}/mailboxRestoreArtifactsBulkAdditionRequests`
GET `/solutions/backupRestore/exchangeRestoreSessions/{exchangeRestoreSessionId}/mailboxRestoreArtifactsBulkAdditionRequests/{mailboxRestoreArtifactsBulkAdditionRequestId}`
GET `/solutions/backupRestore/oneDriveForBusinessRestoreSessions/{oneDriveForBusinessRestoreSessionId}/driveRestoreArtifacts`
GET `/solutions/backupRestore/oneDriveForBusinessRestoreSessions/{oneDriveForBusinessRestoreSessionId}/driveRestoreArtifactsBulkAdditionRequests`
GET `/solutions/backupRestore/oneDriveForBusinessRestoreSessions/{oneDriveForBusinessRestoreSessionId}/driveRestoreArtifactsBulkAdditionRequests/{driveRestoreArtifactsBulkAdditionRequestId}`
GET `/solutions/backupRestore/restoreSessions`
GET `/solutions/backupRestore/restoreSessions/{restoreSessionBaseId}`
GET `/solutions/backupRestore/sharePointRestoreSessions/{sharePointRestoreSessionId}/siteRestoreArtifacts`
GET `/solutions/backupRestore/sharePointRestoreSessions/{sharePointRestoreSessionId}/siteRestoreArtifactsBulkAdditionRequests`
GET `/solutions/backupRestore/sharePointRestoreSessions/{sharePointRestoreSessionId}/siteRestoreArtifactsBulkAdditionRequests/{siteRestoreArtifactsBulkAdditionRequestId}`

Exact Microsoft Learn match

Microsoft Graph beta endpoints are mapped directly from refreshed Microsoft Learn permissions tables.

Methods
GET `/solutions/backupRestore/exchangeRestoreSessions/{exchangeRestoreSessionId}/mailboxRestoreArtifacts`
GET `/solutions/backupRestore/exchangeRestoreSessions/{exchangeRestoreSessionId}/mailboxRestoreArtifactsBulkAdditionRequests`
GET `/solutions/backupRestore/exchangeRestoreSessions/{exchangeRestoreSessionId}/mailboxRestoreArtifactsBulkAdditionRequests/{mailboxRestoreArtifactsBulkAdditionRequestId}`
GET `/solutions/backupRestore/oneDriveForBusinessRestoreSessions/{oneDriveForBusinessRestoreSessionId}/driveRestoreArtifacts`
GET `/solutions/backupRestore/oneDriveForBusinessRestoreSessions/{oneDriveForBusinessRestoreSessionId}/driveRestoreArtifactsBulkAdditionRequests`
GET `/solutions/backupRestore/oneDriveForBusinessRestoreSessions/{oneDriveForBusinessRestoreSessionId}/driveRestoreArtifactsBulkAdditionRequests/{driveRestoreArtifactsBulkAdditionRequestId}`
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`
GET `/solutions/backupRestore/sharePointRestoreSessions/{sharePointRestoreSessionId}/siteRestoreArtifactsBulkAdditionRequests`
GET `/solutions/backupRestore/sharePointRestoreSessions/{sharePointRestoreSessionId}/siteRestoreArtifactsBulkAdditionRequests/{siteRestoreArtifactsBulkAdditionRequestId}`

Exact Microsoft Learn PowerShell match

Microsoft Graph PowerShell v1.0 commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.

Commands
`Get-MgSolutionBackupRestoreExchangeRestoreSessionMailboxRestoreArtifact` /solutions/backupRestore/exchangeRestoreSessions/{exchangeRestoreSessionId}/mailboxRestoreArtifacts List mailboxRestoreArtifacts
`Get-MgSolutionBackupRestoreExchangeRestoreSessionMailboxRestoreArtifactBulkAdditionRequest` /solutions/backupRestore/exchangeRestoreSessions/{exchangeRestoreSessionId}/mailboxRestoreArtifactsBulkAdditionRequests List mailboxRestoreArtifactsBulkAdditionRequests
`Get-MgSolutionBackupRestoreExchangeRestoreSessionMailboxRestoreArtifactBulkAdditionRequest` /solutions/backupRestore/exchangeRestoreSessions/{exchangeRestoreSessionId}/mailboxRestoreArtifactsBulkAdditionRequests/{mailboxRestoreArtifactsBulkAdditionRequestId} Get mailboxRestoreArtifactsBulkAdditionRequest
`Get-MgSolutionBackupRestoreOneDriveForBusinessRestoreSessionDriveRestoreArtifact` /solutions/backupRestore/oneDriveForBusinessRestoreSessions/{oneDriveForBusinessRestoreSessionId}/driveRestoreArtifacts List driveRestoreArtifacts
`Get-MgSolutionBackupRestoreOneDriveForBusinessRestoreSessionDriveRestoreArtifactBulkAdditionRequest` /solutions/backupRestore/oneDriveForBusinessRestoreSessions/{oneDriveForBusinessRestoreSessionId}/driveRestoreArtifactsBulkAdditionRequests List driveRestoreArtifactsBulkAdditionRequests
`Get-MgSolutionBackupRestoreOneDriveForBusinessRestoreSessionDriveRestoreArtifactBulkAdditionRequest` /solutions/backupRestore/oneDriveForBusinessRestoreSessions/{oneDriveForBusinessRestoreSessionId}/driveRestoreArtifactsBulkAdditionRequests/{driveRestoreArtifactsBulkAdditionRequestId} Get driveRestoreArtifactsBulkAdditionRequest
`Get-MgSolutionBackupRestoreSession` /solutions/backupRestore/restoreSessions List restoreSessionBase objects
`Get-MgSolutionBackupRestoreSession` /solutions/backupRestore/restoreSessions/{restoreSessionBaseId} Get restoreSessionBase
`Get-MgSolutionBackupRestoreSharePointRestoreSessionSiteRestoreArtifact` /solutions/backupRestore/sharePointRestoreSessions/{sharePointRestoreSessionId}/siteRestoreArtifacts List siteRestoreArtifacts
`Get-MgSolutionBackupRestoreSharePointRestoreSessionSiteRestoreArtifactBulkAdditionRequest` /solutions/backupRestore/sharePointRestoreSessions/{sharePointRestoreSessionId}/siteRestoreArtifactsBulkAdditionRequests List siteRestoreArtifactsBulkAdditionRequests
`Get-MgSolutionBackupRestoreSharePointRestoreSessionSiteRestoreArtifactBulkAdditionRequest` /solutions/backupRestore/sharePointRestoreSessions/{sharePointRestoreSessionId}/siteRestoreArtifactsBulkAdditionRequests/{siteRestoreArtifactsBulkAdditionRequestId} Get siteRestoreArtifactsBulkAdditionRequest

Exact Microsoft Learn PowerShell match

Microsoft Graph PowerShell beta commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.

Commands
`Get-MgBetaSolutionBackupRestoreExchangeRestoreSessionMailboxRestoreArtifact` /solutions/backupRestore/exchangeRestoreSessions/{exchangeRestoreSessionId}/mailboxRestoreArtifacts List mailboxRestoreArtifacts
`Get-MgBetaSolutionBackupRestoreExchangeRestoreSessionMailboxRestoreArtifactBulkAdditionRequest` /solutions/backupRestore/exchangeRestoreSessions/{exchangeRestoreSessionId}/mailboxRestoreArtifactsBulkAdditionRequests List mailboxRestoreArtifactsBulkAdditionRequests
`Get-MgBetaSolutionBackupRestoreExchangeRestoreSessionMailboxRestoreArtifactBulkAdditionRequest` /solutions/backupRestore/exchangeRestoreSessions/{exchangeRestoreSessionId}/mailboxRestoreArtifactsBulkAdditionRequests/{mailboxRestoreArtifactsBulkAdditionRequestId} Get mailboxRestoreArtifactsBulkAdditionRequest
`Get-MgBetaSolutionBackupRestoreOneDriveForBusinessRestoreSessionDriveRestoreArtifact` /solutions/backupRestore/oneDriveForBusinessRestoreSessions/{oneDriveForBusinessRestoreSessionId}/driveRestoreArtifacts List driveRestoreArtifacts
`Get-MgBetaSolutionBackupRestoreOneDriveForBusinessRestoreSessionDriveRestoreArtifactBulkAdditionRequest` /solutions/backupRestore/oneDriveForBusinessRestoreSessions/{oneDriveForBusinessRestoreSessionId}/driveRestoreArtifactsBulkAdditionRequests List driveRestoreArtifactsBulkAdditionRequests
`Get-MgBetaSolutionBackupRestoreOneDriveForBusinessRestoreSessionDriveRestoreArtifactBulkAdditionRequest` /solutions/backupRestore/oneDriveForBusinessRestoreSessions/{oneDriveForBusinessRestoreSessionId}/driveRestoreArtifactsBulkAdditionRequests/{driveRestoreArtifactsBulkAdditionRequestId} Get driveRestoreArtifactsBulkAdditionRequest
`Get-MgBetaSolutionBackupRestorePoint` /solutions/backupRestore/restorePoints?$expand=protectionUnit($filter=id eq '{ProtectionUnitID}')&$filter=protectionDateTime lt YYYY-MM-DDTHH:mm:ssZ List restorePoints
`Get-MgBetaSolutionBackupRestoreSession` /solutions/backupRestore/restoreSessions List restoreSessionBase objects
`Get-MgBetaSolutionBackupRestoreSession` /solutions/backupRestore/restoreSessions/{restoreSessionBaseId} Get restoreSessionBase
`Get-MgBetaSolutionBackupRestoreSharePointRestoreSessionSiteRestoreArtifact` /solutions/backupRestore/sharePointRestoreSessions/{sharePointRestoreSessionId}/siteRestoreArtifacts List siteRestoreArtifacts
`Get-MgBetaSolutionBackupRestoreSharePointRestoreSessionSiteRestoreArtifactBulkAdditionRequest` /solutions/backupRestore/sharePointRestoreSessions/{sharePointRestoreSessionId}/siteRestoreArtifactsBulkAdditionRequests List siteRestoreArtifactsBulkAdditionRequests
`Get-MgBetaSolutionBackupRestoreSharePointRestoreSessionSiteRestoreArtifactBulkAdditionRequest` /solutions/backupRestore/sharePointRestoreSessions/{sharePointRestoreSessionId}/siteRestoreArtifactsBulkAdditionRequests/{siteRestoreArtifactsBulkAdditionRequestId} Get siteRestoreArtifactsBulkAdditionRequest

Code Examples

C# / .NET SDK

Get driveRestoreArtifactsBulkAdditionRequest

View official example on Microsoft Learn

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Solutions.BackupRestore.OneDriveForBusinessRestoreSessions["{oneDriveForBusinessRestoreSession-id}"].DriveRestoreArtifactsBulkAdditionRequests["{driveRestoreArtifactsBulkAdditionRequest-id}"].GetAsync();

JavaScript

Get driveRestoreArtifactsBulkAdditionRequest

View official example on Microsoft Learn

const options = {
	authProvider,
};

const client = Client.init(options);

let driveRestoreArtifactsBulkAdditionRequest = await client.api('/solutions/backupRestore/oneDriveForBusinessRestoreSessions/493635f0-b8c0-4c7f-bcb7-b20c85d97efe/driveRestoreArtifactsBulkAdditionRequests/e79d0a79-7210-4369-9177-6297f0555242')
	.get();

PowerShell

Get driveRestoreArtifactsBulkAdditionRequest

View official example on Microsoft Learn

Import-Module Microsoft.Graph.BackupRestore

Get-MgSolutionBackupRestoreOneDriveForBusinessRestoreSessionDriveRestoreArtifactBulkAdditionRequest -OneDriveForBusinessRestoreSessionId $oneDriveForBusinessRestoreSessionId -DriveRestoreArtifactsBulkAdditionRequestId $driveRestoreArtifactsBulkAdditionRequestId

Python

Get driveRestoreArtifactsBulkAdditionRequest

View official example on Microsoft Learn

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.solutions.backup_restore.one_drive_for_business_restore_sessions.by_one_drive_for_business_restore_session_id('oneDriveForBusinessRestoreSession-id').drive_restore_artifacts_bulk_addition_requests.by_drive_restore_artifacts_bulk_addition_request_id('driveRestoreArtifactsBulkAdditionRequest-id').get()

App Registration

1

Navigate to Azure Portal

Go to App registrations in Microsoft Entra admin center

2

Add API Permission

Select your app → API permissions → Add a permission → Microsoft Graph

3

Select Permission Type

Choose Application permissions or delegated permissions and search for BackupRestore-Restore.Read.All

4

Grant Admin Consent

Application permissions always require admin consent.