mailboxProtectionUnit resource type

Article
12/26/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.

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.

Properties

Property	Type	Description
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.
status	protectionUnitStatus	The individual enable, disable, or removal status of the protection unit. Inherited from protectionUnitBase.The possible values are: `protectRequested`, `protected`, `unprotectRequested`, `unprotected`, `removeRequested`, `unknownFutureValue`.

protectionUnitStatus values

Member	Description
protectRequested	Protection of the unit was requested. Applies when a policy is activated or new units are added to an active policy.
protected	Protection was successfully enabled for the unit.
unprotectRequested	A request was made to deactivate protection for the unit.
unprotected	Protection was successfully disabled for the unit.
removeRequested	A user requested removal of the protected unit from the policy.
unknownFutureValue	Evolvable enumeration sentinel value. Do not use.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

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

Share via