Create oneDriveForBusinessRestoreSession

Namespace: microsoft.graph

Create a new oneDriveForBusinessRestoreSession object.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	❌	❌	❌

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permission	Higher privileged permissions
Delegated (work or school account)	BackupRestore-Restore.ReadWrite.All	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	BackupRestore-Restore.ReadWrite.All	Not available.

HTTP request

POST /solutions/backupRestore/oneDriveForBusinessRestoreSessions

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json. Required.

Request body

In the request body, supply a JSON representation of the oneDriveForBusinessRestoreSession object.

You can specify the following properties when you create a oneDriveForBusinessRestoreSession.

Property	Type	Description
driveRestoreArtifacts	driveRestoreArtifact collection	A collection of driveRestoreArtifact objects. Required.

Response

If successful, this method returns a 201 Created response code and a oneDriveForBusinessRestoreSession object in the response body.

For a list of possible error responses, see Backup Storage API error responses.

Examples

Request

The following example shows a request.

HTTP

POST https://graph.microsoft.com/v1.0/solutions/backupRestore/oneDriveForBusinessRestoreSessions
Content-Type: application/json

{
  "driveRestoreArtifacts": [
    {
      "restorePoint": { "@odata.id": "1f1fccc3-a642-4f61-bf49-f37b9a888279" },
      "destinationType": "new"
    },
    {
      "restorePoint": { "@odata.id": "1f1fccc3-a642-4f61-bf49-f37b9a888280" },
      "destinationType": "new"
    }
  ]
}

C#

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

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new OneDriveForBusinessRestoreSession
{
	DriveRestoreArtifacts = new List<DriveRestoreArtifact>
	{
		new DriveRestoreArtifact
		{
			RestorePoint = new RestorePoint
			{
				AdditionalData = new Dictionary<string, object>
				{
					{
						"@odata.id" , "1f1fccc3-a642-4f61-bf49-f37b9a888279"
					},
				},
			},
			DestinationType = DestinationType.New,
		},
		new DriveRestoreArtifact
		{
			RestorePoint = new RestorePoint
			{
				AdditionalData = new Dictionary<string, object>
				{
					{
						"@odata.id" , "1f1fccc3-a642-4f61-bf49-f37b9a888280"
					},
				},
			},
			DestinationType = DestinationType.New,
		},
	},
};

// 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.PostAsync(requestBody);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

CLI

mgc solutions backup-restore one-drive-for-business-restore-sessions create --body '{\
  "driveRestoreArtifacts": [\
    {\
      "restorePoint": { "@odata.id": "1f1fccc3-a642-4f61-bf49-f37b9a888279" },\
      "destinationType": "new"\
    },\
    {\
      "restorePoint": { "@odata.id": "1f1fccc3-a642-4f61-bf49-f37b9a888280" },\
      "destinationType": "new"\
    }\
  ]\
}\
'

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewOneDriveForBusinessRestoreSession()


driveRestoreArtifact := graphmodels.NewDriveRestoreArtifact()
restorePoint := graphmodels.NewRestorePoint()
additionalData := map[string]interface{}{
	"@odata.id" : "1f1fccc3-a642-4f61-bf49-f37b9a888279", 
}
restorePoint.SetAdditionalData(additionalData)
driveRestoreArtifact.SetRestorePoint(restorePoint)
destinationType := graphmodels.NEW_DESTINATIONTYPE 
driveRestoreArtifact.SetDestinationType(&destinationType) 
driveRestoreArtifact1 := graphmodels.NewDriveRestoreArtifact()
restorePoint := graphmodels.NewRestorePoint()
additionalData := map[string]interface{}{
	"@odata.id" : "1f1fccc3-a642-4f61-bf49-f37b9a888280", 
}
restorePoint.SetAdditionalData(additionalData)
driveRestoreArtifact1.SetRestorePoint(restorePoint)
destinationType := graphmodels.NEW_DESTINATIONTYPE 
driveRestoreArtifact1.SetDestinationType(&destinationType) 

driveRestoreArtifacts := []graphmodels.DriveRestoreArtifactable {
	driveRestoreArtifact,
	driveRestoreArtifact1,
}
requestBody.SetDriveRestoreArtifacts(driveRestoreArtifacts)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
oneDriveForBusinessRestoreSessions, err := graphClient.Solutions().BackupRestore().OneDriveForBusinessRestoreSessions().Post(context.Background(), requestBody, nil)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

OneDriveForBusinessRestoreSession oneDriveForBusinessRestoreSession = new OneDriveForBusinessRestoreSession();
LinkedList<DriveRestoreArtifact> driveRestoreArtifacts = new LinkedList<DriveRestoreArtifact>();
DriveRestoreArtifact driveRestoreArtifact = new DriveRestoreArtifact();
RestorePoint restorePoint = new RestorePoint();
HashMap<String, Object> additionalData = new HashMap<String, Object>();
additionalData.put("@odata.id", "1f1fccc3-a642-4f61-bf49-f37b9a888279");
restorePoint.setAdditionalData(additionalData);
driveRestoreArtifact.setRestorePoint(restorePoint);
driveRestoreArtifact.setDestinationType(DestinationType.New);
driveRestoreArtifacts.add(driveRestoreArtifact);
DriveRestoreArtifact driveRestoreArtifact1 = new DriveRestoreArtifact();
RestorePoint restorePoint1 = new RestorePoint();
HashMap<String, Object> additionalData1 = new HashMap<String, Object>();
additionalData1.put("@odata.id", "1f1fccc3-a642-4f61-bf49-f37b9a888280");
restorePoint1.setAdditionalData(additionalData1);
driveRestoreArtifact1.setRestorePoint(restorePoint1);
driveRestoreArtifact1.setDestinationType(DestinationType.New);
driveRestoreArtifacts.add(driveRestoreArtifact1);
oneDriveForBusinessRestoreSession.setDriveRestoreArtifacts(driveRestoreArtifacts);
OneDriveForBusinessRestoreSession result = graphClient.solutions().backupRestore().oneDriveForBusinessRestoreSessions().post(oneDriveForBusinessRestoreSession);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const oneDriveForBusinessRestoreSession = {
  driveRestoreArtifacts: [
    {
      restorePoint: { '@odata.id': '1f1fccc3-a642-4f61-bf49-f37b9a888279' },
      destinationType: 'new'
    },
    {
      restorePoint: { '@odata.id': '1f1fccc3-a642-4f61-bf49-f37b9a888280' },
      destinationType: 'new'
    }
  ]
};

