Set-RetentionPolicy
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-RetentionPolicy permet de modifier les propriétés d’une stratégie de rétention existante.
Pour plus d’informations sur les jeux de paramètres dans la section Syntaxe ci-après, voir Syntaxe da la cmdlet Exchange.
Syntaxe
Default (Par défaut)
Set-RetentionPolicy
[-Identity] <MailboxPolicyIdParameter>
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-IsDefault]
[-IsDefaultArbitrationMailbox]
[-Name <String>]
[-RetentionId <Guid>]
[-RetentionPolicyTagLinks <RetentionPolicyTagIdParameter[]>]
[-WhatIf]
[<CommonParameters>]
Description
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-RetentionPolicy "MyPolicy" -RetentionPolicyTagLinks "MyRetentionPolicyTag"
Cet exemple modifie la stratégie MyPolicy pour lier la balise de stratégie de rétention MyRetentionPolicyTag avec elle.
Le paramètre Identity est positionnel, ce qui signifie que vous pouvez l’utiliser sans l’étiquette -Identity dans l’emplacement pris en charge dans la commande (dans ce cas, tout d’abord). Pour plus d’informations sur les paramètres positionnels, consultez À propos des paramètres.
Paramètres
-Confirm
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Module complémentaire de sécurité intégré pour l’environnement local Boîtes aux lettres
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, Exchange Server SE
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 Server SE, 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 Server SE, Exchange Online, Module complémentaire de sécurité intégré pour l’environnement local Boîtes aux lettres
Le paramètre Identity spécifie le nom, le nom unique (DN) ou le GUID de la stratégie de rétention.
Propriétés du paramètre
| Type: | MailboxPolicyIdParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | 1 |
| Obligatoire: | True |
| Valeur du pipeline: | True |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | False |
-IsDefault
Applicable : Exchange Online
Ce paramètre est disponible uniquement dans le service basé sur le cloud.
Le commutateur IsDefault spécifie que cette stratégie de rétention est la stratégie de rétention par défaut. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.
Lorsque vous utilisez ce commutateur, vous recevez un avertissement indiquant que cette stratégie de rétention remplace la stratégie de rétention par défaut actuelle (la stratégie où la valeur de la propriété IsDefault est actuellement True) comme stratégie par défaut. Par défaut, la stratégie de rétention par défaut est nommée Stratégie MRM par défaut.
Remarque : la modification de la stratégie de rétention par défaut peut ou non affecter les boîtes aux lettres nouvelles et existantes en fonction de la valeur du paramètre RetentionPolicy sur tous les plans de boîte aux lettres :
- $null (vide) : les modifications auxquelles la stratégie de rétention est la stratégie de rétention par défaut sont continuellement reflétées dans les boîtes aux lettres nouvelles et existantes.
- Une stratégie de rétention est spécifiée : la valeur du paramètre RetentionPolicy pour tous les plans de boîte aux lettres doit être $null (vide) ou correspondre à la stratégie de rétention Exchange configurée comme stratégie par défaut pour le organization. Sinon, l’expérience peut être incohérente lors de la création de boîtes aux lettres, de l’activation des boîtes aux lettres désactivées et de la modification des licences. Pour plus d’informations, consultez Plans de boîte aux lettres dans Exchange Online.
Si une boîte aux lettres se voit attribuer une stratégie de rétention Exchange qui n’est pas la stratégie par défaut, la valeur RetentionPolicy de la boîte aux lettres est remplacée lors de la modification des licences. Vous devez réinitialiser manuellement la stratégie de rétention à la valeur d’origine.
Les modifications apportées à la stratégie de rétention par défaut qui affectent les boîtes aux lettres existantes peuvent potentiellement saturer le réseau si des centaines ou des milliers de boîtes aux lettres nécessitent des mises à jour.
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 |
-IsDefaultArbitrationMailbox
Applicable : Exchange Online
Ce paramètre est disponible uniquement dans le service basé sur le cloud.
Le commutateur IsDefaultArbitrationMailbox configure cette stratégie en tant que stratégie de rétention par défaut pour les boîtes aux lettres d’arbitrage dans votre Exchange Online organization. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.
Ce paramètre n’est pas disponible dans les déploiements sur site.
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 |
-Name
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Le paramètre Name spécifie un nom unique pour la 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 |
-RetentionId
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Le paramètre RetentionId spécifie l’identité de la stratégie de rétention pour s’assurer que les boîtes aux lettres déplacées entre deux organisations Exchange continuent d’avoir la même stratégie de rétention appliquée. 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 qu’une boîte aux lettres basée sur le cloud est déplacée vers un serveur Exchange local, ce paramètre est utilisé pour s’assurer que la même stratégie de rétention est appliquée à la boîte aux lettres.
Il n’est généralement pas obligatoire de spécifier ou de modifier le paramètre RetentionId pour une balise de rétention. Ce paramètre est rempli automatiquement lors de l’importation des balises de rétention à l’aide du script Import-RetentionTags.ps1.
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 |
-RetentionPolicyTagLinks
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Le paramètre RetentionPolicyTagLinks spécifie l’identité des balises de stratégie de rétention à associer à la stratégie de rétention. Les boîtes aux lettres sur lesquelles est appliquée une stratégie de conservation contiennent des balises de rétention liées à cette stratégie de rétention.
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
(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 Server SE, Exchange Online, Module complémentaire de sécurité intégré pour l’environnement local Boîtes aux lettres
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.