Create protectionRuleBase

Article
08/28/2024

Namespace: microsoft.graph

Create a new protection rule associated with a protection policy. You can use this method to create a mailboxProtectionRule, driveProtectionRule, or siteProtectionRule.

An inclusion rule indicates that a protection policy should contain protection units that match the specified rule criteria. The initial status of a protection rule upon creation is active. After the rule is applied, the state is either completed or completedWithErrors.

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 permissions	Higher privileged permissions
Delegated (work or school account)	BackupRestore-Configuration.ReadWrite.All	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	BackupRestore-Configuration.ReadWrite.All	Not available.

HTTP request

POST /solutions/backupRestore/sharePointProtectionPolicies/{sharePointProtectionPolicyId}/siteInclusionRules
POST /solutions/backupRestore/oneDriveForBusinessProtectionPolicies/{oneDriveForBusinessProtectionPolicyId}/driveInclusionRules
POST /solutions/backupRestore/exchangeProtectionPolicies/{exchangeProtectionPolicyId}/mailboxInclusionRules

Request headers

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

Request body

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

Properties to create a new siteInclusionRule

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

Property	Type	Description
siteExpression	String	Contains the site expression. Required.

Properties to create a new driveInclusionRule

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

Property	Type	Description
driveExpression	String	Contains the drive expression. Required.

Properties to create a new mailboxInclusionRule

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

Property	Type	Description
mailboxExpression	String	Contains the mailbox expression. Supports `memberOf` and `group.id` properties. Required

Response

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

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

Examples

Example 1: Create a new siteInclusionRule associated with a SharePoint protection policy

The following example shows how to create a new siteInclusionRule associated with a sharePointProtectionPolicy.

Request

The following example shows a request.

HTTP
JavaScript

POST https://graph.microsoft.com/v1.0/solutions/backupRestore/sharePointProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/siteInclusionRules 
Content-Type: application/json

{
    "siteExpression": "((displayName -contains 'Finance')  -or  (displayName -contains 'Legal'))"
}


const options = {
	authProvider,
};

const client = Client.init(options);

const siteProtectionRule = {
    siteExpression: '((displayName -contains \'Finance\')  -or  (displayName -contains \'Legal\'))'
};

await client.api('/solutions/backupRestore/sharePointProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/siteInclusionRules')
	.post(siteProtectionRule);

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.

HTTP/1.1 201 Created
Content-Location: https://graph.microsoft.com/v1.0/solutions/backupRestore/sharePointProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/siteInclusionRules('61633878-8321-4950-bfaf-ed285bdd1461')

{
   "@odata.type": "#microsoft.graph.siteProtectionRule",
   "id":"61633878-8321-4950-bfaf-ed285bdd1461",
   "status" : "active",
   "createdBy":{
      "application":{
         "id":"1fec8e78-bce4-4aaf-ab1b-5451cc387264"
      },
      "user":{
         "id":"845457dc-4bb2-4815-bef3-8628ebd1952e"
      }
   },
   "createdDateTime":"2015-06-19T12:01:03.45Z",
   "lastModifiedBy":{
      "application":{
         "id":"1fec8e78-bce4-4aaf-ab1b-5451cc387264"
      },
      "user":{
         "id":"845457dc-4bb2-4815-bef3-8628ebd1952e"
      }
   },
   "lastModifiedDateTime":"2015-06-19T12:01:03.45Z",
   "isAutoApplyEnabled": false,
   "siteExpression": "((displayName -contains 'Finance')  -or  (displayName -contains 'Legal'))"
}

Example 2: Create a new driveInclusionRule associated with a OneDriveForBusiness protection policy

The following example shows how to create a new driveInclusionRule associated with a oneDriveForBusinessProtectionPolicy.

Request

The following example shows a request.

HTTP
JavaScript

POST https://graph.microsoft.com/v1.0/solutions/backupRestore/oneDriveForBusinessProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/driveInclusionRules 
Content-Type: application/json

{
    "driveExpression": "(memberOf -any (group.id -in ['c318eb4a-ea72-42bd-8f0b-d0bbf794bec7']))"
}


const options = {
	authProvider,
};

const client = Client.init(options);

