Merge pull request #26247 from microsoftgraph/users/vidula-verma/UpdatingBulkRestoreDoc

FaithOmbongi · web-flow · commit 6164cc52d86e · 2025-02-24T13:33:18.000+03:00
Udating documentation of bulk Restore with
diff --git a/api-reference/beta/api/driverestoreartifactsbulkadditionrequest-delete.md b/api-reference/beta/api/driverestoreartifactsbulkadditionrequest-delete.md
@@ -53,6 +53,8 @@ Don't supply a request body for this method.
 
 If successful, this method returns a `204 No Content` response code.
 
+For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes).
+
 ## Examples
 
 ### Request
diff --git a/api-reference/beta/api/driverestoreartifactsbulkadditionrequest-get.md b/api-reference/beta/api/driverestoreartifactsbulkadditionrequest-get.md
@@ -57,6 +57,8 @@ Don't supply a request body for this method.
 
 If successful, this method returns a `200 OK` response code and a [driveRestoreArtifactsBulkAdditionRequest](../resources/driverestoreartifactsbulkadditionrequest.md) object in the response body.
 
+For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes).
+
 ## Examples
 
 ### Request
diff --git a/api-reference/beta/api/exchangerestoresession-post-mailboxrestoreartifactsbulkadditionrequests.md b/api-reference/beta/api/exchangerestoresession-post-mailboxrestoreartifactsbulkadditionrequests.md
@@ -16,7 +16,13 @@ Namespace: microsoft.graph
 
 Create a new [mailboxRestoreArtifactsBulkAdditionRequest](../resources/mailboxrestoreartifactsbulkadditionrequest.md) object associated with an [exchangeRestoreSession](../resources/exchangerestoresession.md).
 
-The initial status upon creation of the restore session is `active`. When all the mailboxes are added to the corresponding Exchange restore session and the restore session is activated, the status becomes `completed`. If any failures are encountered during resource resolution, the status of the restore session becomes `completedWithErrors`.
+The following steps describe how to create and manage an **exchangeRestoreSession** with bulk artifact additions:
+
+1. Create a new [exchangeRestoreSession](../resources/exchangerestoresession.md) with empty payload.
+1. Create a new [mailboxRestoreArtifactsBulkAdditionRequest](../resources/mailboxrestoreartifactsbulkadditionrequest.md) object associated with an [exchangeRestoreSession](../resources/exchangerestoresession.md).
+1. Get the status of the [mailboxRestoreArtifactsBulkAdditionRequest](../resources/mailboxrestoreartifactsbulkadditionrequest.md) for the Exchange restore session. The initial status upon creation is `active` and remains in this state until the [exchangeRestoreSession](../resources/exchangerestoresession.md) is activated.
+1. Activate the [exchangeRestoreSession](../resources/exchangerestoresession.md) created in the first step.
+1. Monitor the status of the [mailboxRestoreArtifactsBulkAdditionRequest](../resources/mailboxrestoreartifactsbulkadditionrequest.md). When all the emails are added to the corresponding [exchangeRestoreSession](../resources/exchangerestoresession.md), the status of the [mailboxRestoreArtifactsBulkAdditionRequest](../resources/mailboxrestoreartifactsbulkadditionrequest.md) changes to `completed`. If any failures occur during resource resolution, the status changes to `completedWithErrors`.
 
 [!INCLUDE [national-cloud-support](../../includes/global-only.md)]
 
@@ -52,10 +58,19 @@ POST /solutions/backupRestore/exchangeRestoreSessions/{exchangeRestoreSessionId}
 
 In the request body, supply a JSON representation of the [mailboxRestoreArtifactsBulkAdditionRequest](../resources/mailboxrestoreartifactsbulkadditionrequest.md) object.
 
+You can specify the following properties when you create a **mailboxRestoreArtifactsBulkAdditionRequest** object.
+
+|Property|Type|Description|
+|:---|:---|:---|
+|directoryObjectIds|String collection|The list of directory object IDs. Optional.|
+|mailboxes|String collection|The list of email addresses. Optional.|
+
 ## Response
 
 If successful, this method returns a `201 Created` response code and a [mailboxRestoreArtifactsBulkAdditionRequest](../resources/mailboxrestoreartifactsbulkadditionrequest.md) object in the response body.
 
