Skip to content

mailboxprotectionunit.md

Latest commit

 

History

History
82 lines (72 loc) · 4.97 KB

mailboxprotectionunit.md

File metadata and controls

82 lines (72 loc) · 4.97 KB
title mailboxProtectionUnit resource type
description Represents an Exchange mailbox that has an Exchange protection policy applied.
author tushar20
ms.reviewer manikantsinghms
ms.localizationpriority medium
ms.subservice m365-backup-storage
doc_type resourcePageType
ms.date 05/30/2024

mailboxProtectionUnit resource type

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Represents an Exchange mailbox that has an Exchange protection policy applied.

Inherits from protectionUnitBase.

Methods

Method Return type Description
List mailboxProtectionUnit collection Get a list of the mailboxProtectionUnit objects and their properties.
Update mailboxProtectionUnit Update the properties of a mailboxProtectionUnit object.

Properties

Property Type Description
backupRetentionPeriodInDays Int32 The retention period of the backup, in days. Inherited from protectionUnitBase.
billingPolicyId String The unique identifier of the billing policy assigned to the protection unit for cost allocation. Inherited from protectionUnitBase.
createdBy identitySet The identity of person who created the protection unit. Inherited from protectionUnitBase.
createdDateTime DateTimeOffset The time of creation of the protection unit. Inherited from protectionUnitBase.
directoryObjectId String The ID of the directory object.
displayName String Display name of the directory object.
email String Email address associated with the directory object.
error publicError Contains error details if enabling or disabling the protection unit fails. Inherited from protectionUnitBase.
id String Unique identifier of the protection policy associated with this protection unit.
lastModifiedBy identitySet The identity of person who last modified the protection unit. Inherited from protectionUnitBase.
lastModifiedDateTime DateTimeOffset The time the protection unit was last modified. Inherited from protectionUnitBase.
mailboxType mailboxType The type of mailbox which is assigned to the user with id: directoryObjectId.The possible values are: unknown, user, shared, unknownFutureValue.
policyId String Unique identifier of the protection policy associated with this protection unit. Inherited from protectionUnitBase.
protectionSources protectionSource Indicates the sources by which a protection unit is currently protected. A protection unit protected by multiple sources is indicated by comma-separated values. The possible values are: none, manual, dynamicRule, unknownFutureValue. Inherited from protectionUnitBase.
status protectionUnitStatus The individual enablement/disablement/removal status of the protection unit. Inherited from protectionUnitBase. The possible values are: protectRequested, protected, unprotectRequested, unprotected, removeRequested, offboardRequested, offboarded, cancelOffboardRequested, unknownFutureValue.
offboardRequestedDateTime DateTimeOffset The time when protection unit offboard was requested. Inherited from protectionUnitBase.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.mailboxProtectionUnit",
  "backupRetentionPeriodInDays": "Int32",
  "billingPolicyId": "String",
  "createdBy": {"@odata.type": "microsoft.graph.identitySet"},
  "createdDateTime": "String (timestamp)",
  "directoryObjectId": "String",
  "displayName": "String",
  "email": "String",
  "error": {"@odata.type": "microsoft.graph.publicError"},
  "id": "String (identifier)",
  "lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"},
  "lastModifiedDateTime": "String (timestamp)",
  "mailboxType": "String",
  "offboardRequestedDateTime": "String (timestamp)",
  "policyId": "String",
  "protectionSources": "String",
  "status": "String"
}