Skip to content

backuprestoreroot-post-sharepointprotectionpolicies.md

Latest commit

 

History

History
180 lines (144 loc) · 6.22 KB

backuprestoreroot-post-sharepointprotectionpolicies.md

File metadata and controls

180 lines (144 loc) · 6.22 KB
title Create sharePointProtectionPolicy
description Create a protection policy for a M365 service SharePoint
author tushar20
ms.reviewer manikantsinghms
ms.localizationpriority medium
ms.subservice m365-backup-storage
doc_type apiPageType
ms.date 08/26/2024

Create sharePointProtectionPolicy

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Create a protection policy for a M365 service SharePoint. Policy will be created in inactive state. User 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/sharePointProtectionPolicies/

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 sharePointProtectionPolicy object.

Property Type Description
displayName String Name of the SharePoint Protection Policy. Optional.
siteProtectionUnits Collection(siteProtectionUnit) Collection of the siteProtectionUnits to be added to the sharePointProtectionPolicy object. Required. Refer to site for the format of siteId.

Response

If successful, this method returns a 201 Created response code and a sharePointProtectionPolicy 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/sharePointProtectionPolicies

{
  "displayName": "SharePoint Protection Policy",
  "siteProtectionUnits": [
    {
      "siteId": "contoso.sharepoint.com,febad3c2-a7b2-454c-8910-272c7bcf78fc,ba7b70d0-8ba0-4cae-b19a-7cb8c739512f"
    },
    {
      "siteId": "contoso.sharepoint.com/sites/marketing,da60e844-ba1d-49bc-b4d4-d5e36bae9019,712a596e-90a1-49e3-9b48-bfa80bee8740"
    },
    {
      "siteId": "contoso.sharepoint.com/sites/hr,3bfc861e-9a17-4a27-9562-3d8b26c81bb5,0271110f-634f-4300-a841-3a8a2e851851"
    }
  ]
}

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#sharePointProtectionPolicies/$entity",
  "id": "b218eb4a-ea72-42bd-8f0b-d0bbf794bec7",
  "displayName": "SharePoint 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": [
    {
      //Keep the per 10 minute copies for 14 days
      "interval": "R/PT10M",
      "period": "P2W"
    },
    {
      //Keep the per week copies for 1 year
      "interval": "R/P1W",
      "period": "P1Y"
    }
  ]
}