Skip to content

onedriveforbusinessprotectionpolicy.md

Latest commit

 

History

History
78 lines (67 loc) · 5.86 KB

onedriveforbusinessprotectionpolicy.md

File metadata and controls

78 lines (67 loc) · 5.86 KB
title oneDriveForBusinessProtectionPolicy resource type
description Represents details about protection policies applied to Microsoft 365 data in an organization.
author tushar20
ms.reviewer manikantsinghms
ms.localizationpriority medium
ms.subservice m365-backup-storage
doc_type resourcePageType
toc.title OneDrive for Business protection policy
ms.date 05/31/2024
ms.custom sfi-ga-nochange

oneDriveForBusinessProtectionPolicy resource type

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Represents details about protection policies applied to Microsoft 365 data in an organization. Global Admins (or SharePoint in Microsoft 365 Admins or Exchange Online Admins) define protection policies. They include what data to protect, when to protect it, and for what time period to retain the protected data for a single Microsoft 365 service.

Inherits from protectionPolicyBase.

Methods

Method Return type Description
Create oneDriveForBusinessProtectionPolicy Create a new oneDriveForBusinessProtectionPolicy.
Update oneDriveForBusinessProtectionPolicy Update the properties of a oneDriveForBusinessProtectionPolicy.

Properties

Property Type Description
createdBy identitySet The identity of the person who created the policy. Inherited from protectionPolicyBase.
createdDateTime DateTimeOffset The date and time when the policy was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Inherited from protectionPolicyBase.
displayName String The name of the policy to be created. Inherited from protectionPolicyBase.
id String The unique identifier of the protection rule associated with the policy. Inherited from protectionPolicyBase.
isEnabled Boolean Indicates whether the policy is enabled. Inherited from protectionPolicyBase.
lastModifiedBy identitySet The identity of the person who last modified the policy. Inherited from protectionPolicyBase.
lastModifiedDateTime DateTimeOffset The date and time when the policy was last modified. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Inherited from protectionPolicyBase.
offboardRequestedDateTime DateTimeOffset The date and time when offboarding was requested for the protection policy. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Inherited from protectionPolicyBase.
protectionPolicyArtifactCount protectionPolicyArtifactCount The count of artifacts in the protection policy by status. Returned only on $select. Inherited from protectionPolicyBase.
retentionSettings retentionSetting collection Contains the retention setting details for the policy. Inherited from protectionPolicyBase.
status protectionPolicyStatus Status of the policy. The value is the aggregated status of the protection units. The possible values are: inactive, activeWithErrors, updating, active, unknownFutureValue, offboardRequested, offboarded. You must use the Prefer: include-unknown-enum-members request header to get the following values in this evolvable enum: offboardRequested, offboarded. Inherited from protectionPolicyBase.

Relationships

Relationship Type Description
driveInclusionRules driveProtectionRule collection Contains the details of the OneDrive for Work or School protection rule.
driveProtectionUnits driveProtectionUnit collection Contains the protection units associated with a OneDrive for Work or School protection policy.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.oneDriveForBusinessProtectionPolicy",
  "createdBy": {"@odata.type": "microsoft.graph.identitySet"},
  "createdDateTime": "String (timestamp)",
  "displayName": "String",
  "id": "String (identifier)",
  "isEnabled": "Boolean",
  "lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"},
  "lastModifiedDateTime": "String (timestamp)",
  "offboardRequestedDateTime": "String (timestamp)",
  "protectionPolicyArtifactCount": {"@odata.type": "microsoft.graph.protectionPolicyArtifactCount"},
  "retentionSettings": [{"@odata.type": "microsoft.graph.retentionSetting"}],
  "status": "String"
}