const driveProtectionRule = {
    driveExpression: '(memberOf -any (group.id -in [\'c318eb4a-ea72-42bd-8f0b-d0bbf794bec7\']))'
};

await client.api('/solutions/backupRestore/oneDriveForBusinessProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/driveInclusionRules')
	.post(driveProtectionRule);

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.

HTTP/1.1 201 Created
Content-Location: https://graph.microsoft.com/v1.0/solutions/backupRestore/oneDriveForBusinessProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/driveInclusionRules('61633878-8321-4950-bfaf-ed285bdd1461')

{
   "@odata.type": "#microsoft.graph.driveProtectionRule",
   "id":"61633878-8321-4950-bfaf-ed285bdd1461",
   "status" : "active",
   "createdBy":{
      "application":{
         "id":"1fec8e78-bce4-4aaf-ab1b-5451cc387264"
      },
      "user":{
         "id":"845457dc-4bb2-4815-bef3-8628ebd1952e"
      }
   },
   "createdDateTime":"2015-06-19T12:01:03.45Z",
   "lastModifiedBy":{
      "application":{
         "id":"1fec8e78-bce4-4aaf-ab1b-5451cc387264"
      },
      "user":{
         "id":"845457dc-4bb2-4815-bef3-8628ebd1952e"
      }
   },
   "lastModifiedDateTime":"2015-06-19T12:01:03.45Z",
   "isAutoApplyEnabled": false,
   "driveExpression": "(memberOf -any (group.id -in ['c318eb4a-ea72-42bd-8f0b-d0bbf794bec7']))"
}

Example 3: Create a new mailboxInclusionRule associated with an Exchange protection policy

The following example shows how to create a new mailboxInclusionRule associated with an exchangeProtectionPolicy.

Request

The following example shows a request.

HTTP
JavaScript

POST https://graph.microsoft.com/v1.0/solutions/backupRestore/exchangeProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/mailboxInclusionRules

{
   "mailboxExpression": "(memberOf -any (group.id -in ['f218eb4a-ea72-42bd-8f0b-d0bbf794bec7']))"
}


const options = {
	authProvider,
};

const client = Client.init(options);

const mailboxProtectionRule = {
   mailboxExpression: '(memberOf -any (group.id -in [\'f218eb4a-ea72-42bd-8f0b-d0bbf794bec7\']))'
};

await client.api('/solutions/backupRestore/exchangeProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/mailboxInclusionRules')
	.post(mailboxProtectionRule);

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.

HTTP/1.1 200 OK
Content-Location: https://graph.microsoft.com/v1.0/solutions/backupRestore/exchangeProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/mailboxInclusionRules('61633878-8321-4950-bfaf-ed285bdd1461')

{
   "@odata.type": "#microsoft.graph.mailboxProtectionRule",
   "id":"61633878-8321-4950-bfaf-ed285bdd1461",
   "status" : "active",
   "createdBy":{
      "application":{
         "id":"1fec8e78-bce4-4aaf-ab1b-5451cc387264"
      },
      "user":{
         "id":"845457dc-4bb2-4815-bef3-8628ebd1952e"
      }
   },
   "createdDateTime":"2015-06-19T12:01:03.45Z",
   "lastModifiedBy":{
      "application":{
         "id":"1fec8e78-bce4-4aaf-ab1b-5451cc387264"
      },
      "user":{
         "id":"845457dc-4bb2-4815-bef3-8628ebd1952e"
      }
   },
   "lastModifiedDateTime":"2015-06-19T12:01:03.45Z",
   "isAutoApplyEnabled": false,
   "mailboxExpression": "(memberOf -any (group.id -in ['f218eb4a-ea72-42bd-8f0b-d0bbf794bec7']))"
}

Share via

Create protectionRuleBase

Permissions

HTTP request

Request headers

Request body

Properties to create a new siteInclusionRule

Properties to create a new driveInclusionRule

Properties to create a new mailboxInclusionRule

Response

Examples

Example 1: Create a new siteInclusionRule associated with a SharePoint protection policy

Request

Response

Example 2: Create a new driveInclusionRule associated with a OneDriveForBusiness protection policy

Request

Response

Example 3: Create a new mailboxInclusionRule associated with an Exchange protection policy

Request

Response

Feedback

Additional resources