Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
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. |
| 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. 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)",
"protectionPolicyArtifactCount": {"@odata.type": "microsoft.graph.protectionPolicyArtifactCount"},
"retentionSettings": [{"@odata.type": "microsoft.graph.retentionSetting"}],
"status": "String"
}