New-RetentionComplianceRule
Este cmdlet está disponible solo en Security & Compliance PowerShell. Para obtener más información, consulte Security & Compliance PowerShell.
Use el cmdlet New-RetentionComplianceRule para crear nuevas reglas de retención en el portal de cumplimiento Microsoft Purview.
Para obtener más información acerca de los conjuntos de parámetros de la sección Sintaxis a continuación, vea Sintaxis del cmdlet de Exchange.
Sintaxis
New-RetentionComplianceRule
-ApplyComplianceTag <String>
-Policy <PolicyIdParameter>
[-ContentContainsSensitiveInformation <PswsHashtable[]>]
[-Confirm]
[-ContentMatchQuery <String>]
[-ExpirationDateOption <String>]
[-IRMRiskyUserProfiles <String>]
[-MachineLearningModelIDs <MultiValuedProperty>]
[-PriorityCleanup]
[-RetentionComplianceAction <String>]
[-WhatIf]
[<CommonParameters>] New-RetentionComplianceRule
[-Name] <String>
-Policy <PolicyIdParameter>
[-Comment <String>]
[-ExcludedItemClasses <MultiValuedProperty>]
[-RetentionDuration <Unlimited>]
[-RetentionDurationDisplayHint <HoldDurationHint>]
[-Confirm]
[-ContentMatchQuery <String>]
[-ExpirationDateOption <String>]
[-PriorityCleanup]
[-RetentionComplianceAction <String>]
[-WhatIf]
[<CommonParameters>] New-RetentionComplianceRule
-Policy <PolicyIdParameter>
-PublishComplianceTag <String>
[-Confirm]
[-ExpirationDateOption <String>]
[-PriorityCleanup]
[-RetentionComplianceAction <String>]
[-WhatIf]
[<CommonParameters>] Description
La regla de retención debe agregarse a una directiva de retención existente mediante el parámetro Policy. Solo se puede agregar una regla a cada directiva de retención.
Para usar este cmdlet en Security & Compliance PowerShell, debe tener asignados permisos. Para obtener más información vea Permisos en el portal de cumplimiento de Microsoft Purview.
Ejemplos
Ejemplo 1
New-RetentionComplianceRule -Name InternalCompanyRule -Policy "Internal Company Policy" -RetentionDuration UnlimitedEn este ejemplo se crea una nueva regla de suspensión de casos denominada InternalCompanyRule y se agrega a la directiva de retención de casos existente denominada "Directiva de empresa interna". El contenido se conservará indefinidamente.
Ejemplo 2
New-RetentionComplianceRule -Name SeptOneYear -Policy "Internal Company Policy" -RetentionDuration 365 -RetentionComplianceAction KeepAndDelete -ExpirationDateOption ModificationAgeInDaysEn este ejemplo se crea una nueva regla de retención denominada SeptOneYear y se agrega a la directiva de retención existente denominada "Directiva de empresa interna". El contenido se conservará durante un año a partir del día en que el contenido se modificó por última vez antes de eliminarse.
Parámetros
-ApplyComplianceTag
El parámetro ApplyComplianceTag especifica la etiqueta que se aplica a mensajes de correo electrónico o documentos de la regla (que afecta a cuánto tiempo se conserva el contenido). Un valor válido para este parámetro sería el nombre de una etiqueta existente. Si el valor contiene espacios, escríbalo entre comillas.
Ver y crear etiquetas utilizando los cmdlets Get-ComplianceTag y New-ComplianceTag.
No puede usar este parámetro con los parámetros Name o PublishComplianceTag.
No puede usar este parámetro para las reglas de retención de Teams.
| Tipo: | String |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | True |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | False |
| Se aplica a: | Security & Compliance |
-Comment
El parámetro Comment especifica un comentario opcional. Si especifica un valor que contenga espacios, escríbalo entre comillas ("), por ejemplo: "Esto es una nota del administrador".
| Tipo: | String |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | False |
| Se aplica a: | Security & Compliance |
-Confirm
El modificador Confirm especifica si se debe mostrar u ocultar el mensaje de confirmación. Cómo afecta este modificador el cmdlet depende de si el cmdlet requiere confirmación antes de continuar.
- Los cmdlets destructivos (por ejemplo, los cmdlets Remove-*) tienen una pausa integrada que obliga a confirmar el comando antes de continuar. Para estos cmdlets, puede omitir el mensaje de confirmación mediante esta sintaxis exacta:
-Confirm:$false. - La mayoría de los otros cmdlets (por ejemplo, New-* y Set-*) no tienen una pausa integrada. En estos cmdlets, si se especifica el modificador Confirm sin ningún valor, se introduce una pausa que obliga a confirmar el comando antes de continuar.
| Tipo: | SwitchParameter |
| Alias: | cf |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | False |
| Se aplica a: | Security & Compliance |
-ContentContainsSensitiveInformation
El parámetro ContentContainsSensitiveInformation especifica una condición para la regla que se basa en una coincidencia de tipo de información confidencial en el contenido. La regla se aplica al contenido que incluye el tipo especificado de información confidencial.
Este parámetro usa la sintaxis básica @(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...). Por ejemplo, @(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"}).
Use el cmdlet Get-DLPSensitiveInformationType para enumerar los tipos de información confidencial de su organización. Para obtener más información sobre los tipos de información confidencial, consulte Qué buscan los tipos de información confidencial de Exchange.
Puede usar este parámetro con el parámetro ApplyComplianceTag.
No puede usar este parámetro para las reglas de retención de Teams.
| Tipo: | PswsHashtable[] |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | False |
| Se aplica a: | Security & Compliance |
-ContentMatchQuery
El parámetro ContentMatchQuery especifica un filtro de búsqueda de contenido.
Este parámetro usa una cadena de búsqueda de texto o una consulta con formato mediante el idioma de consulta de palabra clave (KQL). Para obtener más información, vea Referencia de sintaxis del Lenguaje de consulta de palabras clave (KQL) y Consultas de palabras clave y condiciones de búsqueda para eDiscovery.
No puede usar este parámetro para las reglas de retención de Teams.
| Tipo: | String |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | False |
| Se aplica a: | Security & Compliance |
-ExcludedItemClasses
El parámetro ExcludedItemClasses especifica los tipos de mensajes que se excluirán de la regla. Este parámetro solo se puede usar para excluir elementos de una directiva de suspensión, lo que excluye la retención de la clase de elemento especificada. El uso de este parámetro no excluirá los elementos de las directivas de eliminación. Normalmente, este parámetro se usa para excluir los mensajes de correo de voz, las conversaciones de mensajería instantánea y otros Skype Empresarial contenido en línea de la retención de contenido de una directiva de suspensión. Entre los valores comunes Skype Empresarial se incluyen:
- IPM. Note.Microsoft.Conversation
- IPM. Note.Microsoft.Conversation.Voice
- IPM. Note.Microsoft.Missed
- IPM. Note.Microsoft.Missed.Voice
- IPM. Note.Microsoft.Voicemail
- IPM.Note.Microsoft.VoiceMessage.UA
- IPM. Note.Microsoft.Voicemail.UM
- IPM.Note.Microsoft.Voicemail.UM.CA
Además, puede especificar clases de mensaje para elementos de Exchange y clases de mensajes personalizadas o de terceros. Tenga en cuenta que los valores especificados no se validan, por lo que el parámetro acepta cualquier valor de texto.
Puede especificar varios valores de clase de elemento mediante la sintaxis siguiente: "Value1","Value2",..."ValueN".
No puede usar este parámetro para las reglas de retención de Teams.
| Tipo: | MultiValuedProperty |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | False |
| Se aplica a: | Security & Compliance |
-ExpirationDateOption
El parámetro ExpirationDateOption especifica si la fecha de expiración se calcula a partir de la fecha de creación del contenido o de la fecha de última modificación. Los valores admitidos son:
- CreationAgeInDays
- ModificationAgeInDays
No puede usar este parámetro para las reglas de retención de Teams.
| Tipo: | String |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | False |
| Se aplica a: | Security & Compliance |
-IRMRiskyUserProfiles
{{ Fill IRMRiskyUserProfiles Description }}
| Tipo: | String |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | False |
| Se aplica a: | Security & Compliance |
-MachineLearningModelIDs
Este parámetro está reservado para uso interno de Microsoft.
| Tipo: | MultiValuedProperty |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | False |
| Se aplica a: | Security & Compliance |
-Name
El parámetro Name especifica un nombre único para la regla de retención. Si el valor contiene espacios, escríbalo entre comillas.
No puede usar este parámetro con los parámetros ApplyComplianceTag o PublishComplianceTag.
| Tipo: | String |
| Posición: | 1 |
| Valor predeterminado: | None |
| Requerido: | True |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | False |
| Se aplica a: | Security & Compliance |
-Policy
El parámetro Policy especifica la directiva que debe contener la regla.
| Tipo: | PolicyIdParameter |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | True |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | False |
| Se aplica a: | Security & Compliance |
-PriorityCleanup
{{ Fill PriorityCleanup Description }}
| Tipo: | SwitchParameter |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | False |
| Se aplica a: | Security & Compliance |
-PublishComplianceTag
El parámetro PublishComplianceTag especifica la etiqueta que se publica para la regla, lo que hace que la etiqueta sea visible para los usuarios de las aplicaciones (por ejemplo, Outlook, SharePoint y OneDrive). Un valor válido para este parámetro sería el nombre de una etiqueta existente. Si el valor contiene espacios, escríbalo entre comillas.
Ver y crear etiquetas utilizando los cmdlets Get-ComplianceTag y New-ComplianceTag.
No puede usar este parámetro en los escenarios siguientes:
- Con los parámetros Name o ApplyComplianceTag.
- Para las reglas de retención de Teams.
- Con directivas de datos adjuntos en la nube.
| Tipo: | String |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | True |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | False |
| Se aplica a: | Security & Compliance |
-RetentionComplianceAction
El parámetro RetentionComplianceAction especifica la acción de retención de la regla. Los valores admitidos son:
- Eliminar
- Conservar
- KeepAndDelete
Si no usa este parámetro, la directiva de retención se crea como una directiva "UniH" en lugar de una directiva "mbx".
| Tipo: | String |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | False |
| Se aplica a: | Security & Compliance |
-RetentionDuration
El parámetro RetentionDuration especifica la duración de la suspensión de la regla de retención. Los valores admitidos son:
- Entero: duración de retención en días.
- Ilimitado: el contenido se mantiene indefinidamente.
| Tipo: | Unlimited |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | False |
| Se aplica a: | Security & Compliance |
-RetentionDurationDisplayHint
El parámetro RetentionDurationDisplayHint especifica las unidades que se usan para mostrar la duración de retención en el portal de cumplimiento Microsoft Purview. Los valores admitidos son:
- Días
- Meses
- Años
Por ejemplo, si este parámetro se establece en el valor Years y el parámetro RetentionDuration se establece en el valor 365, el portal de cumplimiento Microsoft Purview mostrará 1 año como duración de retención de contenido.
No puede usar este parámetro para las reglas de retención de Teams.
| Tipo: | HoldDurationHint |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | False |
| Se aplica a: | Security & Compliance |
-WhatIf
El modificador WhatIf no funciona en Security & Compliance PowerShell.
| Tipo: | SwitchParameter |
| Alias: | wi |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | False |
| Se aplica a: | Security & Compliance |