Iniciar la retención cuando se produzca un evento

Instrucciones de licencias de Microsoft 365 para la seguridad y el cumplimiento.

Al conservar contenido, el período de retención suele basarse en la antigüedad del contenido. Por ejemplo, puede conservar documentos durante siete años después de su creación y eliminarlos cuando transcurra ese período. Pero cuando configura etiquetas de retención, también puede hacer que un período de retención se base en el momento en que se produzca un tipo específico de evento. El evento desencadena el inicio del período de retención y se exigirán las acciones de retención de etiqueta en todo el contenido que tenga aplicada una etiqueta de retención para ese tipo de evento.

Ejemplos de uso de retención basada en eventos:

  • Empleados que abandonen la organización Imagine que necesita conservar los registros de los empleados durante 10 años desde el momento en que un empleado abandona la organización. Una vez transcurridos los 10 años, tendrán que eliminarse todos los documentos relacionados con la contratación, desempeño y terminación de ese empleado. El evento que desencadena el período de retención de 10 años es cuando el empleado abandona la organización.

  • Expiración del contrato Imagine que todos los registros relacionados con los contratos tienen que conservarse durante cinco años desde el momento en que expire el contrato. El evento que desencadena el período de retención de cinco años es la expiración del contrato.

  • Vida útil del producto Puede que su organización tenga requisitos de retención relacionados con la última fecha de fabricación de productos para contenido como especificaciones técnicas. En ese caso, la última fecha de fabricación es el evento que desencadena el período de retención.

La retención basada en eventos suele usarse como parte de un proceso de administración de registros. Esto quiere decir que:

  • Las etiquetas de retención basadas en eventos también suelen marcar elementos como un registro, como parte de una solución de administración de registros. Para obtener más información, vea Información sobre la administración de registros.

  • Un documento que se ha declarado como un registro, pero cuyo desencadenador de eventos aún no se ha producido, se conserva de manera indefinida (los registros no se pueden eliminar de forma permanente), hasta que un evento desencadene el período de retención del documento.

  • Las etiquetas de retención basadas en eventos suelen desencadenar una revisión para eliminación al finalizar el período de retención, por lo que un administrador de registros puede revisar y eliminar el contenido de forma manual. Para más información, vea Eliminación de contenido.

Una etiqueta de retención basada en un evento tiene las mismas capacidades que cualquier etiqueta de retención en Microsoft 365. Para obtener más información, vea Más información sobre las directivas de retención y las etiquetas de retención.

Información sobre la relación entre tipos de evento, etiquetas, eventos e id. de activo

Para usar correctamente la retención basada en eventos, es importante comprender la relación entre tipos de evento, etiquetas de retención, eventos e id. de activos, tal como se muestra en los diagramas y en la siguiente explicación:

Diagrama 1 de 2: tipo de evento, etiquetas, eventos e id. de activos.

Diagrama 2 de 2: tipo de evento, etiquetas, eventos e id. de activos.

  1. Las etiquetas de retención se crean para distintos tipos de contenido y, después, se asocian con un tipo de evento. Por ejemplo, las etiquetas de retención para distintos tipos de registros y archivos de producto se asocian con un tipo de evento denominado “Vida útil del producto”, ya que esos registros tienen que conservarse durante 10 años desde el momento en que el producto alcanza el final de su ciclo de vida.

  2. Los usuarios (normalmente administradores de registros) aplican esas etiquetas de retención al contenido y (para los documentos en SharePoint y OneDrive) escriben un identificador de activo para cada elemento. En este ejemplo, el identificador de recurso es un nombre de producto o código usado por la organización. A continuación, a los registros de cada producto se les asigna una etiqueta de retención y cada registro tiene una propiedad que contiene un identificador de activo. El diagrama representa todo el contenido para todos los registros de productos de una organización y cada elemento contiene el identificador de activo del producto a cuyo registro pertenece.

  3. La vida útil del producto es el tipo de evento; un producto específico que llega al fin de su ciclo de vida es un evento. Cuando se produce este tipo de evento (en este caso, cuando un producto alcanza el fin de su ciclo de vida), creará un evento que especifique lo siguiente:

    • Un id. de activo (para documentos de OneDrive y SharePoint)

    • Palabras clave (para elementos de Exchange). En este ejemplo, la organización usa un código de producto en mensajes que contengan registros de productos, para que la palabra clave de los elementos de Exchange coincida con el id. de activo para documentos de OneDrive y SharePoint.

    • La fecha en que se produjo el evento. La fecha se usa como el inicio del período de retención. Esta fecha puede ser la fecha actual, una fecha pasada o una fecha futura.

  4. Después de crear un evento, esa fecha del evento se sincroniza con todo el contenido que tenga una etiqueta de retención para ese tipo de evento y que contenga la palabra clave o el Id. de activo especificado. Al igual que con cualquier etiqueta de retención, esta sincronización puede tardar hasta siete días. En el diagrama anterior, este evento desencadena el período de retención de todos los elementos rodeados con un círculo rojo. Es decir, cuando este producto alcanza el final de su ciclo de vida, el evento desencadena el período de retención para esos registros del producto.

