New-RetentionPolicyTag
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 New-RetentionPolicyTag permet de créer 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.
Syntax
New-RetentionPolicyTag
[-Name] <String>
[-AddressForJournaling <RecipientIdParameter>]
[-AgeLimitForRetention <EnhancedTimeSpan>]
[-Comment <String>]
[-Confirm]
[-DomainController <Fqdn>]
[-IsDefaultAutoGroupPolicyTag]
[-IsDefaultModeratedRecipientsPolicyTag]
[-JournalingEnabled <Boolean>]
[-LabelForJournaling <String>]
[-LocalizedComment <MultiValuedProperty>]
[-LocalizedRetentionPolicyTagName <MultiValuedProperty>]
[-MessageClass <String>]
[-MessageFormatForJournaling <JournalingFormat>]
[-MustDisplayCommentEnabled <Boolean>]
[-RetentionAction <RetentionAction>]
[-RetentionEnabled <Boolean>]
[-RetentionId <Guid>]
[-SystemTag <Boolean>]
[-Type <ElcFolderType>]
[-WhatIf]
[<CommonParameters>]
New-RetentionPolicyTag
[-Name] <String>
[-ManagedFolderToUpgrade <ELCFolderIdParameter>]
[-Comment <String>]
[-Confirm]
[-DomainController <Fqdn>]
[-IsDefaultAutoGroupPolicyTag]
[-IsDefaultModeratedRecipientsPolicyTag]
[-LocalizedComment <MultiValuedProperty>]
[-LocalizedRetentionPolicyTagName <MultiValuedProperty>]
[-MustDisplayCommentEnabled <Boolean>]
[-SystemTag <Boolean>]
[-Type <ElcFolderType>]
[-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.
Les balises de rétention prennent en charge l'affichage du nom de la balise et d'un commentaire facultatif dans les langues localisées. Les codes de culture linguistiques depuis la classe CultureInfo sont utilisés à cet effet.
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
New-RetentionPolicyTag "Finance-DeletedItems" -Type DeletedItems -RetentionEnabled $true -AgeLimitForRetention 30 -RetentionAction PermanentlyDelete
Cet exemple crée la balise de stratégie de rétention Finance-DeletedItems pour le dossier par défaut Éléments supprimés. Appliquée à une boîte aux lettres dans le cadre d'une stratégie de rétention, la balise supprime définitivement les éléments de tous les types figurant dans le dossier Éléments supprimés depuis 30 jours.
Exemple 2
New-RetentionPolicyTag "Finance-Default" -Type All -RetentionEnabled $true -AgeLimitForRetention 365 -RetentionAction PermanentlyDelete
Cet exemple crée la balise de stratégie par défaut Finance-Default. Appliquée à une boîte aux lettres dans le cadre d'une stratégie de rétention, la balise supprime définitivement tous les éléments sans balise de rétention dans les 365 jours. Les éléments d'une classe de message particulière telle que la messagerie vocale, pour laquelle une balise par défaut (une balise de rétention de type Tous) existe, ne sont pas affectés.
Exemple 3
New-RetentionPolicyTag "Business Critical" -Type Personal -Comment "Use this tag for all business critical mail" -RetentionEnabled $true -AgeLimitForRetention 2556 -RetentionAction PermanentlyDelete
Cet exemple crée la balise de rétention Business Critical de type Personnel. Appliqués aux éléments de la boîte aux lettres dans le cadre d'une stratégie de rétention, les éléments sont supprimés définitivement dans environ sept ans.
Paramètres
-AddressForJournaling
Ce paramètre n'est disponible que dans Exchange Server 2010.
Ce paramètre est réservé à l’usage interne chez Microsoft.
Type: | RecipientIdParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-AgeLimitForRetention
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.
Type: | EnhancedTimeSpan |
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 |
-Comment
Le paramètre Comment spécifie un commentaire pour la balise.
Type: | String |
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 |
-Confirm
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-*) ont 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.
Type: | SwitchParameter |
Aliases: | cf |
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 |
-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 |
-IsDefaultAutoGroupPolicyTag
Ce paramètre est disponible uniquement dans le service basé sur le cloud.
Ce paramètre est réservé à l’usage interne chez Microsoft.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Online |
-IsDefaultModeratedRecipientsPolicyTag
Ce paramètre est disponible uniquement dans le service basé sur le cloud.
Ce paramètre est réservé à l’usage interne chez Microsoft.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Online |
-JournalingEnabled
Ce paramètre n'est disponible que dans Exchange Server 2010.
Ce paramètre est réservé à l’usage interne chez Microsoft.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-LabelForJournaling
Ce paramètre n'est disponible que dans Exchange Server 2010.
Ce paramètre est réservé à l’usage interne chez Microsoft.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-LocalizedComment
Le paramètre LocalizedComment spécifie les commentaires localisés et leurs langues. Lorsque le paramètre de langue de l’utilisateur correspond à une langue spécifiée pour ce paramètre, Microsoft Outlook et Outlook sur le web afficher le commentaire localisé correspondant. Les commentaires sont indiqués sous la forme Code de langue ISO:commentaire, par exemple LocalizedComment EN-US:"This is a localized comment in U.S. English".
Type: | MultiValuedProperty |
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 |
-LocalizedRetentionPolicyTagName
Le paramètre LocalizedRetentionPolicyTagName spécifie les noms de balises localisés et leurs langues. Lorsque le paramètre de langue de l’utilisateur correspond à une langue spécifiée pour ce paramètre, Outlook et Outlook sur le web afficher le nom de la balise localisée correspondante. Les noms sont indiqués sous la forme Code de langue ISO:nom, par exemple LocalizedRetentionPolicyTagName EN-US:"Business Critical".
Type: | MultiValuedProperty |
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 |
-ManagedFolderToUpgrade
Ce paramètre est disponible uniquement dans Exchange sur site.
Le paramètre ManagedFolderToUpgrade spécifie le nom d’un dossier géré à utiliser comme modèle pour une balise de rétention.
Type: | ELCFolderIdParameter |
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 |
-MessageClass
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 une MessageClass de * 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.
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).
Type: | String |
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 |
-MessageFormatForJournaling
Ce paramètre n'est disponible que dans Exchange Server 2010.
Ce paramètre est réservé à l’usage interne chez Microsoft.
Type: | JournalingFormat |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-MustDisplayCommentEnabled
Le paramètre MustDisplayCommentEnabled spécifie si le commentaire peut être masqué ou non. La valeur par défaut est $true.
Type: | Boolean |
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 |
-Name
Le paramètre Name spécifie le nom de la balise.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-RetentionAction
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 de 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é en utilisant le 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.
Type: | RetentionAction |
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 |
-RetentionEnabled
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.
Les messages avec une balise désactivée sont toujours considérés comme étiquetés. Par conséquent, les balises du même type que la balise désactivée 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 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 .
Type: | Boolean |
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 |
-RetentionId
Le paramètre RetentionId spécifie un AUTRE ID de balise pour s’assurer que la balise de rétention trouvée sur les éléments de boîte aux lettres étiquetés dans un déploiement local correspond à la balise lorsque la boîte aux lettres est déplacée vers le cloud, ou que les éléments de boîte aux lettres étiquetés dans le cloud correspondent à l’étiquette lorsque la boîte aux lettres est déplacée vers un serveur Exchange local. Ce paramètre est utilisé dans les déploiements intersites. Il n'est pas nécessaire de spécifier ce paramètre dans les déploiements locaux uniquement.
Type: | Guid |
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 |
-SystemTag
Le paramètre SystemTag spécifie que la balise est créée pour la fonctionnalité Exchange interne.
Type: | Boolean |
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 |
-Type
Le paramètre Type spécifie le type de balise de rétention en cours de création. Les valeurs valides sont les suivantes :
- tous
- Archiver
- Calendrier
- Courrier pêle-mêle : disponible dans Exchange Online uniquement.
- Contacts
- ConversationHistory
- DeletedItems
- Brouillons
- Boîte de réception
- Journal
- Courrier indésirable
- LegacyArchiveJournals
- ManagedCustomFolder
- Remarques
- Boîte d’envoi
- Personnel
- RecoverableItems
- RssSubscriptions
- SentItems
- SyncIssues
- Tâches
Pour créer une balise de stratégie par défaut, spécifiez le type All. Pour les balises de type RecoverableItems, la seule action de rétention valide est MoveToArchive.
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 |
-WhatIf
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.
Type: | SwitchParameter |
Aliases: | wi |
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.