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
ComplianceTag
New-RetentionComplianceRule
-ApplyComplianceTag <String>
-Policy <PolicyIdParameter>
[-ContentContainsSensitiveInformation <PswsHashtable[]>]
[-Confirm]
[-ContentMatchQuery <String>]
[-ExpirationDateOption <String>]
[-IRMRiskyUserProfiles <String>]
[-MachineLearningModelIDs <MultiValuedProperty>]
[-PriorityCleanup]
[-RetentionComplianceAction <String>]
[-WhatIf]
[<CommonParameters>]
Default
New-RetentionComplianceRule
[-Name] <String>
-Policy <PolicyIdParameter>
[-Comment <String>]
[-ExcludedItemClasses <MultiValuedProperty>]
[-RetentionDuration <Unlimited>]
[-RetentionDurationDisplayHint <HoldDurationHint>]
[-Confirm]
[-ContentMatchQuery <String>]
[-ExpirationDateOption <String>]
[-PriorityCleanup]
[-RetentionComplianceAction <String>]
[-WhatIf]
[<CommonParameters>]
PublishComplianceTag
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 Unlimited -RetentionComplianceAction Keep
En este ejemplo se crea una nueva regla de suspensión de retención denominada InternalCompanyRule y se agrega a la directiva de retención de retención existente denominada "Directiva interna de la empresa". El contenido se mantiene indefinidamente.
Ejemplo 2
New-RetentionComplianceRule -Name SeptOneYear -Policy "Internal Company Policy" -RetentionDuration 365 -RetentionComplianceAction KeepAndDelete -ExpirationDateOption ModificationAgeInDays
En este ejemplo se crea una nueva regla de retención denominada SeptOneYear y se agrega a la directiva de retención existente denominada "Directiva interna de la empresa". El contenido se conserva durante un año a partir del día en que se modificó por última vez antes de eliminarse.
Parámetros
-ApplyComplianceTag
Aplicable: Seguridad & cumplimiento
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.
Propiedades de parámetro
| Tipo: | String |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
ComplianceTag
| Posición: | Named |
| Obligatorio: | True |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-Comment
Aplicable: Seguridad & cumplimiento
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".
Propiedades de parámetro
| Tipo: | String |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
Default
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-Confirm
Aplicable: Seguridad & cumplimiento
El modificador Confirm especifica si se debe mostrar u ocultar el mensaje de confirmación. Cómo afecta este modificador al 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. Para estos cmdlets, especificar el modificador Confirm sin un valor introduce una pausa que le obliga a reconocer el comando antes de continuar.
Propiedades de parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
| Alias: | cf |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-ContentContainsSensitiveInformation
Aplicable: Seguridad & cumplimiento
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.
Propiedades de parámetro
| Tipo: | PswsHashtable[] |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
ComplianceTag
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-ContentMatchQuery
Aplicable: Seguridad & cumplimiento
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 por palabra 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.
Propiedades de parámetro
| Tipo: | String |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
ComplianceTag
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
Default
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-ExcludedItemClasses
Aplicable: Seguridad & cumplimiento
El parámetro ExcludedItemClasses especifica los tipos de mensajes que se excluirán de la regla. Solo puede usar este parámetro para excluir elementos de una directiva de retención, que excluye la clase de elemento especificada. El uso de este parámetro no excluye los elementos de las directivas de eliminación. Normalmente, este parámetro se usa para excluir mensajes de correo de voz, conversaciones de mensajería instantánea y otro contenido de Skype Empresarial Online de la retención de una directiva de retención. Los valores comunes de Skype Empresarial incluyen:
- MIP. Note.Microsoft.Conversation
- MIP. Note.Microsoft.Conversation.Voice
- MIP. Note.Microsoft.Missed
- MIP. Note.Microsoft.Missed.Voice
- MIP. Note.Microsoft.Voicemail
- IPM.Note.Microsoft.VoiceMessage.UA
- MIP. 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 personalizados o que no sean de Microsoft. Los valores que especifique no se validan, por lo que el parámetro acepta cualquier valor de texto.
Puede especificar varios valores de clase de elemento utilizando la sintaxis siguiente: "Value1","Value2",..."ValueN".
No puede usar este parámetro para las reglas de retención de Teams.
Propiedades de parámetro
| Tipo: | MultiValuedProperty |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
Default
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-ExpirationDateOption
Aplicable: Seguridad & cumplimiento
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.
Propiedades de parámetro
| Tipo: | String |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-IRMRiskyUserProfiles
Aplicable: Seguridad & cumplimiento
{{ Fill IRMRiskyUserProfiles Description }}
Propiedades de parámetro
| Tipo: | String |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
ComplianceTag
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-MachineLearningModelIDs
Aplicable: Seguridad & cumplimiento
Este parámetro está reservado para uso interno de Microsoft.
Propiedades de parámetro
| Tipo: | MultiValuedProperty |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
ComplianceTag
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-Name
Aplicable: Seguridad & cumplimiento
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 utilizar este parámetro con los parámetros ApplyComplianceTag o PublishComplianceTag.
Propiedades de parámetro
| Tipo: | String |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
Default
| Posición: | 1 |
| Obligatorio: | True |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-Policy
Aplicable: Seguridad & cumplimiento
El parámetro Policy especifica la directiva que contiene la regla.
Propiedades de parámetro
| Tipo: | PolicyIdParameter |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | True |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-PriorityCleanup
Aplicable: Seguridad & cumplimiento
El modificador PriorityCleanup especifica si se creará una regla asociada a una directiva de limpieza de prioridad. No es necesario especificar un valor con este modificador.
Las directivas de limpieza de prioridad aceleran la eliminación de contenido confidencial reemplazando cualquier configuración de retención existente o suspensiones de exhibición de documentos electrónicos. Para obtener más información, vea Limpieza de prioridad.
Propiedades de parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-PublishComplianceTag
Aplicable: Seguridad & cumplimiento
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 puedes usar este parámetro en los siguientes escenarios:
- con los parámetros Name o ApplyComplianceTag.
- Para las reglas de retención de Teams.
- Con directivas de conexión a la nube.
Propiedades de parámetro
| Tipo: | String |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
PublishComplianceTag
| Posición: | Named |
| Obligatorio: | True |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-RetentionComplianceAction
Aplicable: Seguridad & cumplimiento
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". Este parámetro es obligatorio para evitar la eliminación no compatible.
Propiedades de parámetro
| Tipo: | String |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-RetentionDuration
Aplicable: Seguridad & cumplimiento
El parámetro RetentionDuration especifica la duración de la suspensión de la regla de retención. Los valores admitidos son:
- Un entero: la duración de la suspensión en días.
- Ilimitado: El contenido se mantiene indefinidamente.
Propiedades de parámetro
| Tipo: | Unlimited |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
Default
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-RetentionDurationDisplayHint
Aplicable: Seguridad & cumplimiento
El parámetro RetentionDurationDisplayHint especifica las unidades que se usan para mostrar la duración de la retención en el portal de cumplimiento de Microsoft Purview. Los valores admitidos son:
- Días
- Meses
- Años
Por ejemplo, si este parámetro se establece en el valor Años y el parámetro RetentionDuration se establece en el valor 365, el portal de cumplimiento de Microsoft Purview muestra 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.
Propiedades de parámetro
| Tipo: | HoldDurationHint |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
Default
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-WhatIf
Aplicable: Seguridad & cumplimiento
El modificador WhatIf no funciona en Security & Compliance PowerShell.
Propiedades de parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
| Alias: | wi |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
CommonParameters
Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para más información, consulte about_CommonParameters.