Es importante comprender que si no especifica un identificador de activo o palabras clave para un evento, todo el contenido con una etiqueta de retención de ese tipo de evento tendrá su período de retención desencadenado por el evento. Esto significa que, en el diagrama anterior, todo el contenido empezaría a conservarse. Es posible que esto no sea lo que pretende.

Por último, recuerde que cada etiqueta de retención tiene su propia configuración de retención. En este ejemplo, todas especifican 10 años, pero puede que un evento desencadene etiquetas de retención donde cada etiqueta tenga un período de retención distinto.

Configurar la retención controlada por eventos

Flujo de trabajo general para la retención controlada por eventos:

Diagrama del flujo de trabajo para configurar la retención controlada por eventos.

Sugerencia

Vea Usar las etiquetas de retención para administrar el ciclo de vida de los documentos almacenados en SharePoint para más información sobre cómo usar las propiedades administradas en SharePoint para aplicar automáticamente las etiquetas de retención e implementar la retención basada en eventos.

Paso 1: Crear una etiqueta cuyo período de retención se base en un evento

Para crear y configurar la etiqueta de retención, consulte las instrucciones para Crear etiquetas de retención. Pero específica de la retención basada en eventos, en la Definir la configuración de retención página del Asistente para crear etiquetas de retención, después de Iniciar el período de retención basado en, seleccione uno de los tipos de eventos predeterminados de la lista desplegable o cree el suyo propio seleccionando Crear nuevo tipo de evento:

Crear un nuevo tipo de evento para una etiqueta de retención.

Un tipo de evento es simplemente una descripción general de un evento al que desea asociar una etiqueta de retención.

Los tipos de sucesos predeterminados tienen (tipo de evento) después de su nombre en la lista desplegable para facilitar su identificación, y también puede ver y crear el tipo de evento desde la pestaña Administración de registros > Eventos > Administrar tipos de eventos.

La retención basada en eventos necesita una configuración de retención que:

  • Conserve el contenido.

  • Elimine el contenido automáticamente o desencadene una revisión para eliminación al finalizar el período de retención.

La retención basada en eventos suele usarse para el contenido que se declara como registro, por lo que este es un buen momento para comprobar si también es necesario seleccionar la opción que marca el contenido como registro.

Si está usando un tipo de evento existente en lugar de crear un nuevo tipo de evento, vaya al paso 3.

Nota

Después de seleccionar un tipo de evento y guardar la etiqueta de retención, el tipo de evento no se puede cambiar.

Paso 2: crear un nuevo tipo de evento para su etiqueta

Para la configuración de retención, si seleccionó Crear nuevo tipo de evento, escriba un nombre y una descripción para su tipo de evento. Luego seleccione Siguiente, Enviar y Listo.

Regrese a la página Definir la configuración de retención, para Iniciar el período de retención basado en eventos, utilice la lista desplegable para seleccionar el tipo de evento que creó.

Paso 3: Publicar o aplicar automáticamente las etiquetas de retención basadas en eventos

Al igual que las etiquetas de retención, debe publicar o aplicar automáticamente una etiqueta basada en eventos para que se aplique de forma manual o automática al contenido:

Paso 4: Escribir un id. de activo

Después de que una etiqueta basada en evento se aplica al contenido, puede especificar un Id. de activo para cada elemento. Por ejemplo, su organización podría usar:

  • Códigos de producto que puede usar para conservar contenido solo para un producto específico.

  • Códigos de proyecto que puede usar para conservar contenido solo para un proyecto específico.

  • Id. de empleado que puede usar para conservar contenido solo para una persona específica.