+For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes).
+
 ## Examples
 
 ### Request
diff --git a/api-reference/beta/api/mailboxrestoreartifactsbulkadditionrequest-delete.md b/api-reference/beta/api/mailboxrestoreartifactsbulkadditionrequest-delete.md
@@ -53,6 +53,8 @@ Don't supply a request body for this method.
 
 If successful, this method returns a `204 No Content` response code.
 
+For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes).
+
 ## Examples
 
 ### Request
diff --git a/api-reference/beta/api/mailboxrestoreartifactsbulkadditionrequest-get.md b/api-reference/beta/api/mailboxrestoreartifactsbulkadditionrequest-get.md
@@ -57,6 +57,8 @@ Don't supply a request body for this method.
 
 If successful, this method returns a `200 OK` response code and a [mailboxRestoreArtifactsBulkAdditionRequest](../resources/mailboxrestoreartifactsbulkadditionrequest.md) object in the response body.
 
+For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes).
+
 ## Examples
 
 ### Request
diff --git a/api-reference/beta/api/onedriveforbusinessrestoresession-post-driverestoreartifactsbulkadditionrequests.md b/api-reference/beta/api/onedriveforbusinessrestoresession-post-driverestoreartifactsbulkadditionrequests.md
@@ -16,7 +16,13 @@ Namespace: microsoft.graph
 
 Create a [driveRestoreArtifactsBulkAdditionRequest](../resources/driverestoreartifactsbulkadditionrequest.md) object associated with a [oneDriveForBusinessRestoreSession](../resources/onedriveforbusinessrestoresession.md).
 
-The initial status upon creation of the restore session is `active`. When all the drives are added to the corresponding OneDrive restore session and the restore session is activated, the status becomes `completed`. If any failures are encountered during resource resolution, the status of the restore session becomes `completedWithErrors`.
+The following steps describe how to create and manage a **oneDriveForBusinessRestoreSession** with bulk artifact additions.
+
+1. Create a new [oneDriveForBusinessRestoreSession](../resources/onedriveforbusinessrestoresession.md) with empty payload.
+1. Create a new [driveRestoreArtifactsBulkAdditionRequest](../resources/driverestoreartifactsbulkadditionrequest.md) object associated with a [oneDriveForBusinessRestoreSession](../resources/onedriveforbusinessrestoresession.md).
+1. Get the status of the [driveRestoreArtifactsBulkAdditionRequest](../resources/driverestoreartifactsbulkadditionrequest.md) for the OneDrive for work or school restore session. The initial status upon creation is `active` and remains in this state until the [oneDriveForBusinessRestoreSession](../resources/onedriveforbusinessrestoresession.md) is activated.
+1. Activate the [oneDriveForBusinessRestoreSession](../resources/onedriveforbusinessrestoresession.md) created in the first step.
+1. Monitor the status of the [driveRestoreArtifactsBulkAdditionRequest](../resources/driverestoreartifactsbulkadditionrequest.md). When all the drives are added to the corresponding [oneDriveForBusinessRestoreSession](../resources/onedriveforbusinessrestoresession.md), the status of the [driveRestoreArtifactsBulkAdditionRequest](../resources/driverestoreartifactsbulkadditionrequest.md) changes to `completed`. If any failures occur during resource resolution, the status changes to `completedWithErrors`.
 
 [!INCLUDE [national-cloud-support](../../includes/global-only.md)]
 
@@ -52,10 +58,19 @@ POST /solutions/backupRestore/oneDriveForBusinessRestoreSessions/{oneDriveForBus
 
 In the request body, supply a JSON representation of the [driveRestoreArtifactsBulkAdditionRequest](../resources/driverestoreartifactsbulkadditionrequest.md) object.
 
+You can specify the following properties when you create a **driveRestoreArtifactsBulkAdditionRequest** object.
+
+|Property|Type|Description|
+|:---|:---|:---|
+|directoryObjectIds|String collection|The list of directory object IDs. Optional.|
+|drives|String collection|The list of OneDrive for work or school email addresses. Optional.|
+
 ## Response
 
 If successful, this method returns a `201 Created` response code and a [driveRestoreArtifactsBulkAdditionRequest](../resources/driverestoreartifactsbulkadditionrequest.md) object in the response body.
 
+For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes).
+
 ## Examples
 
 ### Request
