Get-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 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.
Sintaxis
Identity
Get-RetentionPolicyTag
[[-Identity] <RetentionPolicyTagIdParameter>]
[-DomainController <Fqdn>]
[-IncludeSystemTags]
[-Types <ElcFolderType[]>]
[<CommonParameters>]
Mailbox
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 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
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
En este ejemplo se devuelven todas las etiquetas de retención de Bandeja de entrada y Todos los tipos y se canaliza los resultados al comando Format-Table para mostrar las propiedades Name, Type, RetentionEnabled, AgeLimitForRetention y RetentionAction.
Parámetros
-DomainController
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
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 |
-Identity
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
El parámetro Identity especifica el nombre de la etiqueta.
Precaución: El valor $null o un valor inexistente para el parámetro Identity devuelve todos los objetos como si ejecutara el comando Get- sin el parámetro Identity. Compruebe que las listas de valores del parámetro Identity son precisas y no contienen valores $null inexistentes.
Propiedades de parámetro
| Tipo: | RetentionPolicyTagIdParameter |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
Identity
| Posición: | 1 |
| Obligatorio: | False |
| Valor de la canalización: | True |
| Valor de la canalización por nombre de propiedad: | True |
| Valor de los argumentos restantes: | False |
-IncludeSystemTags
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
El modificador IncludeSystemTags especifica si se deben devolver etiquetas del sistema. 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 |
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 |
-Mailbox
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
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.
Propiedades de parámetro
| Tipo: | MailboxIdParameter |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
Mailbox
| 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 |
-OptionalInMailbox
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
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.
Propiedades de parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
Mailbox
| 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 |
-Types
Aplicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
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.
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 |
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.