protectionPolicyBase resource type

Article
05/31/2024

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.

Contains details about protection policies applied to Microsoft 365 data in an organization. Protection policies are defined by the Global Admin (or the SharePoint Online Admin or Exchange Online Admin) and 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.

Base type for sharePointProtectionPolicy, exchangeProtectionPolicy, and onedriveForBusinessProtectionPolicy.

Methods

Method	Return type	Description
List	protectionPolicyBase collection	Get a list of the protectionPolicyBase and their properties.
Get	protectionPolicyBase	Read the properties and relationships of a protectionPolicyBase.
Delete	None	Delete a protectionPolicyBase.
Activate	protectionPolicyBase	Activate an inactive protection policy.
Deactivate	protectionPolicyBase	Deactivate an active protection policy.

Properties

Property	Type	Description
id	String	The unique identifier of the protection rule associated with the policy.
displayName	String	The name of the policy to be created.
createdDateTime	DateTimeOffset	The time of creation of the policy.
createdBy	identitySet	The identity of person who created the policy.
lastModifiedBy	identitySet	The identity of the person who last modified the policy.
lastModifiedDateTime	DateTimeOffset	The timestamp of the last modification of the policy.
retentionSettings	retentionSetting collection	Contains the retention setting details for the policy.
status	protectionPolicyStatus	The aggregated status of the protection units associated with the policy. The possible values are: `inactive`, `activeWithErrors`, `updating`, `active`, `unknownFutureValue`.

protectionPolicyStatus values

Member	Description
active	All units are protected.
activeWithErrors	Some units are protected and others are unprotected.
inactive	All units are unprotected.
updating	Some or all units are in a `protectRequested`, `unprotectRequested`, or `removeRequested` state.
unknownFutureValue	Evolvable enumeration sentinel value. Don't use.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

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

Share via