diff --git a/api-reference/beta/api/sharepointrestoresession-post-siterestoreartifactsbulkadditionrequests.md b/api-reference/beta/api/sharepointrestoresession-post-siterestoreartifactsbulkadditionrequests.md
@@ -16,7 +16,13 @@ Namespace: microsoft.graph
 
 Create a new [siteRestoreArtifactsBulkAdditionRequest](../resources/siterestoreartifactsbulkadditionrequest.md) object associated with a [sharePointRestoreSession](../resources/sharepointrestoresession.md).
 
-The initial status upon creation of the restore session is `active`. When all the sites are added to the corresponding SharePoint restore session and the restore session is activated, the status becomes `completed`. If any failures are encountered during resource resolution, the status of the restore session becomes `completedWithErrors`.
+The following steps describe how to create and manage a **sharePointRestoreSession** with bulk artifact additions:
+
+1. Create a new [sharePointRestoreSession](../resources/sharepointrestoresession.md) with empty payload.
+1. Create a new [siteRestoreArtifactsBulkAdditionRequest](../resources/siterestoreartifactsbulkadditionrequest.md) object associated with a [sharePointRestoreSession](../resources/sharepointrestoresession.md).
+1. Get the status of the [siteRestoreArtifactsBulkAdditionRequest](../resources/siterestoreartifactsbulkadditionrequest.md) for the SharePoint restore session. The initial status upon creation is `active` and remains in this state until the [sharePointRestoreSession](../resources/sharepointrestoresession.md) is activated.
+1. Activate the [sharePointRestoreSession](../resources/sharepointrestoresession.md) created in the first step.
+1. Monitor the status of the [siteRestoreArtifactsBulkAdditionRequest](../resources/siterestoreartifactsbulkadditionrequest.md). When all the sites are added to the corresponding [sharePointRestoreSession](../resources/sharepointrestoresession.md), the status of the [siteRestoreArtifactsBulkAdditionRequest](../resources/siterestoreartifactsbulkadditionrequest.md) changes to `completed`. If any failures occur during resource resolution, the status changes to `completedWithErrors`.
 
 [!INCLUDE [national-cloud-support](../../includes/global-only.md)]
 
@@ -52,10 +58,19 @@ POST /solutions/backupRestore/sharePointRestoreSessions/{sharePointRestoreSessio
 
 In the request body, supply a JSON representation of the [siteRestoreArtifactsBulkAdditionRequest](../resources/siterestoreartifactsbulkadditionrequest.md) object.
 
+You can specify the following properties when you create a **siteRestoreArtifactsBulkAdditionRequest** object.
+
+|Property|Type|Description|
+|:---|:---|:---|
+|siteIds|String collection|The list of SharePoint site IDs. Optional.|
+|siteWebUrls|String collection|The list of SharePoint site URLs. Optional.|
+
 ## Response
 
 If successful, this method returns a `201 Created` response code and a [siteRestoreArtifactsBulkAdditionRequest](../resources/siterestoreartifactsbulkadditionrequest.md) object in the response body.
 
+For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes).
+
 ## Examples
 
 ### Request
diff --git a/api-reference/beta/api/siterestoreartifactsbulkadditionrequest-delete.md b/api-reference/beta/api/siterestoreartifactsbulkadditionrequest-delete.md
@@ -53,6 +53,8 @@ Don't supply a request body for this method.
 
 If successful, this method returns a `204 No Content` response code.
 
+For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes).
+
 ## Examples
 
 ### Request
