Edit

exchangeProtectionPolicy resource type

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 the plan defined by the Exchange Online Admin to protect Exchange Online. The Exchange protection policy defines what mailbox data to protect, when to protect it, and for what time period to retain the protected data.

Inherits from protectionPolicyBase.

Methods

Method Return type Description
Create exchangeProtectionPolicy Create a new exchangeProtectionPolicy.
Update exchangeProtectionPolicy Update the properties of an exchangeProtectionPolicy.
List mailbox exclusion units mailboxExclusionUnit collection Get a list of mailbox exclusion units associated with an Exchange protection policy.
Get mailbox exclusion unit mailboxExclusionUnit Get a mailbox exclusion unit associated with an Exchange protection policy.
List mailbox exclusion units bulk addition jobs mailboxExclusionUnitsBulkAdditionJob collection Get a list of mailbox exclusion units bulk addition jobs associated with an Exchange protection policy.
Create mailbox exclusion units bulk addition job mailboxExclusionUnitsBulkAdditionJob Create a mailbox exclusion units bulk addition job for an Exchange protection policy.
Get mailbox exclusion units bulk addition job mailboxExclusionUnitsBulkAdditionJob Get a mailbox exclusion units bulk addition job associated with an Exchange protection policy.

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 Name of the policy to be 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 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.
protectionMode backupPolicyProtectionMode The backup mode for the protection policy. The possible values are: standard, fullServiceBackup, unknownFutureValue. When set to fullServiceBackup, the entire workload is backed up and specific mailboxes can be excluded using exclusion units. When set to standard, only the mailboxes explicitly added as protection units are backed up. 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. This value is an 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
mailboxExclusionUnits mailboxExclusionUnit collection The mailbox exclusion units associated with the Exchange protection policy.
mailboxExclusionUnitsBulkAdditionJobs mailboxExclusionUnitsBulkAdditionJob collection The list of bulk addition jobs for mailbox exclusion units associated with the Exchange protection policy.
mailboxInclusionRules mailboxProtectionRule collection The rules associated with the Exchange protection policy.
mailboxProtectionUnits mailboxProtectionUnit collection The protection units (mailboxes) that are protected under the Exchange protection policy.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.exchangeProtectionPolicy",
  "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)",
  "protectionMode": "String",
  "protectionPolicyArtifactCount": {"@odata.type": "microsoft.graph.protectionPolicyArtifactCount"},
  "retentionSettings": [{"@odata.type": "microsoft.graph.retentionSetting"}],
  "status": "String"
}
  • Last updated on