New-RetentionPolicyTag
Este cmdlet está disponible en Exchange local y en el servicio basado en la nube. Algunos parámetros y configuraciones pueden ser exclusivos de un entorno u otro.
Use el cmdlet New-RetentionPolicyTag para crear 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.
Sintaxis
RetentionPolicy (valor predeterminado)
New-RetentionPolicyTag
[-Name] <String>
[-AddressForJournaling <RecipientIdParameter>]
[-AgeLimitForRetention <EnhancedTimeSpan>]
[-Comment <String>]
[-Confirm]
[-DomainController <Fqdn>]
[-IsDefaultAutoGroupPolicyTag]
[-IsDefaultModeratedRecipientsPolicyTag]
[-JournalingEnabled <Boolean>]
[-LabelForJournaling <String>]
[-LocalizedComment <MultiValuedProperty>]
[-LocalizedRetentionPolicyTagName <MultiValuedProperty>]
[-MessageClass <String>]
[-MessageFormatForJournaling <JournalingFormat>]
[-MustDisplayCommentEnabled <Boolean>]
[-RetentionAction <RetentionAction>]
[-RetentionEnabled <Boolean>]
[-RetentionId <Guid>]
[-SystemTag <Boolean>]
[-Type <ElcFolderType>]
[-WhatIf]
[<CommonParameters>]
UpgradeManagedFolder
New-RetentionPolicyTag
[-Name] <String>
[-ManagedFolderToUpgrade <ELCFolderIdParameter>]
[-Comment <String>]
[-Confirm]
[-DomainController <Fqdn>]
[-IsDefaultAutoGroupPolicyTag]
[-IsDefaultModeratedRecipientsPolicyTag]
[-LocalizedComment <MultiValuedProperty>]
[-LocalizedRetentionPolicyTagName <MultiValuedProperty>]
[-MustDisplayCommentEnabled <Boolean>]
[-SystemTag <Boolean>]
[-Type <ElcFolderType>]
[-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.
Las etiquetas de retención admiten una presentación del nombre de la etiqueta y un comentario opcional en idiomas localizados. Los códigos de cultura del idioma de CultureInfo se usan para este propósito.
Deberá tener asignados permisos antes de poder ejecutar este cmdlet. Aunque en este artículo se enumeran todos los parámetros del cmdlet, es posible que no tenga acceso a algunos parámetros si no se incluyen en los permisos que se le asignan. 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
New-RetentionPolicyTag "Finance-DeletedItems" -Type DeletedItems -RetentionEnabled $true -AgeLimitForRetention 30 -RetentionAction PermanentlyDelete
Este ejemplo crea la etiqueta de directiva de retención Finance-DeletedItems para la carpeta predeterminada Elementos eliminados. Cuando se aplica a un buzón de correo como parte de una directiva de retención, la etiqueta elimina permanentemente los elementos de todo tipo de la carpeta Elementos eliminados en 30 días.
Ejemplo 2
New-RetentionPolicyTag "Finance-Default" -Type All -RetentionEnabled $true -AgeLimitForRetention 365 -RetentionAction PermanentlyDelete
Este ejemplo crea la etiqueta de directiva predeterminada Finance-Default. Cuando se aplica a un buzón como parte de una directiva de retención, la etiqueta elimina permanentemente todos los elementos sin una etiqueta de retención en 365 días. Los elementos de una clase de mensaje determinada, como Voicemail, para los que existe una etiqueta predeterminada (una etiqueta de retención de tipo All), no se ven afectados.
Ejemplo 3
New-RetentionPolicyTag "Business Critical" -Type Personal -Comment "Use this tag for all business critical mail" -RetentionEnabled $true -AgeLimitForRetention 2556 -RetentionAction PermanentlyDelete
Este ejemplo crea la etiqueta de retención Crítico para la empresa de tipo Personal. Cuando se aplica a elementos del buzón como parte de una directiva de retención, se eliminan permanentemente los elementos en aproximadamente 7 años.
Parámetros
-AddressForJournaling
Aplicable: Exchange Server 2010
Este parámetro solo está disponible en Exchange Server 2010.
Este parámetro está reservado para uso interno de Microsoft.
Propiedades de parámetro
| Tipo: | RecipientIdParameter |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
RetentionPolicy
| 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 |
-AgeLimitForRetention
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
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.
Propiedades de parámetro
| Tipo: | EnhancedTimeSpan |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
RetentionPolicy
| 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 |
-Comment
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
El parámetro Comment especifica un comentario para la etiqueta.
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 |
-Confirm
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
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 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 |
-DomainController
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
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.
Propiedades de parámetro
| Tipo: | Fqdn |
| 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 |
-IsDefaultAutoGroupPolicyTag
Aplicable: Exchange Online
Este parámetro solo está disponible en el servicio basado en la nube.
Este parámetro está reservado para uso interno de Microsoft.
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 |
-IsDefaultModeratedRecipientsPolicyTag
Aplicable: Exchange Online
Este parámetro solo está disponible en el servicio basado en la nube.
Este parámetro está reservado para uso interno de Microsoft.
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 |
-JournalingEnabled
Aplicable: Exchange Server 2010
Este parámetro solo está disponible en Exchange Server 2010.
Este parámetro está reservado para uso interno de Microsoft.
Propiedades de parámetro
| Tipo: | Boolean |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
RetentionPolicy
| 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 |
-LabelForJournaling
Aplicable: Exchange Server 2010
Este parámetro solo está disponible en Exchange Server 2010.
Este parámetro está reservado para uso interno de Microsoft.
Propiedades de parámetro
| Tipo: | String |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
RetentionPolicy
| 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 |
-LocalizedComment
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
El parámetro LocalizedComment especifica comentarios localizados y sus idiomas. Cuando la configuración de idioma del usuario coincide con un idioma especificado para este parámetro, Microsoft Outlook y Outlook en la Web mostrar el comentario localizado correspondiente. Los comentarios se especifican con el formato Código de idioma ISO:comentario; por ejemplo, LocalizedComment EN-US:"This is a localized comment in U.S. English".
Propiedades de parámetro
| Tipo: | MultiValuedProperty |
| 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 |
-LocalizedRetentionPolicyTagName
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
El parámetro LocalizedRetentionPolicyTagName especifica nombres de etiquetas localizadas y sus idiomas. Cuando la configuración de idioma del usuario coincide con un idioma especificado para este parámetro, Outlook y Outlook en la Web mostrar el nombre de etiqueta localizado correspondiente. Los nombres se especifican con el formato Código de idioma ISO:nombre; por ejemplo, LocalizedRetentionPolicyTagName EN-US:"Business Critical".
Propiedades de parámetro
| Tipo: | MultiValuedProperty |
| 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 |
-ManagedFolderToUpgrade
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
Este parámetro solo está disponible en Exchange local.
El parámetro ManagedFolderToUpgrade especifica el nombre de una carpeta administrada para usarla como plantilla para una etiqueta de retención.
Propiedades de parámetro
| Tipo: | ELCFolderIdParameter |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
UpgradeManagedFolder
| 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 |
-MessageClass
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
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 diferentes tipos de mensaje. 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 los mensajes de correo de voz de mensajería unificada de Microsoft Exchange (identificados por el PR_MESSAGE_CLASS valor de propiedad MAPI IPM. Note.Microsoft.Voicemail*).
Propiedades de parámetro
| Tipo: | String |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
RetentionPolicy
| 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 |
-MessageFormatForJournaling
Aplicable: Exchange Server 2010
Este parámetro solo está disponible en Exchange Server 2010.
Este parámetro está reservado para uso interno de Microsoft.
Propiedades de parámetro
| Tipo: | JournalingFormat |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
RetentionPolicy
| 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 |
-MustDisplayCommentEnabled
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
El parámetro MustDisplayCommentEnabled especifica si se puede ocultar el comentario. El valor predeterminado es $true.
Propiedades de parámetro
| Tipo: | Boolean |
| 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 |
-Name
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
El parámetro Name especifica el nombre de la etiqueta.
Propiedades de parámetro
| Tipo: | String |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| 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 |
-RetentionAction
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
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. Un mensaje que se elimina permanentemente no se puede recuperar mediante la carpeta 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.
Propiedades de parámetro
| Tipo: | RetentionAction |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
RetentionPolicy
| 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 |
-RetentionEnabled
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
El parámetro RetentionEnabled especifica si se ha habilitado la etiqueta. Si se establece en $false, la etiqueta se deshabilita y no se realiza ninguna acción de retención en relación con los mensajes a los que se haya aplicado la etiqueta.
Los mensajes con una etiqueta deshabilitada todavía se consideran etiquetados, por lo que las etiquetas del mismo tipo que la etiqueta deshabilitada en la directiva de retención del usuario no se aplican a dichos mensajes.
Si se establece el parámetro RetentionEnabled en $false, el período de retención de la etiqueta que se muestra es Nunca. Es posible que los usuarios apliquen esta etiqueta a los elementos que quieran indicar que nunca se deben eliminar o que nunca se deben mover al archivo. Habilitar la etiqueta más adelante podría dar lugar a la eliminación o el archivado involuntarios de elementos. Para evitar esta situación, si una directiva de retención está deshabilitada temporalmente, podría ser aconsejable cambiar el nombre de esa etiqueta para que los usuarios no puedan usarla, como DISABLED_<Original Name>.
Propiedades de parámetro
| Tipo: | Boolean |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
RetentionPolicy
| 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 |
-RetentionId
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
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 implementación local coincide con la etiqueta cuando el buzón se mueve a la nube o que los elementos de buzón etiquetados en la nube coinciden con la etiqueta cuando el buzón se mueve a un servidor de Exchange local. El parámetro se utiliza en las implementaciones entre instalaciones. No es necesario especificar este parámetro en las implementaciones sólo locales.
Propiedades de parámetro
| Tipo: | Guid |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
RetentionPolicy
| 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 |
-SystemTag
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
El parámetro SystemTag especifica que la etiqueta se crea para la funcionalidad interna de Exchange.
Propiedades de parámetro
| Tipo: | Boolean |
| 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 |
-Type
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
El parámetro Type especifica el tipo de etiqueta de retención que se va a crear. Los valores válidos son:
- todas
- Archivar
- Calendario
- Desorden: solo disponible en Exchange Online.
- Contactos
- ConversationHistory
- DeletedItems
- Borradores
- Bandeja de entrada
- Diario
- Correo basura
- LegacyArchiveJournals
- ManagedCustomFolder
- Notas
- Bandeja de salida
- Personal
- RecoverableItems
- RssSubscriptions
- SentItems
- SyncIssues
- Tareas
Para crear una etiqueta de directiva predeterminada (DPT), especifique el tipo All. Para las etiquetas de tipo RecoverableItems, la única acción de retención válida es MoveToArchive.
Propiedades de parámetro
| Tipo: | ElcFolderType |
| 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 |
-WhatIf
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
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.
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.
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.