Id. de activo es simplemente otra propiedad de documento que está disponible en SharePoint y OneDrive. Es posible que su organización ya use otras propiedades e identificadores de documento para clasificar el contenido. Si es así, también puede usar esas propiedades y valores al crear un evento, vea el — paso 6 que se indica a continuación. Lo importante es que debe usar alguna combinación de property:value en las propiedades del documento para asociar ese elemento a un tipo de evento.

Cuadro de texto para especificar un id. de activo.

Paso 5: Crear un evento

Cuando se produzca una instancia específica de ese tipo de evento, como cuando un producto llega al final de su vida útil, vaya a la página Administración de registros > Eventos en el Centro de cumplimiento de Microsoft 365 y seleccione +Crear para crear un evento. El evento se activa al crearlo aquí.

Crear un evento para desencadenar el inicio de la retención para las etiquetas de retención basadas en eventos.

Se admiten hasta 1 millón de eventos por espacio empresarial.

Paso 6: seleccionar el mismo tipo de evento usado por la etiqueta en el paso 2

Cuando cree el evento, elija el mismo tipo de evento especificado en la configuración de la etiqueta de retención en el paso 2. Por ejemplo, si seleccionó Duración del producto como tipo de evento para la configuración de la etiqueta, seleccione Duración del producto cuando cree el evento. Solo se desencadenará el período de retención del contenido que tenga aplicadas etiquetas de retención de ese tipo de evento.

Opción en Configuración de evento para seleccionar un tipo de evento.

Por otra parte, si necesita crear un evento para múltiples etiquetas de retención que tienen diferentes tipos de eventos, seleccione la opción Elegir etiquetas existentes. Después, seleccione las etiquetas que están configuradas para los tipos de eventos que quiere asociar con este evento.

Paso 7: Escribir palabras clave o consultas para Exchange, Id. de activo para SharePoint y OneDrive

Ahora limite el ámbito del contenido. Para el contenido de Exchange, puede hacerlo especificando palabras clave o una consulta. Para el contenido de SharePoint y OneDrive, puede hacerlo especificando Identificadores de activos.

Para los elementos de Exchange, use palabras clave o una consulta que use el Lenguaje de consulta de palabras clave (KQL). Para obtener más información, vea Referencia de sintaxis del Lenguaje de consultas de palabras clave (KQL). Para obtener más información sobre las propiedades que se pueden usar para la búsqueda en Exchange, vea Consultas de palabras clave y condiciones de búsqueda para la Búsqueda de contenido.

Para los Id. de activo, la retención solo se aplicará en el contenido que tenga la combinación de propiedad:valor especificada. Por ejemplo: si usa la propiedad de Id. de activo, escriba ComplianceAssetID:<value> en el cuadro de Id. de activo que se muestra en la siguiente imagen.

Si no se especifica un Id. de activo, se aplicará la misma fecha de retención a todo el contenido con etiquetas para ese tipo de evento.

Es posible que su organización haya aplicado otras propiedades e identificadores a los documentos relacionados con este tipo de evento. Por ejemplo, si necesita detectar los registros de un producto específico, el identificador podría ser una combinación de la propiedad personalizada ProductID y el valor "XYZ". En este caso, escribiría ProductID:XYZ en el cuadro de identificadores de activo que se muestra en la siguiente imagen.

Por último, seleccione la fecha en que se produjo el evento; esta fecha se usará como el inicio del período de retención. Después de crear un evento, la fecha del evento se sincronizará con todo el contenido mediante una etiqueta de retención para ese tipo de evento, Id. de activo y consultas o palabras clave. Al igual que con cualquier etiqueta de retención, esta sincronización puede tardar hasta siete días.

Página de Configuración de evento.

Después de crear un evento, la configuración de retención surte efecto para el contenido que ya está etiquetado e indexado. Si se agrega la etiqueta de retención a contenido nuevo tras crear el evento, deberá crear un nuevo evento con los mismos detalles.

Al eliminar un evento, no se cancela la configuración de retención que está vigente en el contenido que ya está etiquetado. Para ello, cree un nuevo evento con los mismos detalles, pero deje la fecha en blanco.

Usar Búsqueda de contenido para encontrar todo el contenido que tenga aplicada una etiqueta o id. de activo específicos

Después de asignar etiquetas de retención a contenido, puede usar la búsqueda de contenido para encontrar todo el contenido clasificado con una etiqueta de retención específica o que contiene un id. de activo específico:

  • Para encontrar todo el contenido con una etiqueta de retención específica, seleccione la condición Etiqueta de retención y, después, escriba el nombre de etiqueta completo o una parte del nombre de la etiqueta y use un comodín.

  • Para encontrar todo el contenido con un id. de activo específico, escriba la propiedad ComplianceAssetID y un valor con el formato ComplianceAssetID:<value>.

