retentionLabelSettings 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.
Groups all the compliance retention restrictions on the item into a single structure.
Properties
Property | Type | Description |
---|---|---|
behaviorDuringRetentionPeriod | microsoft.graph.security.behaviorDuringRetentionPeriod | Describes the item behavior during retention period. Possible values are: doNotRetain , retain , retainAsRecord , retainAsRegulatoryRecord , unknownFutureValue . Read-only. |
isContentUpdateAllowed | Boolean | Specifies whether updates to document content are allowed. Read-only. |
isDeleteAllowed | Boolean | Specifies whether the document deletion is allowed. Read-only. |
isLabelUpdateAllowed | Boolean | Specifies whether you're allowed to change the retention label on the document. Read-only. |
isMetadataUpdateAllowed | Boolean | Specifies whether updates to the item metadata (for example, the Title field) are blocked. Read-only. |
isRecordLocked | Boolean | Specifies whether the item is locked. Read-write. |
JSON representation
The following JSON representation shows the resource type.
{
"behaviorDuringRetentionPeriod": "String",
"isContentUpdateAllowed": "Boolean",
"isDeleteAllowed": "Boolean",
"isLabelUpdateAllowed": "Boolean",
"isMetadataUpdateAllowed": "Boolean",
"isRecordLocked": "Boolean"
}