restoreSessionBase: activate

Namespace: microsoft.graph

Activate a draft restoreSessionBase object.

The following points apply to restoring a protection unit:

• The SharePoint sites and OneDrive accounts being restored aren't locked in a ready-only state.
• For SharePoint and OneDrive sites restored to new URLs, users don't have the same permissions they had to the original site. Only the global admin or SharePoint admin has permission to the restored site. However, for in-place or restores to the same URL, the permissions from the original site at the time of restoration are preserved.
• Restoration of SharePoint site and OneDrive user content that was removed from the recycle bin isn't supported.
• Mailboxes, OneDrive accounts, and SharePoint sites that are under legal or in-place holds can't be restored unless the legal hold is removed. To restore a SharePoint site under legal hold, you need to restore the site to a new URL.
• Mailbox draft items aren't backed up and can't be restored.
• A restore isn't performed if the current state of the mailbox is same as the point in time you're trying to restore it to.
• SharePoint sites and OneDrive accounts that are restored to a new URL have a read-only lock on that new URL until the restore completes. The global admin can still download documents or remove the read-only lock manually.
• When a restore to a new location is performed, populating the property details of the new location can take more than 15 minutes.
• The global admin, SharePoint admin, or Exchange admin can initiate a restore of up to 1,000 SharePoint sites, 1,000 OneDrive users, and 1,000 mailboxes queued in parallel at a time.

This API is available in the following national cloud deployments.

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.

HTTP request

POST /solutions/backupRestore/restoreSessions/{restoreSessionBaseId}/activate

Request headers

Request body

Don't supply a request body for this method.

Response

If successful, this action returns a 200 OK response code and a restoreSessionBase 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.

POST https://graph.microsoft.com/v1.0/solutions/backupRestore/restoreSessions/61633878-8321-4950-bfaf-ed285bdd1461/activate

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

// To initialize your graphClient, see https://video2.skills-academy.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Solutions.BackupRestore.RestoreSessions["{restoreSessionBase-id}"].Activate.PostAsync();

mgc solutions backup-restore restore-sessions activate post --restore-session-base-id {restoreSessionBase-id}

// 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"
	  //other-imports
)


// To initialize your graphClient, see https://video2.skills-academy.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
activate, err := graphClient.Solutions().BackupRestore().RestoreSessions().ByRestoreSessionBaseId("restoreSessionBase-id").Activate().Post(context.Background(), nil)

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

var result = graphClient.solutions().backupRestore().restoreSessions().byRestoreSessionBaseId("{restoreSessionBase-id}").activate().post();

const options = {
	authProvider,
};

const client = Client.init(options);

await client.api('/solutions/backupRestore/restoreSessions/61633878-8321-4950-bfaf-ed285bdd1461/activate')
	.post();

<?php
use Microsoft\Graph\GraphServiceClient;


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


$result = $graphServiceClient->solutions()->backupRestore()->restoreSessions()->byRestoreSessionBaseId('restoreSessionBase-id')->activate()->post()->wait();

Import-Module Microsoft.Graph.Bookings

Initialize-MgBackupRestoreSession -RestoreSessionBaseId $restoreSessionBaseId

# 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://video2.skills-academy.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.solutions.backup_restore.restore_sessions.by_restore_session_base_id('restoreSessionBase-id').activate.post()

Response

The following example shows the response.

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": " /solutions/backupRestore/$metadata#restoreSessions/$entity",
  "@odata.id": "/solutions/backupRestore/sharepointRestoreSessions(61633878-8321-4950-bfaf-ed285bdd1461)",
  "@odata.type": "#microsoft.graph.sharepointRestoreSession",
  "id": "61633878-8321-4950-bfaf-ed285bdd1461",
  "status": "activating",
  "createdBy": {
    "application": {
      "id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
      "displayName": "Microsoft Enhanced Restore"
    },
    "user": {
      "id": "845457dc-4bb2-4815-bef3-8628ebd1952e",
      "displayName": "User1"
    }
  },
  "createdDateTime": "2015-06-19T12: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": "2015-06-19T12:01:03.45Z"
}