New-ComplianceTag

Módulo:

ExchangePowerShell

Se aplica a:

Security & Compliance

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

Use el cmdlet New-ComplianceTag para crear 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.

Syntax

New-ComplianceTag
   [-Name] <String>
   [-Comment <String>]
   [-ComplianceTagForNextStage <String>]
   [-Confirm]
   [-EventType <ComplianceRuleIdParameter>]
   [-FilePlanProperty <String>]
   [-FlowId <System.Guid>]
   [-Force]
   [-IsRecordLabel <Boolean>]
   [-IsRecordUnlockedAsDefault <Boolean>]
   [-MultiStageReviewProperty <String>]
   [-Notes <String>]
   [-Regulatory <Boolean>]
   [-RetentionAction <String>]
   [-RetentionDuration <Unlimited>]
   [-RetentionType <String>]
   [-ReviewerEmail <SmtpAddress[]>]
   [-WhatIf]
   [<CommonParameters>]

Description

Para usar este cmdlet en PowerShell de cumplimiento de seguridad & , debe tener asignados permisos. Para obtener más información vea Permisos en el portal de cumplimiento de Microsoft Purview.

Ejemplos

Ejemplo 1

New-ComplianceTag -Name "HR Content" -RetentionAction Keep -RetentionDuration 1825 -RetentionType ModificationAgeInDays

En este ejemplo se crea una nueva etiqueta denominada HR Content con la siguiente configuración:

• Acción: Mantener.
• Duración: 5 años (1825 días)
• Tipo: edad de modificación en días.

Parámetros

-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".

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Security & Compliance

-ComplianceTagForNextStage

{{ Fill ComplianceTagForNextStage Description }}

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	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, 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 demás cmdlets (por ejemplo, los cmdlets 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.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	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.

Type:	ComplianceRuleIdParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	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".

Type:	System.Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	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.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Security & Compliance

-IsRecordLabel

El parámetro IsRecordLabel especifica si la etiqueta es una etiqueta de registro. Los valores admitidos son:

• $true: la etiqueta es una etiqueta de registro. Una vez que la etiqueta se aplica al contenido, no se puede quitar la etiqueta.
• $false: La etiqueta no es una etiqueta de registro. Este es el valor predeterminado.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Security & Compliance

-IsRecordUnlockedAsDefault

{{ Fill IsRecordUnlockedAsDefault Description }}

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Security & Compliance

-Name

El parámetro Name especifica un nombre único para la etiqueta. Si el valor contiene espacios, escriba el valor entre comillas (").

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Security & Compliance

-Notes

El parámetro Notes especifica información adicional sobre el objeto. Si el valor contiene espacios, escriba el valor entre comillas (").

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Security & Compliance

-Regulatory

{{ Fill Regulatory Description }}

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Security & Compliance

-RetentionAction

El parámetro RetentionAction especifica la acción de la etiqueta. Los valores admitidos son:

• Delete
• Conservar
• KeepAndDelete

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	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.

Type:	Unlimited
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Security & Compliance

-RetentionType

El parámetro RetentionType especifica si la duración de la retención se calcula a partir de la fecha de creación del contenido, la fecha etiquetada o la fecha de última modificación. Los valores admitidos son:

• CreationAgeInDays
• EventAgeInDays
• ModificationAgeInDays
• TaggedAgeInDays

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	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.

Type:	SmtpAddress[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Security & Compliance

-WhatIf

El modificador WhatIf no funciona en PowerShell de cumplimiento de seguridad & .

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Security & Compliance