Merge pull request #25651 from microsoftgraph/user/satpatel/docChangesRS

Lauragra · web-flow · commit 5b0c253de7c0 · 2024-12-04T19:45:23.000-08:00
Updating RestoreSession documentation
diff --git a/api-reference/beta/api/backuprestoreroot-list-restoresessions.md b/api-reference/beta/api/backuprestoreroot-list-restoresessions.md
@@ -120,6 +120,13 @@ Content-Type: application/json
       "@odata.type": "#microsoft.graph.sharepointRestoreSession",
       "id": "959ba739-70b5-43c4-8c90-b2c22014f18b",
       "status": "active",
+      "restoreJobType": "standard",
+      "restoreSessionArtifactCount": {
+        "total": 2,
+        "completed": 1,
+        "inProgress": 1,
+        "failed": 0
+      },
       "createdBy": {
         "application": {
           "id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
@@ -148,6 +155,13 @@ Content-Type: application/json
       "@odata.type": "#microsoft.graph.exchangeRestoreSession",
       "id": "959ba739-70b5-43c4-8c90-b2c22014f18b",
       "status": "active",
+      "restoreJobType": "standard",
+      "restoreSessionArtifactCount": {
+        "total": 2,
+        "completed": 1,
+        "inProgress": 1,
+        "failed": 0
+      },
       "createdBy": {
         "application": {
           "id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
@@ -176,6 +190,13 @@ Content-Type: application/json
       "@odata.type": "#microsoft.graph.oneDriveForBusinessRestoreSession",
       "id": "959ba739-70b5-43c4-8c90-b2c22014f18b",
       "status": "active",
+      "restoreJobType": "standard",
+      "restoreSessionArtifactCount": {
+        "total": 2,
+        "completed": 1,
+        "inProgress": 1,
+        "failed": 0
+      },
       "createdBy": {
         "application": {
           "id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
@@ -204,6 +225,13 @@ Content-Type: application/json
       "@odata.type": "#microsoft.graph.sharepointRestoreSession",
       "id": "c86a1eaf-1925-46cc-8ab2-567302dd78a9",
       "status": "failed", // Newly Added
+      "restoreJobType": "standard",
+      "restoreSessionArtifactCount": {
+        "total": 2,
+        "completed": 0,
+        "inProgress": 0,
+        "failed": 2
+      },
       "createdBy": {
         "application": {
           "id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
diff --git a/api-reference/beta/api/backuprestoreroot-post-exchangerestoresessions.md b/api-reference/beta/api/backuprestoreroot-post-exchangerestoresessions.md
@@ -145,6 +145,13 @@ Content-Type: application/json
   "@odata.context": "/solutions/backupRestore/$metadata#exchangeRestoreSessions/$entity",
   "id": "959ba739-70b5-43c4-8c90-b2c22014f18b",
   "status": "draft",
+  "restoreJobType": "standard",
+  "restoreSessionArtifactCount": {
+    "total": 2,
+    "completed": 0,
+    "inProgress": 0,
+    "failed": 0
+  },
   "createdBy": {
     "application": {
       "id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
@@ -251,6 +258,13 @@ Content-Type: application/json
   "@odata.context": "/solutions/backupRestore/$metadata#exchangeRestoreSessions/$entity",
   "id": "959ba739-70b5-43c4-8c90-b2c22014f18b",
   "status": "draft",
+  "restoreJobType": "standard",
+  "restoreSessionArtifactCount": {
+    "total": 2,
+    "completed": 0,
+    "inProgress": 0,
+    "failed": 0
+  },
   "createdBy": {
     "application": {
       "id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
diff --git a/api-reference/beta/api/backuprestoreroot-post-onedriveforbusinessrestoresessions.md b/api-reference/beta/api/backuprestoreroot-post-onedriveforbusinessrestoresessions.md
@@ -1,6 +1,6 @@
 ---
 title: "Create oneDriveForBusinessRestoreSession"
-description: "Create a new OneDrive for Business restore session."
+description: "Create a new OneDrive for Work or School restore session."
 author: "tushar20"
 ms.reviewer: "manikantsinghms"
 ms.localizationpriority: medium
@@ -142,6 +142,13 @@ Content-Type: application/json
   "@odata.context": "/solutions/backupRestore/$metadata#oneDriveForBusinessRestoreSession/$entity",
   "id": "959ba739-70b5-43c4-8c90-b2c22014f18b",
   "status": "draft",
+  "restoreJobType": "standard",
+  "restoreSessionArtifactCount": {
+    "total": 2,
+    "completed": 0,
+    "inProgress": 0,
+    "failed": 0
+  },
   "createdBy": {
     "application": {
       "id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
diff --git a/api-reference/beta/api/backuprestoreroot-post-sharepointrestoresessions.md b/api-reference/beta/api/backuprestoreroot-post-sharepointrestoresessions.md
@@ -142,6 +142,13 @@ Content-Type: application/json
   "@odata.type": "#microsoft.graph.sharepointRestoreSession",
   "id": "61633878-8321-4950-bfaf-ed285bdd1461",
   "status": "activating",
+  "restoreJobType": "standard",
+  "restoreSessionArtifactCount": {
+    "total": 2,
+    "completed": 0,
+    "inProgress": 2,
+    "failed": 0
+  },
   "createdBy": {
     "application": {
       "id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
diff --git a/api-reference/beta/api/exchangerestoresession-list-mailboxrestoreartifacts.md b/api-reference/beta/api/exchangerestoresession-list-mailboxrestoreartifacts.md
@@ -125,6 +125,7 @@ Content-Type: application/json
       "completionDateTime": "2023-12-04T13:22:12.7209691Z",
       "restoredFolderId": "0bdb38aa-5ad4-43ae-b63d-54426c97caa3",
       "restoredFolderName": "testmailbox101",
+      "restoredItemCount": 5,
       "restorePoint": {
           "id": "ffd2687a-f507-4a82-9dff-2fa78cfdaa41_1801645000_12_2",
           "protectionDateTime": "2023-12-04T00:00:00Z",
@@ -139,6 +140,7 @@ Content-Type: application/json
       "completionDateTime": "2024-02-10T13:22:12.7209691Z",
       "restoredFolderId": "f8bb7c43-dabd-4300-a56a-510f093bc537",
       "restoredFolderName": "testmailbox102",
+      "restoredItemCount": 10,
       "restorePoint": {
           "id": "86ba0fa7-db56-4c70-bf47-62adafefc0ee_1801645000_12_2",
           "protectionDateTime": "2024-02-10T00:00:00Z",
diff --git a/api-reference/beta/api/restoresessionbase-activate.md b/api-reference/beta/api/restoresessionbase-activate.md
@@ -133,6 +133,13 @@ Content-Type: application/json
   "@odata.type": "#microsoft.graph.sharepointRestoreSession",
   "id": "61633878-8321-4950-bfaf-ed285bdd1461",
   "status": "activating",
+  "restoreJobType": "standard",
+  "restoreSessionArtifactCount": {
+    "total": 2,
+    "completed": 0,
+    "inProgress": 2,
+    "failed": 0
+  },
   "createdBy": {
     "application": {
       "id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
diff --git a/api-reference/beta/api/restoresessionbase-get.md b/api-reference/beta/api/restoresessionbase-get.md
@@ -118,6 +118,13 @@ Content-Type: application/json
   "@odata.type": "#microsoft.graph.sharepointRestoreSession",
   "id": "959ba739-70b5-43c4-8c90-b2c22014f18b",
   "status": "active",
+  "restoreJobType": "standard",
+  "restoreSessionArtifactCount": {
+    "total": 2,
+    "completed": 1,
+    "inProgress": 1,
+    "failed": 0
+  },
   "createdBy": {
     "application": {
       "id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
diff --git a/api-reference/beta/resources/enums.md b/api-reference/beta/resources/enums.md
@@ -4957,3 +4957,11 @@ Possible values for user account types (group membership), per Windows definitio
 |false|
 |true|
 |unknownFutureValue|
+
+### restoreJobType values 
+
+|Member|
+|:---|
+|standard|
+|bulk|
+|unknownFutureValue|
diff --git a/api-reference/beta/resources/exchangerestoresession.md b/api-reference/beta/resources/exchangerestoresession.md
@@ -35,6 +35,8 @@ Inherits from [restoreSessionBase](../resources/restoresessionbase.md).
 |error|[publicError](../resources/publicerror.md)|Contains error details if the restore session fails or completes with an error.|
 |lastModifiedBy|[identitySet](../resources/identityset.md)|Identity of the person who last modified this restore session.|
 |lastModifiedDateTime|DateTimeOffset|Timestamp of last modification of this restore session.|
+|restoreJobType|[restoreJobType](../resources/enums.md#restorejobtype-values)|Indicates whether the restore session was created normally or by a bulk job.|
+|restoreSessionArtifactCount|[restoreSessionArtifactCount](../resources/restoresessionartifactcount.md)|The number of metadata artifacts that belong to this restore session.|
 |status|[restoreSessionStatus](../resources/exchangerestoresession.md#restoresessionstatus-values)|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](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `failed`.|
 
 ### restoreSessionStatus values
@@ -46,7 +48,7 @@ Inherits from [restoreSessionBase](../resources/restoresessionbase.md).
 |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.|
+|unknownFutureValue| Evolvable enumeration sentinel value. Don't use.|
 
 ## Relationships
 |Relationship|Type|Description|
@@ -68,6 +70,10 @@ The following JSON representation shows the resource type.
   "@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"
diff --git a/api-reference/beta/resources/granularmailboxrestoreartifact.md b/api-reference/beta/resources/granularmailboxrestoreartifact.md
@@ -33,9 +33,10 @@ Inherits from [mailboxRestoreArtifact](../resources/mailboxRestoreArtifact.md).
 |error|[publicError](../resources/publicerror.md)|Contains error details if the restoration of the artifact fails. Inherited from [restoreArtifactBase](../resources/restoreartifactbase.md).|
 |restoredFolderId|String|The new restored folder identifier for the user.|
 |restoredFolderName|String|The new restored folder name.|
+|restoredItemCount|Int32|The number of items that are being restored in the folder.|
 |searchResponseId|String|.|
 |startDateTime|DateTimeOffset|The time when the restoration of the artifact started. Inherited from [restoreArtifactBase](../resources/restoreartifactbase.md).|
-|status|[artifactRestoreStatus](../resources/mailboxrestoreartifact.md#artifactrestorestatus-values)|The restoration status of the artifact. Inherited from [restoreArtifactBase](../resources/restoreartifactbase.md).T he possible values are: `added`, `scheduling`, `scheduled`, `inProgress`, `succeeded`, `failed`, `unknownFutureValue`.|
+|status|[artifactRestoreStatus](../resources/mailboxrestoreartifact.md#artifactrestorestatus-values)|The restoration status of the artifact. Inherited from [restoreArtifactBase](../resources/restoreartifactbase.md). The possible values are: `added`, `scheduling`, `scheduled`, `inProgress`, `succeeded`, `failed`, `unknownFutureValue`.|
 
 ## Relationships
 |Relationship|Type|Description|
@@ -66,6 +67,7 @@ The following JSON representation shows the resource type.
   },
   "restoredFolderId": "String",
   "restoredFolderName": "String",
+  "restoredItemCount": "Int32",
   "searchResponseId": "String"
 }
 ```
diff --git a/api-reference/beta/resources/mailboxrestoreartifact.md b/api-reference/beta/resources/mailboxrestoreartifact.md
@@ -32,8 +32,9 @@ Inherits from [restoreArtifactBase](../resources/restoreartifactbase.md).
 |error|[publicError](../resources/publicerror.md)|Contains error details if the restoration of the artifact fails. Inherited from [restoreArtifactBase](../resources/restoreartifactbase.md).|
 |restoredFolderId|String|The new restored folder identifier for the user.|
 |restoredFolderName|String|The new restored folder name.|
+|restoredItemCount|Int32|The number of items that are being restored in the folder.|
 |startDateTime|DateTimeOffset|The time when the restoration of the artifact started. Inherited from [restoreArtifactBase](../resources/restoreartifactbase.md).|
-|status|[artifactRestoreStatus](../resources/mailboxrestoreartifact.md#artifactrestorestatus-values)|The restoration status of the artifact. Inherited from [restoreArtifactBase](../resources/restoreartifactbase.md).T he possible values are: `added`, `scheduling`, `scheduled`, `inProgress`, `succeeded`, `failed`, `unknownFutureValue`.|
+|status|[artifactRestoreStatus](../resources/mailboxrestoreartifact.md#artifactrestorestatus-values)|The restoration status of the artifact. Inherited from [restoreArtifactBase](../resources/restoreartifactbase.md). The possible values are: `added`, `scheduling`, `scheduled`, `inProgress`, `succeeded`, `failed`, `unknownFutureValue`.|
 
 ### artifactRestoreStatus values
 
@@ -45,15 +46,15 @@ Inherits from [restoreArtifactBase](../resources/restoreartifactbase.md).
 |inProgress|The restore artifact was picked for restoration.|
 |succeeded|The restore artifact was successfully restored.|
 |failed|The restoration of the artifact failed.|
-|unknownFutureValue| Evolvable enumeration sentinel value. Do not use.|
+|unknownFutureValue| Evolvable enumeration sentinel value. Don't use.|
 
 ### destinationType values
 
 |Member | Description |
 |:------|:------------|
-|new|Restoration will occur at a new location. For SharePoint and OneDrive, a new site will be created and content will be restored in the new site. For Exchange, a restored folder is created and content will be restored there.|
-|inPlace|Restoration will occur in the same location. For SharePoint, it will be on the same site, for OneDrive, on the same drive, and for Exchange, the artifact will be restored in the same mailbox.|
-|unknownFutureValue|Evolvable enumeration sentinel value. Do not use.|
+|new|Restoration occurs at a new location. For SharePoint and OneDrive, a new site is created and content is restored in the new site. For Exchange, a restored folder is created and content is restored there.|
+|inPlace|Restoration occurs in the same location. For SharePoint, it is on the same site, for OneDrive, on the same drive, and for Exchange, the artifact is restored in the same mailbox.|
+|unknownFutureValue|Evolvable enumeration sentinel value. Don't use.|
 
 ## Relationships
 |Relationship|Type|Description|
@@ -82,7 +83,8 @@ The following JSON representation shows the resource type.
     "@odata.type": "microsoft.graph.publicError"
   },
   "restoredFolderId": "String",
-  "restoredFolderName": "String"
+  "restoredFolderName": "String",
+  "restoredItemCount": "Int32"
 }
 ```
 
diff --git a/api-reference/beta/resources/onedriveforbusinessrestoresession.md b/api-reference/beta/resources/onedriveforbusinessrestoresession.md
@@ -1,6 +1,6 @@
 ---
 title: "oneDriveForBusinessRestoreSession resource type"
-description: "epresents restore-related tasks on artifacts that are protected by a OneDrive protection policy."
+description: "Represents restore-related tasks on artifacts that are protected by a OneDrive protection policy."
 author: "tushar20"
 ms.reviewer: "manikantsinghms"
 ms.localizationpriority: medium
@@ -36,7 +36,9 @@ Inherits from [restoreSessionBase](../resources/restoresessionbase.md).
 |error|[publicError](../resources/publicerror.md)|Contains error details if the restore session fails or completes with an error.|
 |lastModifiedBy|[identitySet](../resources/identityset.md)|Identity of the person who last modified this restore session.|
 |lastModifiedDateTime|DateTimeOffset|Timestamp of the last modification of this restore session.|
-|status|[restoreSessionStatus](../resources/onedriveforbusinessrestoresession.md#restoresessionstatus-values)|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](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `failed`.|
+|status|[restoreSessionStatus](../resources/onedriveforbusinessrestoresession.md#restoresessionstatus-values)|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](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `failed`.|
+|restoreJobType|[restoreJobType](../resources/enums.md#restorejobtype-values)|Indicates whether the restore session was created normally or by a bulk job.|
+|restoreSessionArtifactCount|[restoreSessionArtifactCount](../resources/restoresessionartifactcount.md)|The number of metadata artifacts that belong to this restore session.|
 
 ### restoreSessionStatus values
 
@@ -48,7 +50,7 @@ Inherits from [restoreSessionBase](../resources/restoresessionbase.md).
 |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.|
+|unknownFutureValue| Evolvable enumeration sentinel value. Don't use.|
 
 ## Relationships
 |Relationship|Type|Description|
@@ -70,6 +72,10 @@ The following JSON representation shows the resource type.
   "@odata.type": "#microsoft.graph.oneDriveForBusinessRestoreSession",
   "id": "String (identifier)",
   "status": "String",
+  "restoreJobType": "String",
+  "restoreSessionArtifactCount": {
+    "@odata.type": "microsoft.graph.restoreSessionArtifactCount"
+  },
   "createdDateTime": "String (timestamp)",
   "createdBy": {
     "@odata.type": "microsoft.graph.identitySet"
diff --git a/api-reference/beta/resources/restoresessionartifactcount.md b/api-reference/beta/resources/restoresessionartifactcount.md
@@ -0,0 +1,46 @@
+---
+title: "restoreSessionArtifactCount resource type"
+description: "Represents artifact count metadata for a restore session."
+author: "satpatel1"
+ms.reviewer: "satpatel1"
+ms.localizationpriority: medium
+ms.subservice: "m365-backup-storage"
+doc_type: resourcePageType
+toc.title: RestoreSessionArtifactCount
+---
+
+# restoreSessionArtifactCount resource type
+
+Namespace: microsoft.graph
+
+[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
+
+Represents artifact count metadata for a [restore session](../resources/restoreSessionBase.md). Restore session APIs are used by SharePoint, OneDrive, and Exchange Online admins to perform restore-related tasks on artifacts that are protected as part of a protection policy.
+
+## Properties
+
+|Property|Type|Description|
+|:---|:---|:---|
+|total|Int32|The number of artifacts present in the restore session.|
+|inProgress|Int32|The number of artifacts whose restoration is in progress.|
+|completed|Int32|The number of artifacts whose restoration completed.|
+|failed|Int32|The number of artifacts whose restoration failed.|
+
+## JSON representation
+
+The following JSON representation shows the resource type.
+<!-- {
+  "blockType": "resource",
+  "@odata.type": "microsoft.graph.restoreSessionArtifactCount",
+  "openType": false
+}
+-->
+``` json
+{
+  "@odata.type": "#microsoft.graph.restoreSessionArtifactCount",
+  "total": "Int32",
+  "inProgress": "Int32",
+  "completed": "Int32",
+  "failed": "Int32"
+}
+```
diff --git a/api-reference/beta/resources/restoresessionbase.md b/api-reference/beta/resources/restoresessionbase.md
@@ -1,6 +1,6 @@
 ---
 title: "restoreSessionBase resource type"
-description: "Describes a restore session and its properties"
+description: "Represents a restore session and its properties."
 author: "tushar20"
 ms.reviewer: "manikantsinghms"
 ms.localizationpriority: medium
@@ -17,7 +17,7 @@ Namespace: microsoft.graph
 
 Represents a restore session for a [protection unit](protectionunitbase.md) that's protected by a [protection policy](protectionpolicybase.md). Restore session APIs are used by global admins, SharePoint Online admins, and Exchange Online admins to perform restore-related tasks on artifacts that are protected as part of protection policy.
 
-Restoring to both a new location and the same URL in a single restore session is not supported.
+Restoring to both a new location and the same URL in a single restore session isn't supported.
 
 ## Methods
 
@@ -39,6 +39,8 @@ Restoring to both a new location and the same URL in a single restore session is
 |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.|
+|restoreJobType|[restoreJobType](../resources/enums.md#restorejobtype-values)|Indicates whether the restore session was created normally or by a bulk job.|
+|restoreSessionArtifactCount|[restoreSessionArtifactCount](../resources/restoresessionartifactcount.md)|The number of metadata artifacts that belong to this restore session.|
 |status|[restoreSessionStatus](../resources/restoresessionbase.md#restoresessionstatus-values)|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](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `failed`.|
 
 ### restoreSessionStatus values
@@ -73,6 +75,10 @@ The following JSON representation shows the resource type.
   "@odata.type": "#microsoft.graph.restoreSessionBase",
   "id": "String (identifier)",
   "status": "String",
+  "restoreJobType": "String",
+  "restoreSessionArtifactCount": {
+    "@odata.type": "microsoft.graph.restoreSessionArtifactCount"
+  },
   "createdDateTime": "String (timestamp)",
   "createdBy": {
     "@odata.type": "microsoft.graph.identitySet"
diff --git a/api-reference/beta/resources/sharepointrestoresession.md b/api-reference/beta/resources/sharepointrestoresession.md
diff --git a/changelog/Microsoft.EnhancedRestore.json b/changelog/Microsoft.EnhancedRestore.json