Para obtener más información, consulte Consultas de palabras clave y condiciones de búsqueda para la Búsqueda de Contenido.

Automatizar eventos con PowerShell

Puede usar un script de PowerShell para automatizar la retención basada en eventos desde sus aplicaciones empresariales. Los cmdlets de PowerShell disponibles para la retención basada en eventos son:

Automatizar eventos mediante una API de REST

Puede usar una API de REST para crear automáticamente eventos que desencadenen el inicio del tiempo de retención.

Una API REST es un punto de conexión de servicio que admite conjuntos de operaciones HTTP (métodos), que proporcionan acceso de creación, recuperación, actualización o eliminación a los recursos del servicio. Para obtener más información, consulte Componentes de una solicitud o respuesta de API de REST. Mediante el uso de la API de REST de Microsoft 365, los eventos se pueden crear y recuperar mediante los métodos POST y GET.

Hay dos opciones para usar la API de REST:

  • Usar Microsoft Power Automate o una aplicación similar para desencadenar un evento automáticamente. Microsoft Power Automate es un orquestador para conectarse a otros sistemas, por lo que no tiene que escribir una solución personalizada. Para obtener más información, consulte el sitio de Power Automate.

  • Usar PowerShell o un cliente HTTP para llamar a la API de REST a fin de crear eventos con PowerShell (versión 6 o posterior), lo que forma parte de una solución personalizada.

Antes de usar la API de REST, como administrador global, confirme la dirección URL que se usará para la llamada al evento de retención. Para ello, ejecute una llamada GET al evento de retención con la dirección URL de la API de REST:

https://ps.compliance.protection.outlook.com/psws/service.svc/ComplianceRetentionEvent

Compruebe el código de respuesta. Si es 302, obtenga la dirección URL redirigida de la propiedad Ubicación del encabezado de respuesta y use esa dirección URL en lugar de https://ps.compliance.protection.outlook.com/psws/service.svc/ComplianceRetentionEvent en las instrucciones siguientes.

Los eventos que se crean automáticamente se pueden visualizar y confirmar en el Centro de cumplimiento de Microsoft 365 > Administración de registros > Eventos.

Usar Microsoft Power Automate para crear el evento

Cree un flujo que cree un evento mediante la API de REST de Microsoft 365:

Usar Flow para crear un evento.

Usar Flow para llamar a la API de REST.

Crear un evento

Código de ejemplo para llamar a la API de REST:

  • Método: POST

  • URL: https://ps.compliance.protection.outlook.com/psws/service.svc/ComplianceRetentionEvent

  • Headers: Key = Content-Type, Value = application/atom+xml

  • Body:

    <?xml version='1.0' encoding='utf-8' standalone='yes'?>
    
    <entry xmlns:d='http://schemas.microsoft.com/ado/2007/08/dataservices'
    
    xmlns:m='http://schemas.microsoft.com/ado/2007/08/dataservices/metadata'
    
    xmlns='http://www.w3.org/2005/Atom'>
    
    <category scheme='http://schemas.microsoft.com/ado/2007/08/dataservices/scheme' term='Exchange.ComplianceRetentionEvent' />
    
    <updated>9/9/2017 10:50:00 PM</updated>
    
    <content type='application/xml'>
    
    <m:properties>
    
    <d:Name>Employee Termination </d:Name>
    
    <d:EventType>99e0ae64-a4b8-40bb-82ed-645895610f56</d:EventType>
    
    <d:SharePointAssetIdQuery>1234</d:SharePointAssetIdQuery>
    
    <d:EventDateTime>2018-12-01T00:00:00Z </d:EventDateTime>
    
    </m:properties>
    
    </content>
    
    </entry>
    
  • Autenticación: Básica

  • Nombre de usuario: “Complianceuser”

  • Contraseña: “Compliancepassword”

