Skip to content

backuprestoreroot-post-onedriveforbusinessprotectionpolicies.md

Latest commit

 

History

History
176 lines (142 loc) · 6.1 KB

backuprestoreroot-post-onedriveforbusinessprotectionpolicies.md

File metadata and controls

176 lines (142 loc) · 6.1 KB
title Create oneDriveForBusinessProtectionPolicy
description Create a protection policy for a M365 service OneDrive.
author tushar20
ms.reviewer manikantsinghms
ms.localizationpriority medium
ms.subservice m365-backup-storage
doc_type apiPageType
ms.date 08/26/2024

Create oneDriveForBusinessProtectionPolicy

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Create a protection policy for the OneDrive service in Microsoft 365. When the policy is created, its state is set to inactive. Users can also provide a list of protection units under the policy.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table]

HTTP request

POST /solutions/backupRestore/oneDriveForBusinessProtectionPolicies

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

You can specify the following properties when creating a oneDriveForBusinessProtectionPolicy.

Property Type Description
displayName String Name of the SharePoint Protection Policy. Required
driveProtectionUnits Collection(driveProtectionUnit) Collection of the driveProtectionUnit to be added to the oneDriveForBusinessProtectionPolicy. Required.

Response

If successful, this method returns a 201 Created response code and a oneDriveForBusinessProtectionPolicy 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/beta/solutions/backupRestore/oneDriveForBusinessProtectionPolicies

{
  "displayName": "OneDrive For Business Protection Policy",
  "driveProtectionUnits": [
    {
      "directoryObjectId": "cdd3a849-dcaf-4a85-af82-7e39fc14019"
    },
    {
      "directoryObjectId": "9bc069da-b746-41a4-89ab-26125c6373c7"
    },
    {
      "directoryObjectId": "b218eb4a-ea72-42bd-8f0b-d0bbf794bec7"
    }
  ]
}

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE 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-Location: https://graph.microsoft.com/beta/solutions/backupRestore/ProtectionPolicies/b218eb4a-ea72-42bd-8f0b-d0bbf794bec7

{
  "@odata.context": "/solutions/backupRestore/$metadata#oneDriveForBusinessProtectionPolicies/$entity",
  "id": "b218eb4a-ea72-42bd-8f0b-d0bbf794bec7",
  "displayName": "OneDrive Protection Policy",
  "status": "inactive",
  "isEnabled": false,
  "createdBy": {
    "application": {
      "id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
      "displayName": "Microsoft Enhanced Restore"
    },
    "user": {
      "email": "User1@contoso.com",
      "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": {
      "email": "User2@constoso.com",
      "id": "845457dc-4bb2-4815-bef3-8628ebd1952e",
      "displayName": "User2"
    }
  },
  "lastModifiedDateTime": "2015-06-19T12:01:03.45Z",
  "retentionSettings": [
    {
      "interval": "R/PT10M",
      "period": "P2W"
    },
    {
      "interval": "R/P1W",
      "period": "P1Y"
    }
  ]
}