Get-RetentionPolicyTag

  • Referencia
Módulo:
ExchangePowerShell
Se aplica a:
Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

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 Get-RetentionPolicyTag para recuperar la configuración de una etiqueta de retención.

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

Get-RetentionPolicyTag
   [[-Identity] <RetentionPolicyTagIdParameter>]
   [-DomainController <Fqdn>]
   [-IncludeSystemTags]
   [-Types <ElcFolderType[]>]
   [<CommonParameters>]
Get-RetentionPolicyTag
   [-Mailbox <MailboxIdParameter>]
   [-OptionalInMailbox]
   [-DomainController <Fqdn>]
   [-IncludeSystemTags]
   [-Types <ElcFolderType[]>]
   [<CommonParameters>]

Description

Las etiquetas de retención se usan para aplicar la configuración de retención de mensajes a mensajes o carpetas. Existen tres tipos de etiquetas de retención:

  • Etiquetas de directiva de retención
  • Etiquetas de directiva predeterminadas
  • Etiquetas personales

Las etiquetas de directiva de retención se aplican a carpetas predeterminadas, como Bandeja de entrada y Elementos eliminados. Las etiquetas personales están disponibles para que los usuarios etiqueten elementos y carpetas. La etiqueta de directiva predeterminada se aplica a todos los elementos que no tienen una etiqueta aplicada por el usuario o que no se heredan de la carpeta en la que se encuentran. El cmdlet Get-RetentionPolicyTag muestra toda la configuración de la etiqueta especificada.

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

Get-RetentionPolicyTag

En este ejemplo se devuelven todas las etiquetas de retención.

Ejemplo 2

Get-RetentionPolicyTag -IncludeSystemTags

En este ejemplo se devuelven etiquetas del sistema además de etiquetas personales y predeterminadas.

Ejemplo 3

Get-RetentionPolicyTag "Consolidated Messenger"

En este ejemplo se devuelve la configuración de la etiqueta Consolidated Messenger.

Ejemplo 4

Get-RetentionPolicyTag -Types Inbox,All | Format-Table Name,Type,RetentionEnabled,AgeLimitForRetention,RetentionAction -AutoSize

Este ejemplo devuelve todas las etiquetas de retención de Bandeja de entrada y Todos los tipos y canaliza los resultados al comando Format-Table para mostrar las propiedades Name, Type, RetentionEnabled, AgeLimitForRetention y RetentionAction.

Parámetros

-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

-Identity

El parámetro Identity especifica el nombre de la etiqueta.

Type:RetentionPolicyTagIdParameter
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-IncludeSystemTags

El modificador IncludeSystemTags especifica si se deben devolver etiquetas del sistema. No es necesario especificar un valor con este modificador.

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

-Mailbox

El parámetro Mailbox devuelve las etiquetas de retención asignadas a la directiva de retención que se aplica al buzón especificado. 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)

Este parámetro solo devuelve etiquetas de directiva predeterminadas (DPT) y etiquetas personales; no devuelve etiquetas de directiva de retención.

Type:MailboxIdParameter
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 devolver las etiquetas de retención de participación asignadas al buzón especificado. No es necesario especificar un valor con este modificador.

Una etiqueta de retención de participación es una etiqueta personal que se asignó explícitamente al buzón con el comando Set-RetentionPolicyTag -Mailbox -OptionalInMailbox.

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

-Types

El parámetro Types especifica el tipo de etiqueta de retención que se va a devolver. Los valores válidos son:

  • Calendario
  • Contactos
  • DeletedItems
  • Borradores
  • Bandeja de entrada
  • Correo basura
  • Diario
  • Notas
  • Bandeja de salida
  • SentItems
  • Tareas
  • todas
  • RssSubscriptions
  • ConversationHistory
  • Personal

El parámetro acepta varios valores separados por una coma.

Type:ElcFolderType[]
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.