Get-RetentionPolicyTag

  • Référence
Module:
ExchangePowerShell
S’applique à:
Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

Cette cmdlet est disponible dans Exchange sur site et dans le service cloud. Certains paramètres peuvent être propres à un environnement ou à un autre.

La cmdlet Get-RetentionPolicyTag permet de récupérer les paramètres d’une balise de rétention.

Pour plus d’informations sur les jeux de paramètres dans la section Syntaxe ci-après, voir Syntaxe da la cmdlet Exchange.

Syntax

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

Description

Les balises de rétention sont utilisées pour appliquer les paramètres de rétention des messages aux messages ou aux dossiers. Il existe trois types de balise de rétention :

  • Les balises de stratégie de rétention
  • Les balises de stratégie par défaut
  • Les balises personnelles

Les balises de stratégie de rétention sont appliquées aux dossiers par défaut tels que Boîte de réception et Éléments supprimés. Les balises personnelles sont mises à la disposition des utilisateurs pour baliser des éléments et des dossiers. La balise de stratégie par défaut est appliquée à tous les éléments sur lesquels aucune balise n’est appliquée par l’utilisateur ou qui ne sont pas hérités du dossier dans lequel ils se trouvent. La cmdlet Get-RetentionPolicyTag permet d’afficher tous les paramètres de la balise spécifiée.

Des autorisations doivent vous être attribuées avant de pouvoir exécuter cette cmdlet. Bien que cette rubrique répertorie tous les paramètres de cette cmdlet, il est possible que vous n’ayez pas accès à certains paramètres s’ils ne sont pas inclus dans les autorisations qui vous ont été attribuées. Pour rechercher les autorisations requises pour exécuter une cmdlet ou un paramètre dans votre organisation, voir Find the permissions required to run any Exchange cmdlet.

Exemples

Exemple 1

Get-RetentionPolicyTag

Cet exemple renvoie toutes les balises de rétention.

Exemple 2

Get-RetentionPolicyTag -IncludeSystemTags

Cet exemple renvoie les balises de système en plus des balises personnelles et par défaut.

Exemple 3

Get-RetentionPolicyTag "Consolidated Messenger"

Cet exemple renvoie les paramètres de la balise Consolidated Messenger.

Exemple 4

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

Cet exemple montre comment renvoyer toutes les balises de rétention de la boîte de réception et tous les types et rediriger les résultats vers la commande Format-Table pour afficher les propriétés Name, Type, RetentionEnabled, AgeLimitForRetention et RetentionAction.

Paramètres

-DomainController

Ce paramètre est disponible uniquement dans Exchange sur site.

Le paramètre DomainController spécifie le contrôleur de domaine qui est utilisé par cette cmdlet pour lire ou écrire les données dans Active Directory. Vous identifiez le contrôleur de domaine par son nom de domaine complet (FQDN). Par exemple : « 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

Le paramètre Identity spécifie le nom de la balise.

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

Le commutateur IncludeSystemTags spécifie s’il faut retourner les balises de système. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

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

Le paramètre Mailbox retourne les balises de rétention affectées à la stratégie de rétention appliquée à la boîte aux lettres spécifiée. Vous pouvez utiliser n’importe quelle valeur qui identifie la boîte aux lettres de manière unique. Par exemple :

  • Nom
  • Alias
  • Nom unique
  • Nom unique
  • Domaine\Nom d’utilisateur
  • Adresse e-mail
  • GUID
  • LegacyExchangeDN
  • SamAccountName
  • Identifiant utilisateur ou nom d’utilisateur principal (UPN)

Ce paramètre retourne uniquement les balises de stratégie par défaut (DPT) et les balises personnelles ; il ne retourne pas d’étiquettes de stratégie de rétention.

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

Le paramètre OptionalInMailbox est utilisé avec le paramètre Mailbox pour renvoyer toutes les balises de rétention d’adhésion qui sont affectées à la boîte aux lettres spécifiée. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

Une balise de rétention d’adhésion est une balise personnelle qui a été explicitement affectée à la boîte aux lettres avec la commande 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

Le paramètre Types spécifie le type de balise de rétention à renvoyer. Les valeurs valides sont les suivantes :

  • Calendrier
  • Contacts
  • DeletedItems
  • Brouillons
  • Boîte de réception
  • Courrier indésirable
  • Journal
  • Remarques
  • Boîte d’envoi
  • SentItems
  • Tâches
  • tous
  • RssSubscriptions
  • ConversationHistory
  • Personnel

Le paramètre accepte plusieurs valeurs séparées par une virgule.

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

Entrées

Input types

Pour visualiser les types d'entrées acceptés par cette cmdlet, consultez la rubrique Types d'entrée et de sortie de la cmdlet d'Exchange Management Shell. Si le champ Type d'entrée pour une cmdlet est vide, la cmdlet n'accepte pas les données d'entrée.

Sorties

Output types

Pour visualiser les types de retours, également appelés types de sorties, acceptés par cette cmdlet, consultez la rubrique Types d'entrée et de sortie de la cmdlet d'Exchange Management Shell. Si le champ Type de sortie est vide, la cmdlet ne renvoie pas de données.