Compartir a través de


Set-RetentionComplianceRule

Este cmdlet está disponible solo en Security & Compliance PowerShell. Para obtener más información, consulte Security & Compliance PowerShell.

Use el cmdlet Set-RetentionComplianceRule para modificar las reglas de retención existentes 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

Default (Es el valor predeterminado).

Set-RetentionComplianceRule
    [-Identity] <ComplianceRuleIdParameter>
    [-ApplyComplianceTag <String>]
    [-Comment <String>]
    [-Confirm]
    [-ContentContainsSensitiveInformation <PswsHashtable[]>]
    [-ContentDateFrom <DateTime>]
    [-ContentDateTo <DateTime>]
    [-ContentMatchQuery <String>]
    [-ExcludedItemClasses <MultiValuedProperty>]
    [-ExpirationDateOption <String>]
    [-IRMRiskyUserProfiles <String>]
    [-PriorityCleanup]
    [-RetentionComplianceAction <String>]
    [-RetentionDuration <Unlimited>]
    [-RetentionDurationDisplayHint <HoldDurationHint>]
    [-WhatIf]
    [<CommonParameters>]

Description

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

Set-RetentionComplianceRule -Identity "Internal Company Rule" -RetentionDuration 180 -RetentionDurationDisplayHint Days

En este ejemplo se cambia la duración de suspensión de la regla de retención existente denominada "Internal Company Rule".

Parámetros

-ApplyComplianceTag

Aplicable: Cumplimiento de & de seguridad

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 del parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Comment

Aplicable: Cumplimiento de & de seguridad

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 del parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory: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: Cumplimiento de & de seguridad

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.

Propiedades del parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:cf

Conjuntos de parámetros

(All)
Posición:Named
Mandatory: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: Cumplimiento de & de seguridad

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.

No puede usar este parámetro para las reglas de retención de Teams.

Propiedades del parámetro

Tipo:

PswsHashtable[]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-ContentDateFrom

Aplicable: Cumplimiento de & de seguridad

El parámetro ContentDateFrom especifica la fecha de inicio del intervalo de fechas para el contenido que se incluirá.

Use el formato de fecha corta que se define en la opción Configuración regional en el equipo en el que se ejecuta el comando. Por ejemplo, si el equipo está configurado para usar el formato de fecha corta MM/dd/aaaa, escriba 09/01/2018 para especificar el 1 de septiembre de 2018. Puede escribir solo la fecha, o la fecha y la hora del día. Si escribe la fecha y la hora del día, encierre el valor entre comillas ("), por ejemplo, "01/09/2018 5:00 PM".

Propiedades del parámetro

Tipo:DateTime
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-ContentDateTo

Aplicable: Cumplimiento de & de seguridad

El parámetro ContentDateTo especifica la fecha de fin del intervalo de fechas para el contenido que se incluirá.

Use el formato de fecha corta que se define en la opción Configuración regional en el equipo en el que se ejecuta el comando. Por ejemplo, si el equipo está configurado para usar el formato de fecha corta MM/dd/aaaa, escriba 09/01/2018 para especificar el 1 de septiembre de 2018. Puede escribir solo la fecha, o la fecha y la hora del día. Si escribe la fecha y la hora del día, encierre el valor entre comillas ("), por ejemplo, "01/09/2018 5:00 PM".

Propiedades del parámetro

Tipo:DateTime
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory: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: Cumplimiento de & de seguridad

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.

Propiedades del parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory: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: Cumplimiento de & de seguridad

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. Este parámetro no excluye 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 que no sean de Microsoft. 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.

Propiedades del parámetro

Tipo:MultiValuedProperty
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory: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: Cumplimiento de & de seguridad

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 del parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Identity

Aplicable: Cumplimiento de & de seguridad

El parámetro Identity especifica la regla de retención que desea modificar. Puede usar cualquier valor que identifique de forma exclusiva la regla. Por ejemplo:

  • Nombre
  • Nombre completo (DN)
  • GUID

Propiedades del parámetro

Tipo:ComplianceRuleIdParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:1
Mandatory:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-IRMRiskyUserProfiles

Aplicable: Cumplimiento de & de seguridad

{{ Fill IRMRiskyUserProfiles Description }}

Propiedades del parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-PriorityCleanup

Aplicable: Cumplimiento de & de seguridad

El modificador PriorityCleanup especifica si se debe actualizar la 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 o retención de eDiscovery existente. Para obtener más información, vea Limpieza de prioridad.

Propiedades del parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-RetentionComplianceAction

Aplicable: Cumplimiento de & de seguridad

El parámetro RetentionComplianceAction especifica la acción de retención de la regla. Los valores admitidos son:

  • Eliminar
  • Conservar
  • KeepAndDelete

Propiedades del parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory: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: Cumplimiento de & de seguridad

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.

Propiedades del parámetro

Tipo:Unlimited
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory: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: Cumplimiento de & de seguridad

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 válidos son Days, Months y Years.

  • 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 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 del parámetro

Tipo:HoldDurationHint
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory: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: Cumplimiento de & de seguridad

El modificador WhatIf no funciona en Security & Compliance PowerShell.

Propiedades del parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:Wi

Conjuntos de parámetros

(All)
Posición:Named
Mandatory: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.