Set-RetentionPolicyTag
Este cmdlet está disponible en Exchange local y en el servicio basado en la nube. Puede que algunos parámetros y opciones de configuración sean exclusivos de un entorno u otro.
Use el cmdlet Set-RetentionPolicyTag para modificar las propiedades de una etiqueta de retención.
Para obtener más información sobre las etiquetas de retención, consulte Etiquetas de retención y directivas de retención en Exchange Server.
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
Set-RetentionPolicyTag
[-Identity] <RetentionPolicyTagIdParameter>
[-AddressForJournaling <RecipientIdParameter>]
[-AgeLimitForRetention <EnhancedTimeSpan>]
[-Comment <String>]
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-JournalingEnabled <Boolean>]
[-LabelForJournaling <String>]
[-LegacyManagedFolder <ELCFolderIdParameter>]
[-LocalizedComment <MultiValuedProperty>]
[-LocalizedRetentionPolicyTagName <MultiValuedProperty>]
[-MessageClass <String>]
[-MessageFormatForJournaling <JournalingFormat>]
[-MustDisplayCommentEnabled <Boolean>]
[-Name <String>]
[-RetentionAction <RetentionAction>]
[-RetentionEnabled <Boolean>]
[-RetentionId <Guid>]
[-SystemTag <Boolean>]
[-WhatIf]
[<CommonParameters>] Set-RetentionPolicyTag
-Mailbox <MailboxIdParameter>
[-Comment <String>]
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-LegacyManagedFolder <ELCFolderIdParameter>]
[-LocalizedComment <MultiValuedProperty>]
[-LocalizedRetentionPolicyTagName <MultiValuedProperty>]
[-MustDisplayCommentEnabled <Boolean>]
[-Name <String>]
[-OptionalInMailbox <RetentionPolicyTagIdParameter[]>]
[-RetentionId <Guid>]
[-SystemTag <Boolean>]
[-WhatIf]
[<CommonParameters>] Description
Las etiquetas de retención se usan para aplicar una configuración de retención de mensajes a carpetas y elementos en un buzón.
Deberá tener asignados permisos antes de poder ejecutar este cmdlet. Aunque en este tema se enumeran todos los parámetros correspondientes a este cmdlet, tal vez no tenga acceso a algunos parámetros si no están incluidos en los permisos que se le han asignado. Para obtener los permisos necesarios para ejecutar cualquier cmdlet o parámetro en su organización, consulte Find the permissions required to run any Exchange cmdlet.
Ejemplos
Ejemplo 1
Set-RetentionPolicyTag "AllUsers-DeletedItems" -Comment "Items in the Deleted Items folder will be automatically deleted in 120 days"Este ejemplo cambia el comentario para la etiqueta de directiva de retención DeletedItems-AllUsers.
Ejemplo 2
Set-RetentionPolicyTag -Mailbox "Terry Adams" -OptionalInMailbox "ProjectA","ProjectB"Este ejemplo hace que las etiquetas de retención opcionales estén disponibles para el usuario Antonio Bermejo mediante los parámetros Mailbox y OptionalInMailbox.
Parámetros
-AddressForJournaling
Este parámetro solo está disponible en Exchange Server 2010.
Este parámetro está reservado para uso interno de Microsoft.
| Type: | RecipientIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010 |
-AgeLimitForRetention
El parámetro AgeLimitForRetention especifica la antigüedad en la que se establece la expiración de un elemento. El límite de antigüedad corresponde a la cantidad de días desde la fecha en que el elemento se entregó o, si no se entregó, la fecha en que el elemento fue creado. Si este parámetro no está presente y el parámetro RetentionEnabled está establecido en $true, se devuelve un error.
| Type: | EnhancedTimeSpan |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Comment
El parámetro Comment especifica un comentario para la etiqueta de directiva de retención.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-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: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-DomainController
Este parámetro solo está disponible en Exchange local.
El parámetro DomainController especifica el controlador de dominio que el cmdlet usa para leer datos de Active Directory o escribirlos. El controlador de dominio se identifica por su nombre de dominio completo (FQDN). Por ejemplo, dc01.contoso.com.
| Type: | Fqdn |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Force
El modificador Force oculta los mensajes de advertencia o confirmación. No es necesario especificar un valor con este modificador.
Use este modificador para ocultar el símbolo del sistema de confirmación cuando use el parámetro RetentionId.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Identity
El parámetro Identity especifica el nombre, el nombre distintivo (DN) o el GUID de la etiqueta de directiva de retención que se va a modificar.
| Type: | RetentionPolicyTagIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-JournalingEnabled
Este parámetro solo está disponible en Exchange Server 2010.
Este parámetro está reservado para uso interno de Microsoft.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010 |
-LabelForJournaling
Este parámetro solo está disponible en Exchange Server 2010.
Este parámetro está reservado para uso interno de Microsoft.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010 |
-LegacyManagedFolder
El parámetro LegacyManagedFolder especifica el nombre de una carpeta administrada. La etiqueta de retención se crea usando la configuración de retención de la carpeta administrada y su configuración de contenido administrado. Puede usar este parámetro para crear etiquetas de retención basadas en las carpetas administradas existentes para migrar los usuarios desde las directivas de buzón de carpetas administradas a las directivas de retención.
| Type: | ELCFolderIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-LocalizedComment
El parámetro LocalizedComment especifica el comentario localizado y el idioma para la etiqueta de directiva de retención. Este comentario se muestra en Microsoft Outlook en función de la configuración regional del usuario.
| Type: | MultiValuedProperty |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-LocalizedRetentionPolicyTagName
El parámetro LocalizedRetentionPolicyTagName especifica un nombre localizado para la etiqueta de directiva de retención. Este nombre se muestra en Outlook en función de la configuración regional del usuario.
| Type: | MultiValuedProperty |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Mailbox
El parámetro Mailbox especifica un buzón para asignar las etiquetas de participación. Es posible usar cualquier valor que identifique exclusivamente el buzón. Por ejemplo:
- Nombre
- Alias
- Nombre distintivo (DN)
- Nombre completo (DN)
- Dominio\Nombre de usuario
- Dirección de correo electrónico
- GUID
- LegacyExchangeDN
- SamAccountName
- ID de usuario o nombre de la entidad de seguridad de usuario (UPN)
Use este parámetro con el parámetro OptionalInMailbox.
| Type: | MailboxIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-MessageClass
El parámetro MessageClass especifica el tipo de mensaje al que se aplica la etiqueta. Si no se especifica, el valor predeterminado se establece en *.
Con la excepción de una etiqueta de directiva predeterminada (DPT) para el correo de voz, Exchange no admite etiquetas de retención para distintos tipos de mensajes. Solo se admiten etiquetas con una clase MessageClass de * y se aplican a todos los tipos de mensaje.
Para crear un DPT para mensajes de correo de voz, establezca el parámetro MessageClass en voicemail y el parámetro Type en All.
Un DPT para mensajes de correo de voz solo se aplica a Microsoft mensajes de correo de voz de mensajería unificada de Exchange (identificados por el valor de propiedad MAPI PR_MESSAGE_CLASS IPM. Nota. Microsoft. Correo de voz*).
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-MessageFormatForJournaling
Este parámetro solo está disponible en Exchange Server 2010.
Este parámetro está reservado para uso interno de Microsoft.
| Type: | JournalingFormat |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010 |
-MustDisplayCommentEnabled
El parámetro MustDisplayCommentEnabled especifica si se puede ocultar el comentario. El valor predeterminado es $true.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Name
El parámetro Name especifica el nombre de la etiqueta de directiva de retención.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-OptionalInMailbox
El parámetro OptionalInMailbox se usa con el parámetro Mailbox para asignar etiquetas personales al buzón. Puede usar este parámetro para poner a disposición de un usuario una etiqueta personal que no esté asignada a la directiva de retención aplicada al buzón especificado. Puede especificar varias etiquetas personales separadas por comas.
| Type: | RetentionPolicyTagIdParameter[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-RetentionAction
El parámetro RetentionAction especifica la acción de la directiva de retención. Los valores admitidos son:
- DeleteAndAllowRecovery: elimina un mensaje y permite la recuperación de la carpeta Elementos recuperables.
- DeleteAndAllowRecovery: elimina un mensaje y permite la recuperación de la carpeta de elementos recuperables.
- MoveToArchive: mueve un mensaje al buzón de archivo del usuario. Puede usar esta acción para etiquetas de retención de tipo All, Personal y RecoverableItems.
- PermanentlyDelete: elimina permanentemente un mensaje. No se puede recuperar un mensaje que se ha eliminado permanentemente mediante la carpeta de elementos recuperables. Los mensajes eliminados permanentemente no se devuelven en una búsqueda de detección, a menos que la suspensión del litigio esté habilitada para el buzón.
Las acciones MoveToDeletedItems y MoveToFolder están disponibles, pero no funcionan. Estas acciones están disponibles para las actualizaciones de la administración desde los registros de mensajería (MRM) 1.0 (carpetas administradas) a MRM 2.0 (políticas de retención). MRM 2.0 se introdujo en Exchange 2010 Service Pack 1 (SP1).
Si este parámetro no está presente y el parámetro RetentionEnabled está establecido en $true, se devuelve un error.
| Type: | RetentionAction |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-RetentionEnabled
El parámetro RetentionEnabled especifica si se ha habilitado la etiqueta. Cuando se establece en $false, la etiqueta se deshabilita y no se realiza ninguna acción de retención en los mensajes que tienen aplicada la etiqueta.
Los mensajes con una etiqueta deshabilitada se siguen considerando etiquetados, por lo que las etiquetas de directivas predeterminadas que pueda haber en la directiva de retención del usuario no se aplican a este tipo de mensajes.
Si se establece el parámetro RetentionEnabled en $false, el período de retención de la etiqueta que se muestra es Nunca. Los usuarios pueden aplicar esta etiqueta a los elementos para indicar que no se deben eliminar nunca o que no se deben mover al archivo. Si se habilita la etiqueta más tarde, se podría eliminar o archivar los elementos por accidente. Para evitar esta situación, si una directiva de retención está deshabilitada temporalmente, puede ser aconsejable cambiar el nombre de esa etiqueta para que los usuarios no puedan usarla, como DISABLED_<Original Name>.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-RetentionId
El parámetro RetentionId especifica un identificador de etiqueta alternativo para asegurarse de que la etiqueta de retención que se encuentra en los elementos de buzón etiquetados en una organización de Exchange coincide con la etiqueta cuando el buzón se mueve a otra organización de Exchange (por ejemplo, en una implementación entre bosques o en una implementación entre locales, cuando se mueve un buzón de correo de un servidor exchange local a la nube, o un buzón basado en la nube se mueve a un servidor exchange local).
Normalmente, no es necesario especificar ni modificar el parámetro RetentionId para una etiqueta de retención. Este parámetro se rellena automáticamente al importar etiquetas de retención en una implementación entre bosques o entre locales.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-SystemTag
El parámetro SystemTag especifica si se crea la etiqueta de directiva de retención para la funcionalidad interna de Exchange.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-WhatIf
El modificador WhatIf simula las acciones del comando. Puede usar este modificador para ver los cambios que se producirían, pero sin aplicar los cambios. No es necesario especificar un valor con este modificador.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
Entradas
Input types
Para ver los tipos de entrada que acepta este cmdlet, consulte Tipos de entrada y salida de cmdlet. Si el campo Tipo de entrada de un cmdlet está en blanco, el cmdlet no acepta datos de entrada.
Salidas
Output types
Para ver los tipos de valor devuelto (también conocidos como tipos de resultado) que acepta este cmdlet, consulte Tipos de entrada y salida de cmdlet. Si el campo Tipo de resultado está en blanco, el cmdlet no devuelve datos.
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de