tipo de recurso retentionLabel

Namespace: microsoft.graph.security

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Representa cómo las organizaciones, con fines de cumplimiento y gobernanza, pueden administrar sus datos en un nivel de elemento (correo electrónico o documento), incluido si y durante cuánto tiempo conservar o eliminar el elemento.

Las organizaciones pueden usar etiquetas de retención para diferentes tipos de contenido que requieren diferentes configuraciones de retención. Por ejemplo, pueden aplicar una etiqueta de retención a formularios fiscales y documentos auxiliares para conservarlos durante el período requerido por la ley.

Las organizaciones pueden configurar etiquetas de retención con los períodos de retención y las acciones en función de factores como la fecha de última modificación o creación. También pueden iniciar diferentes períodos de retención especificando un evento que puede desencadenar la retención cuando se produce el evento.

Para obtener más información sobre cómo funcionan las etiquetas de retención, cuándo usarlas y cómo Microsoft Purview admite etiquetas de retención para permitirle configurar las opciones de retención y eliminación, consulte Información sobre las directivas de retención y las etiquetas de retención.

Métodos

Método	Tipo devuelto	Descripción
Enumeración de retentionLabels	Colección microsoft.graph.security.retentionLabel	Obtenga una lista de los objetos retentionLabel y sus propiedades.
Creación de retentionLabel	microsoft.graph.security.retentionLabel	Cree un nuevo objeto retentionLabel .
Obtener retentionLabel	microsoft.graph.security.retentionLabel	Lea las propiedades y relaciones de un objeto retentionLabel .
Actualizar retentionLabel	microsoft.graph.security.retentionLabel	Actualice las propiedades de un objeto retentionLabel .
Eliminar retentionLabel	Ninguno	Elimine un objeto retentionLabel .
List retentionEventType	Colección microsoft.graph.security.retentionEventType	Obtenga los recursos retentionEventType de la propiedad de navegación exapnd eventType.
Agregar retentionEventType	microsoft.graph.security.retentionEventType	Agregue eventType agregando la propiedad odata pertinente al crear una etiqueta.

Propiedades

Propiedad	Tipo	Descripción
actionAfterRetentionPeriod	microsoft.graph.security.actionAfterRetentionPeriod	Especifica la acción que se va a realizar en el documento etiquetado después de que expire el período especificado por la propiedad retentionDuration. Los valores posibles son: none, delete, startDispositionReview y unknownFutureValue
behaviorDuringRetentionPeriod	microsoft.graph.security.behaviorDuringRetentionPeriod	Especifica cómo debe ser el comportamiento de un documento con esta etiqueta durante el período de retención. Los valores posibles son: doNotRetain, retain, retainAsRecord, retainAsRegulatoryRecord, unknownFutureValue.
createdBy	microsoft.graph.identitySet	Representa el usuario que creó retentionLabel.
createdDateTime	DateTimeOffset	Representa la fecha y hora en que se crea retentionLabel.
descriptionForAdmins	Cadena	Proporciona información de etiqueta para el administrador. Opcional.
descriptionForUsers	Cadena	Proporciona la información de etiqueta para el usuario. Opcional.
displayName	Cadena	Cadena única que define un nombre de etiqueta.
id	Cadena	Identificador único de retentionLabel.
isInUse	Booleano	Especifica si la etiqueta se está usando actualmente.
lastModifiedBy	microsoft.graph.identitySet	El usuario que modificó por última vez retentionLabel.
lastModifiedDateTime	DateTimeOffset	Fecha y hora más recientes en que se modificó retentionLabel.
retentionDuration	microsoft.graph.security.retentionDuration	Especifica el número de días para conservar el contenido.
retentionTrigger	microsoft.graph.security.retentionTrigger	Especifica si la duración de la retención se calcula a partir de la fecha de creación del contenido, la fecha etiquetada o la fecha de última modificación. Los valores posibles son: dateLabeled, dateCreated, dateModified, dateOfEvent, unknownFutureValue.
defaultRecordBehavior	microsoft.graph.security.defaultRecordBehavior	Especifica el estado bloqueado o desbloqueado de una etiqueta de registro cuando se crea. Los valores posibles son: startLocked, startUnlocked, unknownFutureValue.
labelToBeApplied	Cadena	Especifica la etiqueta de reemplazo que se aplicará automáticamente después de que finalice el período de retención de la etiqueta actual.

Relaciones

Relación	Tipo	Descripción
dispositionReviewStages	Colección microsoft.graph.security.dispositionReviewStage	Cuando la acción al final de la retención se elige como "dispositionReview", dispositionReviewStages especifica un conjunto secuencial de fases con al menos un revisor en cada fase.
retentionEventType	microsoft.graph.security.retentionEventType	Representa el tipo asociado a un evento de retención.
Descriptores	microsoft.graph.security.filePlanDescriptor	Representa valores integrados que proporcionan más opciones para mejorar la capacidad de administración y la organización del contenido que necesita etiquetar.

Representación JSON

La siguiente representación JSON muestra el tipo de recurso.

{
  "@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"
}