await client.api('/solutions/backupRestore/oneDriveForBusinessRestoreSessions')
	.post(oneDriveForBusinessRestoreSession);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\OneDriveForBusinessRestoreSession;
use Microsoft\Graph\Generated\Models\DriveRestoreArtifact;
use Microsoft\Graph\Generated\Models\RestorePoint;
use Microsoft\Graph\Generated\Models\DestinationType;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new OneDriveForBusinessRestoreSession();
$driveRestoreArtifactsDriveRestoreArtifact1 = new DriveRestoreArtifact();
$driveRestoreArtifactsDriveRestoreArtifact1RestorePoint = new RestorePoint();
$additionalData = [
	'@odata.id' => '1f1fccc3-a642-4f61-bf49-f37b9a888279',
];
$driveRestoreArtifactsDriveRestoreArtifact1RestorePoint->setAdditionalData($additionalData);
$driveRestoreArtifactsDriveRestoreArtifact1->setRestorePoint($driveRestoreArtifactsDriveRestoreArtifact1RestorePoint);
$driveRestoreArtifactsDriveRestoreArtifact1->setDestinationType(new DestinationType('new'));
$driveRestoreArtifactsArray []= $driveRestoreArtifactsDriveRestoreArtifact1;
$driveRestoreArtifactsDriveRestoreArtifact2 = new DriveRestoreArtifact();
$driveRestoreArtifactsDriveRestoreArtifact2RestorePoint = new RestorePoint();
$additionalData = [
	'@odata.id' => '1f1fccc3-a642-4f61-bf49-f37b9a888280',
];
$driveRestoreArtifactsDriveRestoreArtifact2RestorePoint->setAdditionalData($additionalData);
$driveRestoreArtifactsDriveRestoreArtifact2->setRestorePoint($driveRestoreArtifactsDriveRestoreArtifact2RestorePoint);
$driveRestoreArtifactsDriveRestoreArtifact2->setDestinationType(new DestinationType('new'));
$driveRestoreArtifactsArray []= $driveRestoreArtifactsDriveRestoreArtifact2;
$requestBody->setDriveRestoreArtifacts($driveRestoreArtifactsArray);


$result = $graphServiceClient->solutions()->backupRestore()->oneDriveForBusinessRestoreSessions()->post($requestBody)->wait();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PowerShell

Import-Module Microsoft.Graph.BackupRestore

$params = @{
	driveRestoreArtifacts = @(
		@{
			restorePoint = @{
				"@odata.id" = "1f1fccc3-a642-4f61-bf49-f37b9a888279"
			}
			destinationType = "new"
		}
		@{
			restorePoint = @{
				"@odata.id" = "1f1fccc3-a642-4f61-bf49-f37b9a888280"
			}
			destinationType = "new"
		}
	)
}

New-MgSolutionBackupRestoreOneDriveForBusinessRestoreSession -BodyParameter $params

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.one_drive_for_business_restore_session import OneDriveForBusinessRestoreSession
from msgraph.generated.models.drive_restore_artifact import DriveRestoreArtifact
from msgraph.generated.models.restore_point import RestorePoint
from msgraph.generated.models.destination_type import DestinationType
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = OneDriveForBusinessRestoreSession(
	drive_restore_artifacts = [
		DriveRestoreArtifact(
			restore_point = RestorePoint(
				additional_data = {
						"@odata_id" : "1f1fccc3-a642-4f61-bf49-f37b9a888279",
				}
			),
			destination_type = DestinationType.New,
		),
		DriveRestoreArtifact(
			restore_point = RestorePoint(
				additional_data = {
						"@odata_id" : "1f1fccc3-a642-4f61-bf49-f37b9a888280",
				}
			),
			destination_type = DestinationType.New,
		),
	],
)

result = await graph_client.solutions.backup_restore.one_drive_for_business_restore_sessions.post(request_body)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.context": "/solutions/backupRestore/$metadata#oneDriveForBusinessRestoreSession/$entity",
  "id": "959ba739-70b5-43c4-8c90-b2c22014f18b",
  "status": "draft",
  "createdBy": {
    "application": {
      "id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
      "displayName": "Microsoft Enhanced Restore"
    },
    "user": {
      "id": "845457dc-4bb2-4815-bef3-8628ebd1952e",
      "displayName": "User1"
    }
  },
  "createdDateTime": "2023-03-30T12:01:03.45Z",
  "lastModifiedBy": {
    "application": {
      "id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
      "displayName": "Microsoft Enhanced Restore"
    },
    "user": {
      "id": "845457dc-4bb2-4815-bef3-8628ebd1952e",
      "displayName": "User2"
    }
  },
  "lastModifiedDateTime": "2023-03-30T12:01:03.45Z"
}