名前空間: microsoft.graph
oneDriveForBusinessRestoreSession オブジェクトのプロパティを更新します。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
|---|---|---|---|
| ✅ | ❌ | ❌ | ❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
|---|---|---|
| 委任 (職場または学校のアカウント) | BackupRestore-Restore.ReadWrite.All | 注意事項なし。 |
| 委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
| アプリケーション | BackupRestore-Restore.ReadWrite.All | 注意事項なし。 |
HTTP 要求
PATCH /solutions/backupRestore/oneDriveForBusinessRestoreSessions/{oneDriveForBusinessRestoreSessionId}
要求ヘッダー
| 名前 | 説明 |
|---|---|
| Authorization | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
| Content-Type | application/json. 必須です。 |
要求本文
リクエストの本文には、更新するプロパティの値 のみ を指定します。 要求本文に含まれていない既存のプロパティは、以前の値を維持するか、他のプロパティ値の変更に基づいて再計算されます。
次の表に、更新できるプロパティを示します。
| プロパティ | 型 | 説明 |
|---|---|---|
| driveRestoreArtifacts | driveRestoreArtifact コレクション | driveRestoreArtifact のコレクション。 必須 |
| granularDriveRestoreArtifacts | granularDriveRestoreArtifact コレクション | granularDriveRestoreArtifact オブジェクトのコレクション。 必須です。 |
| policyId | 文字列 | 復元セッションのスコープを設定する保護ポリシーの識別子。 提供されると、サービスは参照されている保護ユニットがこのポリシーに属していることを検証します。 restoreSessionBase から継承されます。 |
標準リストア・セッションから driveRestoreArtifact を削除するには、要求本文で driveRestoreArtifact オブジェクトの ID と一緒に @removed 注釈を指定します。
詳細な復元セッションから granularDriveRestoreArtifact を削除するには、リクエスト本文で granularDriveRestoreArtifact のそれぞれのアーティファクト ID の @removed 注釈を指定します。
応答
成功した場合、このメソッドは応答本文で 200 OK 応答コードと更新された oneDriveForBusinessRestoreSession オブジェクトを返します。
考えられるエラー応答の一覧については、 Backup Storage API のエラー応答を参照してください。
例
例 1:標準復元セッションを更新する
要求
次の例は要求を示しています。
PATCH https://graph.microsoft.com/v1.0/solutions/backupRestore/oneDriveForBusinessRestoreSessions/1b014d8c-71fe-4d00-8ab2-31850bc5b32c
{
"policyId": "99999999-aaaa-bbbb-cccc-dddddddddddd",
"driveRestoreArtifacts@delta": [
{
"restorePoint": { "id": "1b014d8c-71fe-4d00-a01a-31850bc5b32c" }, //Create a new drive restore artifact and add it under the Restore Session.
"destinationType": "new"
},
{
"restorePoint": { "id": "2b014d8c-71fe-4d00-a01a-31850bc5b32" },
"destinationType": "new"
},
{
"restorePoint": { "id": "3b014d8c-71fe-4d00-a01a-31850bc5b32c" },
"destinationType": "new"
},
{
"restorePoint": { "id": "4b014d8c-71fe-4d00-a01a-31850bc5b32c" },
"destinationType": "new"
},
{
"@removed": {
"reason": "changed"
},
"id": "99954f18-c8ec-4b62-85bf-cdf3b70b140e"
},
{
"@removed": {
"reason": "changed"
},
"id": "4267e382-71a9-4c07-bef7-bda97e09c0d2"
},
{
"@removed": {
"reason": "changed"
},
"id": "3667e382-71a9-4c07-bef7-bda97e09c0d2"
}
]
}
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
{
"driveRestoreArtifacts@delta": [
{
"id": "89014d8c-71fe-4d00-a01a-31850bc5b32c",
"restorePoint": { "id": "1b014d8c-71fe-4d00-a01a-31850bc5b32c" },
"destinationType": "new",
"status": "added",
"createdDateTime": "2015-06-19T12:01:03.45Z"
},
{
"id": "67014d8c-71fe-4d00-a01a-31850bc5b32c",
"restorePoint": { "id": "2b014d8c-71fe-4d00-a01a-31850bc5b32c" },
"destinationType": "new",
"status": "added",
"createdDateTime": "2015-06-19T12:01:03.45Z"
},
{
"id": "56014d8c-71fe-4d00-a01a-31850bc5b32c",
"restorePoint": { "id": "3b014d8c-71fe-4d00-a01a-31850bc5b32c" },
"destinationType": "new",
"status": "added",
"createdDateTime": "2015-06-19T12:01:03.45Z"
},
{
"id": "32014d8c-71fe-4d00-a01a-31850bc5b32c",
"restorePoint": { "id": "4b014d8c-71fe-4d00-a01a-31850bc5b32c" },
"destinationType": "new",
"status": "added",
"createdDateTime": "2015-06-19T12:01:03.45Z"
},
{
//Error scenario
"@contentId": "3467e382-71a9-4c07-bef7-bda97e09c0d2", // To add context and more traceability.
"@Core.DataModificationException": {
"info": {
"code": "Invalid",
"message": "The identifier to be removed from the restore session does not exist"
},
"failedOperation": "remove",
"responseCode": 409
},
"id": "4267e382-71a9-4c07-bef7-bda97e09c0d2"
}
]
}
例 2: 粒度復元セッションを更新する
要求
次の例は要求を示しています。
PATCH https://graph.microsoft.com/v1.0/solutions/backupRestore/oneDriveForBusinessRestoreSessions/43e0638e-3ad7-4c7e-8749-72175d046e30
Content-Type: application/json
{
"granularDriveRestoreArtifacts@delta": [
{
"browseSessionId": "m_RtZ8BiiUXOK69cuN6gwubfm9_yeVlDg8s6hci01_cVOAE",
"itemKey": "a535851e-9fc6-4eb1-90ab-2955fd9117b5,2a8b7eaf-092a-4561-a25a-998ad2e5142e,38eec3f1-b879-44a6-8ae6-05bd46ed4b3d,ce66019f-cdf9-4575-aa81-de3aabe844a2"
},
{
"@removed": {
"reason": "changed"
},
"id": "a535851e-9fc6-4eb1-90ab-2955fd9117b5,2a8b7eaf-092a-4561-a25a-998ad2e5142e,38eec3f1-b879-44a6-8ae6-05bd46ed4b3d,ce66019f-cdf9-4575-aa81-de3aabe844a2"
}
]
}
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@context": "#$delta",
"id": "43e0638e-3ad7-4c7e-8749-72175d046e30",
"granularDriveRestoreArtifacts@delta": [
{
"directoryObjectId": null,
"id": "a535851e-9fc6-4eb1-90ab-2955fd9117b5,2a8b7eaf-092a-4561-a25a-998ad2e5142e,38eec3f1-b879-44a6-8ae6-05bd46ed4b3d,ce66019f-cdf9-4575-aa81-de3aabe844a2",
"browseSessionId": "m_RtZ8BiiUXOK69cuN6gwubfm9_yeVlDg8s6hci01_cVOAE",
"restoredItemKey": "",
"webUrl": "",
"restoredItemPath": null,
"restoredItemWebUrl": "",
"status": "added",
"restorePointDateTime": "0001-01-01T00:00:00Z",
"startDateTime": "0001-01-01T00:00:00Z",
"completionDateTime": "0001-01-01T00:00:00Z"
},
{
"id": "a535851e-9fc6-4eb1-90ab-2955fd9117b5,2a8b7eaf-092a-4561-a25a-998ad2e5142e,38eec3f1-b879-44a6-8ae6-05bd46ed4b3d,ce66019f-cdf9-4575-aa81-de3aabe844a2",
"@removed": {
"reason": "changed"
}
}
]
}