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 a plan defined by the SharePoint Online admin to protect SharePoint Online, including what data to protect, when to protect it, and for what time period to retain the protected data. Currently, policies are supported only for SharePoint Online sites in the main geolocation only; multi-geo tenants aren't supported.
Inherits from protectionPolicyBase.
Methods
| Method | Return type | Description |
|---|---|---|
| Create | sharePointProtectionPolicy | Create a new sharePointProtectionPolicy. |
| Update | sharePointProtectionPolicy | Update the properties of a sharePointProtectionPolicy. |
Properties
| Property | Type | Description |
|---|---|---|
| createdBy | identitySet | The identity of 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 being created. Inherited from protectionPolicyBase. |
| id | String | The unique identifier of the protection rule associated to the policy. Inherited from protectionPolicyBase. |
| isEnabled | Boolean | Indicates whether the policy is enabled. Inherited from protectionPolicyBase. |
| lastModifiedBy | identitySet | The identity of person who 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 | Retention settings for the policy. Inherited from protectionPolicyBase. |
| status | protectionPolicyStatus | The status of the policy. The value is an aggregated status of the protection units. The possible values are: inactive, activeWithErrors, updating, active, unknownFutureValue. Inherited from protectionPolicyBase. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| siteInclusionRules | siteProtectionRule collection | The rules associated with the SharePoint Protection policy. |
| siteProtectionUnits | siteProtectionUnit collection | The protection units (sites) that are protected under the site protection policy. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.sharePointProtectionPolicy",
"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"
}