diff --git a/api-reference/beta/api/siterestoreartifactsbulkadditionrequest-get.md b/api-reference/beta/api/siterestoreartifactsbulkadditionrequest-get.md
@@ -57,6 +57,8 @@ Don't supply a request body for this method.
 
 If successful, this method returns a `200 OK` response code and a [siteRestoreArtifactsBulkAdditionRequest](../resources/siterestoreartifactsbulkadditionrequest.md) object in the response body.
 
+For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes).
+
 ## Examples
 
 ### Request
@@ -148,7 +150,7 @@ Content-Type: application/json
       },
       "error": {
         "code": "BulkRestoreArtifactsNotFound",
-        "message": "Errors while resolving restore artifacts",
+        "message": "Bulk Restore Artifacts not found",
         "details": [
           {
             "code": "SiteUrlNotFound",
diff --git a/api-reference/beta/resources/restoreartifactsbulkrequestbase.md b/api-reference/beta/resources/restoreartifactsbulkrequestbase.md
@@ -19,6 +19,13 @@ An abstract type that represents a bulk request associated with one of the resto
 
 Base type for [siteRestoreArtifactsBulkAdditionRequests](../resources/siterestoreartifactsbulkadditionrequest.md), [mailboxRestoreArtifactsBulkAdditionRequests](../resources/mailboxrestoreartifactsbulkadditionrequest.md), and [driveRestoreArtifactsBulkAdditionRequests](../resources/driverestoreartifactsbulkadditionrequest.md).
 
+The following points apply to bulk addition requests for restoring artifacts:
+
+- Currently, only one bulk addition job can be processed per restore session.
+- The limit for the number of sites or users in a bulk request is 10,000.
+- Patch operations aren't supported for bulk restore sessions.
+- In a single restore session, you can't add restore artifacts using both manual and bulk addition methods simultaneously.
+
 Inherits from [entity](../resources/entity.md).
 
 ## Properties
diff --git a/concepts/backup-storage-error-codes.md b/concepts/backup-storage-error-codes.md
@@ -361,3 +361,49 @@ The following table lists the possible error and response codes that can be retu
 |403|UnableToReadBillingProfile|Unable to read billing profile from billing profile provider.|Unable to read billing profile from billing profile provider.|
 |402|InvalidBillingProfile|Invalid billing profile received from the provider.|Invalid billing profile received from the provider.|
 |400|InvalidAppOwnerTenantId|Owning tenant id not found|Invalid App owner tenant id received from the user.|
+
+## Create bulk addition requests for restoring artifacts API errors
+
+The error codes in this section apply to the following APIs:
+
+- [Create driveRestoreArtifactsBulkAdditionRequests](/api-reference/beta/api/onedriveforbusinessrestoresession-post-driverestoreartifactsbulkadditionrequests.md)
+- [Create mailboxRestoreArtifactsBulkAdditionRequests](/api-reference/beta/api/exchangerestoresession-post-mailboxrestoreartifactsbulkadditionrequests.md)
+- [Create siteRestoreArtifactsBulkAdditionRequests](/api-reference/beta/api/sharepointrestoresession-post-siterestoreartifactsbulkadditionrequests.md)
+
+The following table lists the possible error and response codes that can be returned.
+
+| HTTP status code| Error code| Error message | Description|
+|:------------------|:--------------|:--------------|:--------------|
+|400|InvalidBulkRestoreArtifactId|Bulk restore request ID is invalid.|Invalid GUID provided in URI.|
+|400|BulkRestoreInvalidCreateRequest|BulkRestoreCreateRequest is null.|The create request is null or invalid.|
+|400|BulkRestoreRestorationResourcesCountExceedsLimit|Bulk restore input limit exceeded.|Input size is too large.|
+|400|BulkRestoreInvalidCreateRequestSiteUrl|Bulk restore site web URL is invalid.|Site URL is null, empty, or in an incorrect format.|
+|400|BulkRestoreInvalidCreateRequestUserEmail|Bulk restore user email is invalid.|Email is null, empty, or in an incorrect format.|
+
+## Get bulk addition requests for restoring artifacts API errors
+
+The error code in this section applies to the following APIs:
+
+- [Get driveRestoreArtifactsBulkAdditionRequests](/api-reference/beta/api/driverestoreartifactsbulkadditionrequest-get.md)
+- [Get mailboxRestoreArtifactsBulkAdditionRequests](/api-reference/beta/api/mailboxrestoreartifactsbulkadditionrequest-get.md)
+- [Get siteRestoreArtifactsBulkAdditionRequests](/api-reference/beta/api/siterestoreartifactsbulkadditionrequest-get.md)
+
+The following table lists the possible error and response code that can be returned.
+
+| HTTP status code| Error code| Error message | Description|
+|:------------------|:--------------|:--------------|:--------------|
+|404|BulkRestoreArtifactsNotFound|No bulkRestoreArtifact item with the given bulkRestoreArtifactId.|No restoreArtifactBulkAdditionRequest associated with the provided bulkRestoreArtifactId in the URI.|
+
+## Delete bulk addition requests for restoring artifacts API errors
+
+The error code in this section applies to the following APIs:
+
+- [Delete driveRestoreArtifactsBulkAdditionRequests](/api-reference/beta/api/driverestoreartifactsbulkadditionrequest-delete.md)
+- [Delete mailboxRestoreArtifactsBulkAdditionRequests](/api-reference/beta/api/mailboxrestoreartifactsbulkadditionrequest-delete.md)
+- [Delete siteRestoreArtifactsBulkAdditionRequests](/api-reference/beta/api/siterestoreartifactsbulkadditionrequest-delete.md)
+
+The following table lists the possible error and response code that can be returned.
+
+| HTTP status code| Error code| Error message | Description|
+|:------------------|:--------------|:--------------|:--------------|
+|403|InvalidStateForBulkRequestDeletion|Validation fails when the service type of the restore session and create request are different.|A bulk request can only be deleted when its status is `completed` or `completedWithErrors`.|
diff --git a/concepts/whats-new-overview.md b/concepts/whats-new-overview.md
@@ -39,6 +39,9 @@ Added [teamsMessageEvidence](/graph/api/resources/security-teamsmessageevidence)
 - Use the **protectionSources** property on [driveProtectionUnit](/graph/api/resources/driveprotectionunit?view=graph-rest-beta&preserve-view=true), [mailboxProtectionUnit](/graph/api/resources/mailboxprotectionunit?view=graph-rest-beta&preserve-view=true), and [siteProtectionUnit](/graph/api/resources/siteprotectionunit?view=graph-rest-beta&preserve-view=true) to get the sources by which a protection unit is currently protected.
 - [Update](/graph/api/protectionrulebase-update?view=graph-rest-beta&preserve-view=true) a [driveProtectionRule](/graph/api/resources/driveprotectionrule?view=graph-rest-beta&preserve-view=true) or a [mailboxProtectionRule](/graph/api/resources/mailboxprotectionrule?view=graph-rest-beta&preserve-view=true).
 - [Delete and unprotect](/graph/api/protectionrulebase-deleteandunprotect?view=graph-rest-beta&preserve-view=true) all the artifacts protected by a dynamic rule in a [driveProtectionRule](/graph/api/resources/driveprotectionrule?view=graph-rest-beta&preserve-view=true) or a [mailboxProtectionRule](/graph/api/resources/mailboxprotectionrule?view=graph-rest-beta&preserve-view=true).
+- Enabled the **directoryObjectIds** and **drives** properties as supported properties when you use the [Create driveRestoreArtifactsBulkAdditionRequests](/graph/api/onedriveforbusinessrestoresession-post-driverestoreartifactsbulkadditionrequests) method.
+- Enabled the **directoryObjectIds** and **mailboxes** properties as supported properties when you use the [Create mailboxRestoreArtifactsBulkAdditionRequest](/graph/api/exchangerestoresession-post-mailboxrestoreartifactsbulkadditionrequests) method.
+- Enabled the **siteIds** and **siteWebUrls** properties as supported properties when you use the [Create siteRestoreArtifactsBulkAdditionRequests](/graph/api/sharepointrestoresession-post-siterestoreartifactsbulkadditionrequests) method.
 
 ### Compliance | eDiscovery
 
