Compartir a través de

Set-ComplianceTag

  • Referencia
Módulo:
ExchangePowerShell
Se aplica a:
Security & Compliance

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

Use el cmdlet Set-ComplianceTag para modificar las etiquetas de retención en el portal de cumplimiento Microsoft Purview. Las etiquetas de retención aplican la configuración de retención al contenido.

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

Set-ComplianceTag
   [-Identity] <ComplianceRuleIdParameter>
   [-AutoApprovalPeriod <System.Int32>]
   [-Comment <String>]
   [-ComplianceTagForNextStage <String>]
   [-Confirm]
   [-EventType <ComplianceRuleIdParameter>]
   [-FilePlanProperty <String>]
   [-FlowId <System.Guid>]
   [-Force]
   [-MultiStageReviewProperty <String>]
   [-Notes <String>]
   [-RetentionDuration <Unlimited>]
   [-ReviewerEmail <SmtpAddress[]>]
   [-WhatIf]
   [<CommonParameters>]
Set-ComplianceTag
   [-Identity] <ComplianceRuleIdParameter>
   [-PriorityCleanup]
   [-Comment <String>]
   [-Confirm]
   [-Force]
   [-MultiStageReviewProperty <String>]
   [-Notes <String>]
   [-RetentionDuration <Unlimited>]
   [-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-ComplianceTag -Identity "HR Content" -RetentionDuration 2555 -Comment "Retain HR content for 7 years"

En este ejemplo se modifica la etiqueta existente denominada Contenido de RR. HH. modificando la duración de retención y agregando un comentario.

Parámetros

-AutoApprovalPeriod

{{ Fill AutoApprovalPeriod Description }}

Tipo:System.Int32
Posición:Named
Valor predeterminado:None
Requerido:False
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

-ComplianceTagForNextStage

{{ Fill ComplianceTagForNextStage 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

-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

-EventType

EventType especifica la regla de retención asociada a la etiqueta. Puede usar cualquier valor que identifique de forma exclusiva la regla. Por ejemplo:

  • Nombre
  • Nombre completo (DN)
  • GUID

Puede usar el cmdlet Get-RetentionComplianceRule para ver las reglas de retención disponibles.

Tipo:ComplianceRuleIdParameter
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False
Se aplica a:Security & Compliance

-FilePlanProperty

El parámetro FilePlanProperty especifica las propiedades del plan de archivo que se van a incluir en la etiqueta. Para ver los nombres de propiedad del plan de archivo que necesita usar en este parámetro, ejecute los siguientes comandos:

  • Get-FilePlanPropertyAuthority | Format-List Name
  • Get-FilePlanPropertyCategory | Format-List Name
  • Get-FilePlanPropertyCitation | Format-List Name
  • Get-FilePlanPropertyDepartment | Format-List Name
  • Get-FilePlanPropertyReferenceId | Format-List Name
  • Get-FilePlanPropertySubCategory | Format-List Name

Un valor válido para este parámetro implica dos pasos:

  • Variable para almacenar las propiedades del plan de archivo como UN OBJETO PSCustomObject mediante la sintaxis siguiente:

    $Variable1=[PSCustomObject]@{Settings=@(@{Key="FilePlanPropertyDepartment";Value="Name"},@{Key="FilePlanPropertyCategory";Value="Name"},@{Key="FilePlanPropertySubcategory";Value="Name"},@{Key="FilePlanPropertyCitation";Value="Name"},@{Key="FilePlanPropertyReferenceId";Value="Name"},@{Key="FilePlanPropertyAuthority";Value="Name"})}

    Por ejemplo:

    $retentionLabelAction=[PSCustomObject]@{Settings=@(@{Key="FilePlanPropertyDepartment";Value="Legal"},@{Key="FilePlanPropertyCategory";Value="Tax"},@{Key="FilePlanPropertySubcategory";Value="US_Tax"},@{Key="FilePlanPropertyCitation";Value="LegalCitation"},@{Key="FilePlanPropertyReferenceId";Value="ReferenceA"},@{Key="FilePlanPropertyAuthority"; Value="Auth1"})}

  • Una segunda variable para convertir PSCustomObject en un objeto JSON mediante la sintaxis siguiente:

    $Variable2 = ConvertTo-Json $Variable1

    Por ejemplo:

    $fpStr = ConvertTo-Json $retentionLabelAction

La segunda variable se usa como valor para este parámetro.

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

-FlowId

Nota: Este parámetro está actualmente en versión preliminar, no está disponible en todas las organizaciones y está sujeto a cambios.

El parámetro FlowId especifica el flujo de Power Automate que se ejecutará al final del período de retención. Un valor válido para este parámetro es el valor GUID del flujo.

Puede encontrar el valor GUID del flujo mediante cualquiera de los métodos siguientes:

  • Vaya al flujo desde el portal de Power Automate. El valor GUID del flujo está en la dirección URL.
  • Use la acción de Power Automate denominada "Enumerar flujos como administrador".
Tipo:System.Guid
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False
Se aplica a:Security & Compliance

-Force

El modificador Force oculta los mensajes de advertencia o confirmación. No es necesario especificar un valor con este modificador.

Este modificador se puede usar para ejecutar tareas mediante programación en las que no es apropiado solicitar una entrada administrativa.

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

-Identity

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

  • Nombre
  • Nombre completo (DN)
  • GUID
Tipo:ComplianceRuleIdParameter
Posición:1
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False
Se aplica a:Security & Compliance

-MultiStageReviewProperty

El parámetro MultiStageReviewProperty especifica las propiedades de revisión de varias fases que se van a incluir en la etiqueta. Este parámetro usa la siguiente sintaxis:

'{"MultiStageReviewSettings":[{"StageName":"Stage1","Reviewers":[reviewer1,reviewer2,...reviewerN]},{"StageName":"Stage2","Reviewers":[reviewer1,reviewer2,...reviewerN]},]}'

Por ejemplo:

'{"MultiStageReviewSettings":[{"StageName":"Stage1","Reviewers":[jie@contoso.onmicrosoft.com]},{"StageName":"Stage2","Reviewers":[bharath@contoso.onmicrosoft.com,helen@contoso.onmicrosoft.com]},]}'

Esta sintaxis es un objeto JSON que define cada identificador de fase de revisión, el nombre de la fase de revisión y la lista de revisores.

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

-Notes

El parámetro Notes especifica una nota opcional. Si especifica un valor que contiene espacios, incluya el valor entre comillas ("), por ejemplo: "Se trata de una nota de usuario".

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

-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

-RetentionDuration

El parámetro RetentionDuration especifica la cantidad de días que se va a conservar el contenido. Los valores admitidos son:

  • Un número entero positivo.
  • El valor unlimited.
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

-ReviewerEmail

El parámetro ReviewerEmail especifica la dirección de correo electrónico del revisor para las acciones de retención Delete y KeepAndDelete. Puede especificar varias direcciones de correo electrónico separadas por comas.

Tipo:SmtpAddress[]
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