Set-RetentionPolicyTag
Cette cmdlet est disponible dans Exchange sur site et dans le service cloud. Certains paramètres et paramètres peuvent être exclusifs à un environnement ou à l’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, consultez Balises de rétention et stratégies de rétention dans Exchange Server.
Pour plus d’informations sur les jeux de paramètres dans la section Syntaxe ci-après, voir Syntaxe da la cmdlet Exchange.
Syntaxe
Identity
Set-RetentionPolicyTag
[-Identity] <RetentionPolicyTagIdParameter>
[-AddressForJournaling <RecipientIdParameter>]
[-AgeLimitForRetention <EnhancedTimeSpan>]
[-Comment <String>]
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-JournalingEnabled <Boolean>]
[-LabelForJournaling <String>]
[-LegacyManagedFolder <ELCFolderIdParameter>]
[-LocalizedComment <MultiValuedProperty>]
[-LocalizedRetentionPolicyTagName <MultiValuedProperty>]
[-MessageClass <String>]
[-MessageFormatForJournaling <JournalingFormat>]
[-MustDisplayCommentEnabled <Boolean>]
[-Name <String>]
[-RetentionAction <RetentionAction>]
[-RetentionEnabled <Boolean>]
[-RetentionId <Guid>]
[-SystemTag <Boolean>]
[-WhatIf]
[<CommonParameters>]
MailboxTask
Set-RetentionPolicyTag
-Mailbox <MailboxIdParameter>
[-Comment <String>]
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-LegacyManagedFolder <ELCFolderIdParameter>]
[-LocalizedComment <MultiValuedProperty>]
[-LocalizedRetentionPolicyTagName <MultiValuedProperty>]
[-MustDisplayCommentEnabled <Boolean>]
[-Name <String>]
[-OptionalInMailbox <RetentionPolicyTagIdParameter[]>]
[-RetentionId <Guid>]
[-SystemTag <Boolean>]
[-WhatIf]
[<CommonParameters>]
Description
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 cet article répertorie tous les paramètres de l’applet de commande, il se peut que vous n’ayez pas accès à certains paramètres s’ils ne sont pas inclus dans les autorisations qui vous sont 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
Set-RetentionPolicyTag "AllUsers-DeletedItems" -Comment "Items in the Deleted Items folder are automatically deleted in 120 days"
Cet exemple modifie le commentaire pour la balise de stratégie de rétention AllUsers-DeletedItems.
Exemple 2
Set-RetentionPolicyTag -Mailbox "Terry Adams" -OptionalInMailbox "ProjectA","ProjectB"
Cet exemple met des balises de rétention facultatives à la disposition de l’utilisateur Terry Adams à l’aide des paramètres Mailbox et OptionalInMailbox.
Paramètres
-AddressForJournaling
Applicable : Exchange Server 2010
Ce paramètre n'est disponible que dans Exchange Server 2010.
Ce paramètre est réservé à l’usage interne chez Microsoft.
Propriétés du paramètre
| Type: | RecipientIdParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
Identity
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-AgeLimitForRetention
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
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.
Propriétés du paramètre
| Type: | EnhancedTimeSpan |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
Identity
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Comment
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
Le paramètre Comment spécifie un commentaire pour la balise de stratégie de rétention.
Propriétés du paramètre
| Type: | String |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Confirm
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
Le commutateur Confirme 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 applets de commande destructrices (par exemple, les applets de commande Remove-*) comportent une pause intégrée qui vous oblige à accuser réception de la commande avant de continuer. Pour ces cmdlets, vous pouvez ignorer l’invite de confirmation à l’aide de cette syntaxe exacte :
-Confirm:$false. - La plupart des autres applets de commande (par exemple, les applets de commande 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.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
| Alias: | cf |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-DomainController
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
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 ».
Propriétés du paramètre
| Type: | Fqdn |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Force
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
Le commutateur Force masque les messages d’avertissement ou de confirmation. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.
Utilisez ce commutateur pour masquer l’invite de confirmation lorsque vous utilisez le paramètre RetentionId.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Identity
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
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.
Propriétés du paramètre
| Type: | RetentionPolicyTagIdParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
Identity
| Position: | 1 |
| Obligatoire: | True |
| Valeur du pipeline: | True |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | False |
-JournalingEnabled
Applicable : Exchange Server 2010
Ce paramètre n'est disponible que dans Exchange Server 2010.
Ce paramètre est réservé à l’usage interne chez Microsoft.
Propriétés du paramètre
| Type: | Boolean |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
Identity
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-LabelForJournaling
Applicable : Exchange Server 2010
Ce paramètre n'est disponible que dans Exchange Server 2010.
Ce paramètre est réservé à l’usage interne chez Microsoft.
Propriétés du paramètre
| Type: | String |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
Identity
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-LegacyManagedFolder
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
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.
Propriétés du paramètre
| Type: | ELCFolderIdParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-LocalizedComment
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
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.
Propriétés du paramètre
| Type: | MultiValuedProperty |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-LocalizedRetentionPolicyTagName
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
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.
Propriétés du paramètre
| Type: | MultiValuedProperty |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Mailbox
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
Le paramètre Mailbox spécifie une boîte aux lettres pour l’affectation des balises d’acceptation. 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)
Vous devez utiliser ce paramètre avec le paramètre OptionalInMailbox.
Propriétés du paramètre
| Type: | MailboxIdParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
MailboxTask
| Position: | Named |
| Obligatoire: | True |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-MessageClass
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
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 la messagerie vocale, Exchange ne prend pas en charge les étiquettes de rétention pour les différents types de messages. Seules les balises avec messageClass * sont prises en charge et 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.
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).
Propriétés du paramètre
| Type: | String |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
Identity
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-MessageFormatForJournaling
Applicable : Exchange Server 2010
Ce paramètre n'est disponible que dans Exchange Server 2010.
Ce paramètre est réservé à l’usage interne chez Microsoft.
Propriétés du paramètre
| Type: | JournalingFormat |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
Identity
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-MustDisplayCommentEnabled
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
Le paramètre MustDisplayCommentEnabled spécifie si le commentaire peut être masqué ou non. La valeur par défaut est $true.
Propriétés du paramètre
| Type: | Boolean |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Name
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
Le paramètre Name spécifie le nom de la balise de stratégie de rétention.
Propriétés du paramètre
| Type: | String |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-OptionalInMailbox
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
Le paramètre OptionalInMailbox est utilisé avec le paramètre Mailbox pour affecter des balises personnelles à la boîte aux lettres. Vous pouvez utiliser ce paramètre pour mettre à la disposition d’un utilisateur une balise personnelle qui n’est pas affectée à la stratégie de rétention appliquée à la boîte aux lettres spécifiée. Vous pouvez spécifier plusieurs balises personnelles séparées par des virgules.
Propriétés du paramètre
| Type: | RetentionPolicyTagIdParameter[] |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
MailboxTask
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-RetentionAction
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
Le paramètre RetentionAction spécifie l’action de la stratégie de rétention. Les valeurs valides sont les suivantes :
- DeleteAndAllowRecovery : supprime un message et autorise la récupération à partir du dossier Éléments récupérables.
- DeleteAndAllowRecovery : supprime un message et permet la récupération à partir du dossier Éléments récupérables.
- MoveToArchive : déplace un message vers la boîte aux lettres d’archivage 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 supprimé définitivement 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.
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). MRM 2.0 a été introduit 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.
Propriétés du paramètre
| Type: | RetentionAction |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
Identity
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-RetentionEnabled
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
Le paramètre RetentionEnabled spécifie si la balise est activée. Lorsqu’elle est définie sur $false, la balise est désactivée et aucune action de rétention n’est effectuée sur les messages auxquels la balise est appliquée.
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 qu’ils souhaitent indiquer ne doivent jamais être supprimés ou ne doivent jamais être déplacés vers l’archive. L’activation ultérieure de la balise peut entraîner la suppression ou l’archivage involontaires d’éléments. Pour éviter cette situation, si une stratégie de rétention est désactivée temporairement, il peut être recommandé de modifier le nom de cette balise afin que les utilisateurs soient découragés de l’utiliser, par DISABLED_<Original Name>exemple .
Propriétés du paramètre
| Type: | Boolean |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
Identity
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-RetentionId
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
Le paramètre RetentionId spécifie un AUTRE ID de balise pour garantir que la balise de rétention trouvée sur les éléments de boîte aux lettres étiquetés dans un organization Exchange correspond à la balise lorsque la boîte aux lettres est déplacée vers un autre organization Exchange (par exemple, dans un déploiement inter-forêts ou dans un déploiement intersite, lorsqu’une boîte aux lettres est déplacée d’un serveur Exchange local vers le cloud, ou une boîte aux lettres basée sur le cloud est déplacée vers un serveur Exchange local).
En règle générale, vous n’avez pas besoin de spécifier ou de modifier le paramètre RetentionId pour une balise de rétention. Ce paramètre est renseigné automatiquement lors de l’importation de balises de rétention dans un déploiement inter-forêts ou intersite.
Propriétés du paramètre
| Type: | Guid |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-SystemTag
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
Le paramètre SystemTag spécifie si la balise de stratégie de rétention est créée pour la fonctionnalité Exchange interne.
Propriétés du paramètre
| Type: | Boolean |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-WhatIf
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
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.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
| Alias: | Wi |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
CommonParameters
Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.
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.