Set-RetentionPolicy
內部部署 Exchange 和雲端式服務有提供此 Cmdlet。 有些參數和設定可能是某一個環境所專屬。
使用 Set-RetentionPolicy 指令程式變更現有保留原則的內容。
如需下方＜語法＞一節中參數集的詳細資訊，請參閱 Exchange Cmdlet 語法。
Syntax
Set-RetentionPolicy
[-Identity] <MailboxPolicyIdParameter>
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-IsDefault]
[-IsDefaultArbitrationMailbox]
[-Name <String>]
[-RetentionId <Guid>]
[-RetentionPolicyTagLinks <RetentionPolicyTagIdParameter[]>]
[-WhatIf]
[<CommonParameters>] Description
您必須已獲指派權限，才能執行此指令程式。 雖然本主題已列出這個指令程式的所有參數，不過，如果某些參數並未包含在指派給您的權限中，您可能就無法存取這些參數。 若要尋找在組織中執行任何 Cmdlet 或參數所需的權限，請參閱 Find the permissions required to run any Exchange cmdlet。
範例
範例 1
Set-RetentionPolicy "MyPolicy" -RetentionPolicyTagLinks "MyRetentionPolicyTag"此範例會修改 MyPolicy 原則，使其連結保留原則標記 MyRetentionPolicyTag。
Identity 參數是一個位置參數。 位置參數可在沒有標籤 (識別) 的情況下使用。 如需位置參數的詳細資訊，請參閱 關於參數。
參數
-Confirm
Confirm 參數會指定要顯示或隱藏確認提示。 這個參數對 Cmdlet 的影響取決於 Cmdlet 是否需要確認才能繼續作業。
- 例如，具破壞性的 Cmdlet (例如 Remove-* Cmdlet) 內建暫停，可強制您在繼續之前確認命令。 對於這些 Cmdlet，您可以使用以下確切語法來略過確認提示：
-Confirm:$false。 - 其他大部分的 Cmdlet (例如，New-* 和 Set-* Cmdlet) 沒有內建暫停。 在使用這些 Cmdlet 時，指定不含任何值的 Confirm 參數會引入強迫您認可命令後才繼續作業的暫停。
| 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, Exchange Online Protection |
-DomainController
此參數僅適用於內部部署 Exchange。
DomainController 參數會指定此 Cmdlet 用來向 Active Directory 讀取或寫入資料的網域控制站。 您可以透過網域控制站的完整網域名稱 (FQDN) 來識別網域控制站。 例如，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 |
-Force
Force 參數會隱藏警告或確認訊息。 您不需要使用此參數指定值。
當您使用 RetentionId 參數時，請使用此參數來隱藏確認提示。
| 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 |
-Identity
Identity 參數會指定保留原則的名稱、辨別名稱 (DN) 或 GUID。
| Type: | MailboxPolicyIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-IsDefault
此參數只能在雲端式服務中使用。
IsDefault 參數會指定此保留原則是預設保留原則。 您不需要使用此參數指定值。
當您使用此參數時，您會收到警告，指出此保留原則將會取代目前的預設保留原則， (IsDefault 屬性值目前為 True 的原則) 預設值。 根據預設，預設保留原則會命名為預設 MRM 原則。
注意：根據所有信箱方案上 RetentionPolicy 參數的值，變更預設的保留原則可能會或可能不會影響新的和現有的信箱：
- $null (空白) ：保留原則預設值的變更會持續反映在新的和現有的信箱中。
- 已指定保留原則：所有信箱方案的 RetentionPolicy 參數值應$null (空白) 或符合設定為組織預設原則的 Exchange 保留原則。 否則，建立新信箱、啟用停用的信箱，以及變更授權時，體驗可能會不一致。 如需詳細資訊，請參閱Exchange Online 中的信箱方案。
如果將不是預設原則的 Exchange 保留原則指派給信箱，變更授權時將會覆寫信箱的 RetentionPolicy 值，而且必須手動重設為原始值。
如果有數百或數千個需要更新的信箱，對影響現有信箱的預設保留原則變更可能會使網路飽和。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-IsDefaultArbitrationMailbox
此參數只能在雲端式服務中使用。
IsDefaultArbitrationMailbox 參數會將此原則設定為Exchange Online組織中仲裁信箱的預設保留原則。 您不需要使用此參數指定值。
內部部署中無法取得此參數。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Name
Name 參數會指定保留原則的唯一名稱。
| 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 |
-RetentionId
RetentionId 參數會指定保留原則的身分識別，以確保在兩個 Exchange 組織之間移動的信箱繼續套用相同的保留原則。 例如，在跨樹系部署或跨單位部署中，當信箱從內部部署 Exchange 伺服器移至雲端，或將雲端式信箱移至內部部署 Exchange 伺服器時，會使用此參數來確保將相同的保留原則套用至信箱。
通常不需要指定或修改保留標記的 RetentionId 參數。 使用 Import-RetentionTags.ps1 指令碼匯入保留標記時，就會自動填入此參數。
| 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 |
-RetentionPolicyTagLinks
RetentionPolicyTagLinks 參數會指定要與保留原則產生關聯之保留原則標記的識別碼。 已套用保留原則的信箱會有與該保留原則連結的保留標記。
| Type: | RetentionPolicyTagIdParameter[] |
| 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
WhatIf 參數會模擬命令的動作。 使用此參數時，您不需要實際套用變更即可檢視可能會發生的變更。 您不需要使用此參數指定值。
| 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, Exchange Online Protection |
輸入
Input types
若要查看此指令程式可接受的輸入類型，請參閱指令程式輸入和輸出類型。 如果指令程式的 [輸入類型] 欄位是空的，表示指令程式不接受輸入資料。
輸出
Output types
若要查看此指令程式可接受的傳回類型 (也就是所謂的輸出類型)，請參閱指令程式輸入和輸出類型。 如果 [輸出類型] 欄位是空的，表示指令程式不會傳回資料。