Тип ресурса retentionLabel
Пространство имен: microsoft.graph.security
Важно!
API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Представляет, как организации в целях обеспечения соответствия требованиям и управления могут управлять своими данными на уровне элемента (электронной почты или документа), включая срок хранения или удаления элемента.
Организации могут использовать метки хранения для разных типов контента, для которых требуются разные параметры хранения. Например, они могут применять метку хранения к налоговым формам и подтверждающим документам, чтобы сохранить их в течение периода, требуемого законодательством.
Организации могут настраивать метки хранения с учетом периодов хранения и действий на основе таких факторов, как дата последнего изменения или создания. Они также могут запускать различные периоды хранения, указывая событие, которое может активировать хранение при возникновении события.
Дополнительные сведения о том, как работают метки хранения, когда их использовать и как Microsoft Purview поддерживает метки хранения, позволяющие настраивать параметры хранения и удаления, см. в статье Сведения о политиках хранения и метках хранения.
Методы
| Метод | Тип возвращаемых данных | Описание |
|---|---|---|
| Перечисление меток хранения | Коллекция microsoft.graph.security.retentionLabel | Получение списка объектов retentionLabel и их свойств. |
| Создание retentionLabel | microsoft.graph.security.retentionLabel | Создайте объект retentionLabel . |
| Получение retentionLabel | microsoft.graph.security.retentionLabel | Чтение свойств и связей объекта retentionLabel . |
| Обновление retentionLabel | microsoft.graph.security.retentionLabel | Обновите свойства объекта retentionLabel . |
| Удаление retentionLabel | Нет | Удаление объекта retentionLabel . |
| List retentionEventType | Коллекция microsoft.graph.security.retentionEventType | Получите ресурсы retentionEventType из свойства навигации eventType exapnd. |
| Добавление retentionEventType | microsoft.graph.security.retentionEventType | Добавьте eventType, добавив соответствующее свойство odata при создании метки. |
Свойства
| Свойство | Тип | Описание |
|---|---|---|
| actionAfterRetentionPeriod | microsoft.graph.security.actionAfterRetentionPeriod | Указывает действие, выполняемое с документом с метками по истечении срока, указанного свойством retentionDuration. Допустимые значения: none, delete, startDispositionReview, unknownFutureValue. |
| behaviorDuringRetentionPeriod | microsoft.graph.security.behaviorDuringRetentionPeriod | Указывает поведение документа с этой меткой в течение периода хранения. Допустимые значения: doNotRetain, retain, retainAsRecord, retainAsRegulatoryRecord, unknownFutureValue. |
| createdBy | microsoft.graph.identitySet | Представляет пользователя, создавшего retentionLabel. |
| createdDateTime | DateTimeOffset | Представляет дату и время создания retentionLabel. |
| descriptionForAdmins | String | Предоставляет сведения о метки для администратора. Необязательный. |
| descriptionForUsers | String | Предоставляет сведения о метки для пользователя. Необязательный параметр. |
| displayName | String | Уникальная строка, определяющая имя метки. |
| id | String | Уникальный идентификатор retentionLabel. |
| isInUse | Логический | Указывает, используется ли метка в настоящее время. |
| lastModifiedBy | microsoft.graph.identitySet | Пользователь, который в последний раз изменял retentionLabel. |
| lastModifiedDateTime | DateTimeOffset | Последняя дата изменения retentionLabel. |
| retentionDuration | microsoft.graph.security.retentionDuration | Указывает количество дней хранения содержимого. |
| retentionTrigger | microsoft.graph.security.retentionTrigger | Указывает, вычисляется ли длительность хранения с даты создания контента, даты с меткой или даты последнего изменения. Допустимые значения: dateLabeled, dateCreated, dateModified, dateOfEvent, unknownFutureValue. |
| defaultRecordBehavior | microsoft.graph.security.defaultRecordBehavior | Указывает заблокированное или разблокированное состояние метки записи при ее создании. Возможные значения: startLocked, startUnlocked, unknownFutureValue. |
| labelToBeApplied | String | Указывает метку замены, применяемую автоматически после окончания срока хранения текущей метки. |
Связи
| Связь | Тип | Описание |
|---|---|---|
| dispositionReviewStages | коллекция microsoft.graph.security.dispositionReviewStage | Если действие в конце срока хранения выбрано как "dispositionReview", dispositionReviewStages задает последовательный набор этапов с по крайней мере одним проверяющим на каждом этапе. |
| retentionEventType | microsoft.graph.security.retentionEventType | Представляет тип, связанный с событием хранения. |
| Дескрипторы | microsoft.graph.security.filePlanDescriptor | Представляет встроенные значения, предоставляющие дополнительные возможности для улучшения управляемости и организации содержимого, необходимого для маркировки. |
Представление JSON
В следующем представлении JSON показан тип ресурса.
{
"@odata.type": "#microsoft.graph.security.retentionLabel",
"id": "String (identifier)",
"displayName": "String",
"behaviorDuringRetentionPeriod": "String",
"actionAfterRetentionPeriod": "String",
"retentionTrigger": "String",
"retentionDuration": {
"@odata.type": "microsoft.graph.security.retentionDuration"
},
"isInUse": "Boolean",
"descriptionForAdmins": "String",
"descriptionForUsers": "String",
"createdBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"createdDateTime": "String (timestamp)",
"lastModifiedBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"lastModifiedDateTime": "String (timestamp)",
"labelToBeApplied": "String",
"defaultRecordBehavior": "String"
}