Skip to content

protectionunitbase.md

Latest commit

 

History

History
90 lines (79 loc) · 4.5 KB

protectionunitbase.md

File metadata and controls

90 lines (79 loc) · 4.5 KB
title protectionUnitBase resource type
description Represents a site, drive, or mailbox that's protected by a protection policy.
author tushar20
ms.reviewer manikantsinghms
ms.localizationpriority medium
ms.subservice m365-backup-storage
doc_type resourcePageType
toc.title Protection unit
ms.date 08/24/2024

protectionUnitBase resource type

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Represents a site, drive, or mailbox that's protected by a protection policy. All the protection units in a protection policy have the same retention period by default.

This resource is an abstract type.

Inherits from entity.

Methods

Method Return type Description
Get protectionUnitBase Read the properties and relationships of a protectionUnitBase object.
Offboard protectionUnitBase Offboard a protectionUnitBase.
Cancel offboard protectionUnitBase Cancel the offboarding of a protectionUnitBase.

Properties

Property Type Description
backupRetentionPeriodInDays Int32 The retention period of the backup, in days.
billingPolicyId String The unique identifier of the billing policy assigned to the protection unit for cost allocation.
createdBy identitySet The identity of person who created the protection unit.
createdDateTime DateTimeOffset The time of creation of the protection unit.
error publicError Contains error details if an error occurred while creating a protection unit.
id String The unique identifier of the protection unit. Inherited from entity.
lastModifiedBy identitySet The identity of person who last modified the protection unit.
lastModifiedDateTime DateTimeOffset Timestamp of the last modification of this protection unit.
policyId String The unique identifier of the protection policy based on which protection unit was created.
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.
status protectionUnitStatus The status of the protection unit. The possible values are: protectRequested, protected, unprotectRequested, unprotected, removeRequested, unknownFutureValue.
offboardRequestedDateTime DateTimeOffset The time when protection unit offboard was requested.

protectionUnitStatus values

Member Description
protectRequested Protection of the unit was requested.
protected The protection unit is successfully enabled.
unprotectRequested Disabling protection of the unit was requested.
unprotected The protection unit is successfully disabled.
removeRequested A request to remove the protected unit from the policy was made.
offboardRequested A request to offboard the protection unit.
offboarded The protection unit is successfully offboarded.
cancelOffboardRequested A request to cancel protection unit offboarding.
unknownFutureValue Evolvable enumeration sentinel value. Don't use.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

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