Parámetros disponibles
Parámetros Description Notas
<d:Name></d:Name> Escriba un nombre único para el evento. No puede contener espacios finales ni los caracteres siguientes: % * \ & < > | # ? , : ;
<d:EventType></d:EventType> Escribe el nombre del tipo de evento (o Guid) Ejemplo: "Desvinculación del empleado". El tipo de evento debe estar asociado con una etiqueta de retención.
<d:SharePointAssetIdQuery></d:SharePointAssetIdQuery> Escriba "ComplianceAssetId:" + el id. del empleado Ejemplo: "ComplianceAssetId:12345"
<d:EventDateTime></d:EventDateTime> Fecha y hora del evento Formato: aaaa-MM-ddTHH:mm:ssZ, ejemplo: 2018-12-01T00:00:00Z
Códigos de respuesta
Código de respuesta Descripción
302 Redirigir
201 Fecha de creación
403 Error de autorización
401 Error de autenticación
Obtener eventos según un intervalo de tiempo
  • Método: GET

  • URL: https://ps.compliance.protection.outlook.com/psws/service.svc/ComplianceRetentionEvent?BeginDateTime=2019-01-11&EndDateTime=2019-01-16

  • Headers: Key = Content-Type, Value = application/atom+xml

  • Autenticación: Básica

  • Nombre de usuario: “Complianceuser”

  • Contraseña: “Compliancepassword”

Códigos de respuesta
Código de respuesta Descripción
200 Aceptar, una lista de eventos de atom+ xml
404 No encontrado
302 Redirigir
401 Error de autorización
403 Error de autenticación
Obtén un objeto por id.
  • Método: GET

  • URL: https://ps.compliance.protection.outlook.com/psws/service.svc/ComplianceRetentionEvent('174e9a86-74ff-4450-8666-7c11f7730f66')

  • Headers: Key = Content-Type, Value = application/atom+xml

  • Autenticación: Básica

  • Nombre de usuario: “Complianceuser”

  • Contraseña: “Compliancepassword”

Códigos de respuesta
Código de respuesta Descripción
200 Aceptar, el cuerpo de la respuesta contiene el evento en atom+ xml
404 No encontrado
302 Redirigir
401 Error de autorización
403 Error de autenticación
Obtén un evento por nombre
  • Método: GET

  • URL: https://ps.compliance.protection.outlook.com/psws/service.svc/ComplianceRetentionEvent

  • Headers: Key = Content-Type, Value = application/atom+xml

  • Autenticación: Básica

  • Nombre de usuario: “Complianceuser”

  • Contraseña: “Compliancepassword”

Códigos de respuesta
Código de respuesta Descripción
200 Aceptar, el cuerpo de la respuesta contiene el evento en atom+ xml
404 No encontrado
302 Redirigir
401 Error de autorización
403 Error de autenticación

Usar PowerShell o cualquier cliente HTTP para crear el evento

La versión de PowerShell debe ser 6 o posterior.

En una sesión de PowerShell, ejecute el siguiente script:

param([string]$baseUri)

$userName = "UserName"

$password = "Password"

$securePassword = ConvertTo-SecureString $password -AsPlainText -Force

$credentials = New-Object System.Management.Automation.PSCredential($userName, $securePassword)

$EventName="EventByRESTPost-$(([Guid]::NewGuid()).ToString('N'))"

Write-Host "Start to create an event with name: $EventName"

$body = "<?xml version='1.0' encoding='utf-8' standalone='yes'?>

<entry xmlns:d='http://schemas.microsoft.com/ado/2007/08/dataservices'

xmlns:m='http://schemas.microsoft.com/ado/2007/08/dataservices/metadata'

xmlns='http://www.w3.org/2005/Atom'>

<category scheme='http://schemas.microsoft.com/ado/2007/08/dataservices/scheme' term='Exchange.ComplianceRetentionEvent' />

<updated>7/14/2017 2:03:36 PM</updated>

<content type='application/xml'>

<m:properties>

<d:Name>$EventName</d:Name>

<d:EventType>e823b782-9a07-4e30-8091-034fc01f9347</d:EventType>

<d:SharePointAssetIdQuery>'ComplianceAssetId:123'</d:SharePointAssetIdQuery>

</m:properties>

</content>

</entry>"

$event = $null

try

{

$event = Invoke-RestMethod -Body $body -Method 'POST' -Uri "$baseUri/ComplianceRetentionEvent" -ContentType "application/atom+xml" -Authentication Basic -Credential $credentials -MaximumRedirection 0

}

catch

{

$response = $_.Exception.Response

if($response.StatusCode -eq "Redirect")

{

$url = $response.Headers.Location

Write-Host "redirected to $url"

$event = Invoke-RestMethod -Body $body -Method 'POST' -Uri $url -ContentType "application/atom+xml" -Authentication Basic -Credential $credentials -MaximumRedirection 0

}

}

$event | fl *