Set-RetentionPolicyTag

 

S’applique à :Exchange Online, Exchange Server 2016

Dernière rubrique modifiée :2016-03-31

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

La cmdlet Set-RetentionPolicyTag permet de modifier les propriétés d’une balise de rétention.

Pour plus d’informations sur les balises de rétention, voir Balises et stratégies de rétention dans Exchange 2016.

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

Set-RetentionPolicyTag -Identity <RetentionPolicyTagIdParameter> [-AgeLimitForRetention <EnhancedTimeSpan>] [-MessageClass <String>] [-RetentionAction <MoveToDeletedItems | MoveToFolder | DeleteAndAllowRecovery | PermanentlyDelete | MarkAsPastRetentionLimit | MoveToArchive>] [-RetentionEnabled <$true | $false>] <COMMON PARAMETERS>

Set-RetentionPolicyTag -Mailbox <MailboxIdParameter> [-OptionalInMailbox <RetentionPolicyTagIdParameter[]>] <COMMON PARAMETERS>

COMMON PARAMETERS: [-Comment <String>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Force <SwitchParameter>] [-LegacyManagedFolder <ELCFolderIdParameter>] [-LocalizedComment <MultiValuedProperty>] [-LocalizedRetentionPolicyTagName <MultiValuedProperty>] [-MustDisplayCommentEnabled <$true | $false>] [-Name <String>] [-RetentionId <Guid>] [-SystemTag <$true | $false>] [-WhatIf [<SwitchParameter>]]

Cet exemple modifie le commentaire pour la balise de stratégie de rétention AllUsers-DeletedItems.

Set-RetentionPolicyTag "AllUsers-DeletedItems" -Comment "Items in the Deleted Items folder will be automatically deleted in 120 days"

Cet exemple met des balises de rétention facultatives à la disposition de l’utilisateur Terry Adams à l’aide des paramètres Mailbox et OptionalInMailbox.

Set-RetentionPolicyTag -Mailbox "Terry Adams" -OptionalInMailbox "ProjectA","ProjectB"

Les balises de rétention sont utilisées pour appliquer les paramètres de rétention des messages aux dossiers et aux éléments d’une boîte aux lettres.

Des autorisations doivent vous être attribuées avant de pouvoir exécuter cette cmdlet. Bien que tous les paramètres de cette cmdlet soient répertoriés dans cette rubrique, 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 voir les autorisations qui vous sont nécessaires, voir Entrée « Gestion des enregistrements de messagerie » dans la rubrique Stratégie de messagerie et autorisations de conformité dans Exchange 2016.

 

Paramètre Obligatoire Type Description

Identity

Obligatoire

Microsoft.Exchange.Configuration.Tasks.RetentionPolicyTagIdParameter

Le paramètre Identity spécifie le nom, le nom unique (DN) ou le GUID de la balise de stratégie de rétention à modifier.

Mailbox

Obligatoire

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

Le paramètre Mailbox spécifie une boîte aux lettres pour l’affectation des balises d’acceptation.

importantImportant :
Vous devez utiliser ce paramètre avec le paramètre OptionalInMailbox.

AgeLimitForRetention

Facultatif

Microsoft.Exchange.Data.EnhancedTimeSpan

Le paramètre AgeLimitForRetention spécifie l’âge auquel la rétention est appliquée à un élément. La limite d’âge correspond au nombre de jours écoulés depuis la date de remise de l’élément ou la date de création d’un élément non remis. Si ce paramètre est absent et si le paramètre RetentionEnabled est défini sur $true, une erreur est renvoyée.

Comment

Facultatif

System.String

Le paramètre Comment spécifie un commentaire pour la balise de stratégie de rétention.

Confirm

Facultatif

System.Management.Automation.SwitchParameter

Le commutateur Confirm spécifie s’il faut afficher ou masquer l’invite de confirmation. L’incidence de ce commutateur sur la cmdlet varie selon que la cmdlet requiert une confirmation avant de poursuivre.

  • Les cmdlets destructives (par exemple, les cmdlets Remove-*) ont une pause intégrée qui vous oblige à confirmer la commande avant de poursuivre. Pour ces cmdlets, vous pouvez ignorer l’invite de confirmation à l’aide de cette syntaxe exacte : -Confirm:$false.

  • La plupart des autres cmdlets (par exemple, les cmdlets New-* et Set-*) n’ont pas de pause intégrée. Pour ces cmdlets, la spécification du commutateur Confirm sans valeur introduit une pause qui vous oblige à confirmer la commande avant de poursuivre.

DomainController

Facultatif

Microsoft.Exchange.Data.Fqdn

Ce paramètre est disponible uniquement dans Exchange 2016 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.

Force

Facultatif

System.Management.Automation.SwitchParameter

Le commutateur Force remplace la boîte de dialogue de confirmation affichée par la cmdlet lorsque vous utilisez le paramètre RetentionId.

LegacyManagedFolder

Facultatif

Microsoft.Exchange.Configuration.Tasks.ELCFolderIdParameter

Le paramètre LegacyManagedFolder spécifie le nom d’un dossier géré. La balise de rétention est créée au moyen des paramètres de rétention du dossier géré et de ses paramètres de contenu géré. Vous pouvez utiliser ce paramètre pour créer des balises de rétention fondées sur des dossiers gérés existants pour migrer des utilisateurs de stratégies de boîte aux lettres de dossier géré vers des stratégies de rétention.

LocalizedComment

Facultatif

Microsoft.Exchange.Data.MultiValuedProperty

Le paramètre LocalizedComment spécifie le commentaire localisé et la langue pour la balise de stratégie de rétention. Ce commentaire s’affiche dans Microsoft Outlook en fonction des paramètres régionaux de l’utilisateur.

LocalizedRetentionPolicyTagName

Facultatif

Microsoft.Exchange.Data.MultiValuedProperty

Le paramètre LocalizedRetentionPolicyTagName spécifie un nom localisé de la balise de stratégie de rétention. Ce nom s’affiche dans Outlook en fonction des paramètres régionaux de l’utilisateur.

MessageClass

Facultatif

System.String

Le paramètre MessageClass spécifie le type de message auquel la balise s’applique. S’il n’est spécifié, la valeur par défaut est définie sur *.

À l’exception d’une balise de stratégie par défaut (DPT) pour voicemail, Exchange ne prend pas en charge les balises de rétention pour différents types de messages. Seules les balises avec un paramètre MessageClass ayant pour valeur * sont prises en charge, et elles s’appliquent à tous les types de messages.

Pour créer une balise de stratégie par défaut (DPT) pour des messages vocaux, définissez le paramètre MessageClass sur voicemail et le paramètre Type sur All.

noteRemarque :
Une balise de stratégie par défaut (DPT) pour des messages vocaux s’applique uniquement aux messages vocaux de la messagerie unifiée Microsoft Exchange (identifiés par la valeur de la propriété IPM.Note.Microsoft.Voicemail* de PR_MESSAGE_CLASS MAPI).

MustDisplayCommentEnabled

Facultatif

System.Boolean

Le paramètre MustDisplayCommentEnabled spécifie si le commentaire peut être masqué ou non. La valeur par défaut est $true.

Name

Facultatif

System.String

Le paramètre Name spécifie le nom de la balise de stratégie de rétention.

OptionalInMailbox

Facultatif

Microsoft.Exchange.Configuration.Tasks.RetentionPolicyTagIdParameter[]

Le paramètre OptionalInMailbox est utilisé avec le paramètre Mailbox pour spécifier les balises d’acceptation de la stratégie de rétention dont peut disposer la boîte aux lettres.

RetentionAction

Facultatif

Microsoft.Exchange.Data.Directory.SystemConfiguration.RetentionActionType

Le paramètre RetentionAction permet de définir la mesure à prendre dans le cadre de la stratégie de rétention. Les valeurs valides sont les suivantes :

  • DeleteAndAllowRecovery   Supprime un message et permet la récupération à partir du dossier Éléments récupérables.

  • MarkAsPastRetentionLimit  Les messages sont marqués comme ayant dépassé la limite de rétention.

  • MoveToArchive   Déplace un message dans la boîte aux lettres d’archive de l’utilisateur. Vous pouvez utiliser cette action pour les balises de rétention du type All, Personal et RecoverableItems.

  • PermanentlyDelete   Supprime définitivement un message. Un message qui a été définitivement supprimé ne peut pas être récupéré à l’aide du dossier Éléments récupérables. Les messages définitivement supprimés ne sont pas renvoyés dans une détection, à moins que l’attente pour litige soit activée pour la boîte aux lettres.

noteRemarque :
Les actions MoveToDeletedItems et MoveToFolder sont disponibles, mais ne fonctionnent pas. Ces actions sont disponibles pour des mises à niveau à partir de la gestion d’enregistrements de messagerie (MRM) 1.0 (dossiers gérés) vers la MRM 2.0 (stratégies de rétention). La MRM 2.0 a été introduite dans Exchange 2010 Service Pack 1 (SP1).

Si ce paramètre est absent et si le paramètre RetentionEnabled est défini sur $true, une erreur est renvoyée.

RetentionEnabled

Facultatif

System.Boolean

Le paramètre RetentionEnabled spécifie si la balise est activée. Si elle est définie à $false, la balise est désactivée et aucune action de rétention n’est effectuée sur les messages auxquels la balise s’applique.

noteRemarque :
Les messages dont la balise est désactivée sont toujours considérés comme balisés. Ainsi, les balises de stratégie par défaut dans la stratégie de rétention de l’utilisateur ne sont pas appliquées à ces messages.

Si vous définissez le paramètre RetentionEnabled sur $false, la période de rétention de la balise a la valeur Jamais. Les utilisateurs peuvent appliquer cette balise aux éléments qui ne doivent jamais être supprimés ou déplacés vers l’archive. L’activation ultérieure de la balise peut engendrer la suppression ou l’archivage involontaire des éléments. Pour éviter cette situation, si une stratégie de rétention est temporairement désactivée, il est conseillé de changer le nom de cette balise pour que les utilisateurs ne soient pas tentés de l’utiliser (par exemple, DISABLED_<Original Name>).

RetentionId

Facultatif

System.Guid

Le paramètre RetentionId spécifie un autre ID de balise pour s’assurer que la balise de rétention détectée dans les éléments de boîte aux lettres balisés dans une organisation Exchange correspond à la balise utilisée lors du déplacement de la boîte aux lettres vers une autre organisation Exchange (par exemple, dans un déploiement entre forêts ou intersite quand une boîte aux lettres est déplacée d’un serveur Exchange sur site vers le nuage ou quand une boîte aux lettres en nuage est déplacée vers un serveur Exchange sur site).

importantImportant :
Il n’est habituellement pas nécessaire de spécifier ou de modifier le paramètre RetentionId pour une balise de rétention. Le paramètre est renseigné automatiquement par <nom_script> lors de l’importation des balises de rétention dans un déploiement entre forêts ou inter-site.

SystemTag

Facultatif

System.Boolean

Le paramètre SystemTag spécifie si la balise de stratégie de rétention est créée pour la fonctionnalité interne Exchange.

WhatIf

Facultatif

System.Management.Automation.SwitchParameter

Le commutateur WhatIf simule les actions de la commande. Vous pouvez utiliser ce commutateur pour afficher les modifications qui se produiraient sans réellement appliquer ces modifications. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

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.

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.

 
Afficher: