Set-RetentionPolicyTag

  • 參考
模組:
ExchangePowerShell
適用於:
Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

內部部署 Exchange 和雲端式服務有提供此 Cmdlet。 有些參數和設定可能是某一個環境所專屬。

使用 Set-RetentionPolicyTag 指令程式來修改保留標記的內容。

如需保留標記的詳細資訊，請參閱Exchange Server 中的保留標記和保留原則。

如需下方＜語法＞一節中參數集的詳細資訊，請參閱 Exchange Cmdlet 語法。

Syntax

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>]
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

保留標記是用於將郵件保留設定套用至信箱中的資料夾及項目。

您必須已獲指派權限，才能執行此指令程式。 雖然本主題已列出這個指令程式的所有參數，不過，如果某些參數並未包含在指派給您的權限中，您可能就無法存取這些參數。 若要尋找在組織中執行任何 Cmdlet 或參數所需的權限，請參閱 Find the permissions required to run any Exchange cmdlet。

範例

範例 1

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

本範例變更 AllUsers-DeletedItems 保留原則標記的註解。

範例 2

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

本範例使用 Mailbox 及 OptionalInMailbox 參數，讓使用者 Terry Adams 能夠使用選用的保留標記。

參數

-AddressForJournaling

此參數僅適用于 2010 Exchange Server。

將保留此參數供 Microsoft 內部使用。

Type:RecipientIdParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010

-AgeLimitForRetention

AgeLimitForRetention 參數會指定項目強制保留的存留期。 保留限制會對應到項目傳遞日起算的天數；若未傳遞，則對應到建立項目的日期。 如果沒有此參數，而且 RetentionEnabled 參數設為 $true，則會傳回錯誤。

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

Comment 參數會指定保留原則標記的註解。

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

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

-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:RetentionPolicyTagIdParameter
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

-JournalingEnabled

此參數僅適用于 2010 Exchange Server。

將保留此參數供 Microsoft 內部使用。

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010

-LabelForJournaling

此參數僅適用于 2010 Exchange Server。

將保留此參數供 Microsoft 內部使用。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010

-LegacyManagedFolder

LegacyManagedFolder 參數會指定受管理的資料夾名稱。 保留標記是透過使用保留設定，從受管理資料夾及其受管理的內容設定建立。 您可以使用此參數根據現有的受管理資料夾建立保留標記，將使用者從受管理資料夾信箱原則遷移到保留原則。

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, Exchange Online

-LocalizedComment

LocalizedComment 參數會指定保留原則標記的當地語系化註解及語言。 此批註會根據使用者的地區設定，顯示在 Microsoft Outlook 中。

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

LocalizedRetentionPolicyTagName 參數會指定保留原則標記的當地語系化名稱。 此名稱會根據使用者的地區設定顯示在 Outlook 中。

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

-Mailbox

Mailbox 參數會指定指派選擇加入標記的信箱。 您可以使用可唯一識別信箱的任何值。 例如：

  • 名稱
  • 別名
  • 辨別名稱 (DN)
  • 辨別名稱 (DN)
  • Domain\Username
  • 電子郵件地址
  • GUID
  • LegacyExchangeDN
  • SamAccountName
  • 使用者識別碼或使用者主要名稱 (UPN)

此參數必須搭配 OptionalInMailbox 參數使用。

Type:MailboxIdParameter
Position:Named
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

-MessageClass

MessageClass 參數會指定要套用標記的郵件類型。 若不指定，預設值會設為 *。

除了語音信箱的預設原則標記 (DPT) 外，Exchange 不支援不同訊息類型的保留標記。 僅支援 MessageClass 為 * 的標籤，且其適用于所有訊息類型。

若要替語音郵件訊息建立 DPT，請將 MessageClass 參數設定成 voicemail，並將 Type 參數設定成 All。

語音郵件訊息的 DPT 僅適用於 Microsoft Exchange 整合通訊語音郵件訊息 (以 PR_MESSAGE_CLASS MAPI 屬性值 IPM.Note.Microsoft.Voicemail* 識別)。

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

此參數僅適用于 2010 Exchange Server。

將保留此參數供 Microsoft 內部使用。

Type:JournalingFormat
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010

-MustDisplayCommentEnabled

MustDisplayCommentEnabled 參數會指定是否可以隱藏註解。 預設值為 $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

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

-OptionalInMailbox

OptionalInMailbox 參數會與 Mailbox 參數搭配使用，以將個人標籤指派給信箱。 您可以使用此參數，將未指派給套用至指定信箱之保留原則的個人標籤提供給使用者。 您可以指定多個以逗號分隔的個人標記。

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

-RetentionAction

RetentionAction 參數會指定保留原則的動作。 有效值為：

  • DeleteAndAllowRecovery：刪除訊息，並允許從 [可復原的專案] 資料夾復原。
  • DeleteAndAllowRecovery：會刪除郵件，並允許從可復原的項目資料夾進行復原。
  • MoveToArchive：將郵件移至使用者的封存信箱。 您可以將此動作用於 All、Personal 和 RecoverableItems 類型的保留標籤。
  • PermanentlyDelete：永久刪除訊息。 無法使用 [可復原的專案] 資料夾復原已永久刪除的訊息。 除非信箱已啟用訴訟保留，否則在探索搜尋中不會傳回永久刪除的郵件。

MoveToDeletedItems 和 MoveToFolder 動作可以使用，但沒有作用。 這些動作可以從郵件記錄管理 (MRM) 1.0 (受管理資料夾) 升級到 MRM 2.0 (保留原則)。 MRM 2.0 是在 Exchange 2010 Service Pack 1 (SP1) 中引進。

如果沒有此參數，而且 RetentionEnabled 參數設為 $true，則會傳回錯誤。

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

RetentionEnabled 參數會指定是否已啟用標記。 當設定為 $false 時，標記會停用，而且不會對套用標籤的訊息採取任何保留動作。

具有已停用標記的郵件仍會視為已標記，因此使用者保留原則中的任何預設原則標記都不會套用到這類郵件。

將 RetentionEnabled 參數設為 $false 時，標記的保留期間會顯示為 [永不]。 使用者可能將這個標記套用到要表示永不刪除或永不移到封存的項目。 稍後啟用標記可能導致非預期刪除或封存項目。 若要避免這種情況，如果暫時停用保留原則，建議您變更該標籤的名稱，以免使用者使用該標記，例如 DISABLED_<Original Name> 。

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

RetentionId 參數會指定替代標籤識別碼，以確保在一個 Exchange 組織中標記的信箱專案上找到的保留標記，會在信箱移至另一個 Exchange 組織時符合標記 (例如，在跨樹系部署或跨單位部署中，當信箱從內部部署 Exchange 伺服器移至雲端時， 或雲端式信箱會移至內部部署 Exchange Server) 。

一般而言，您不需要指定或修改保留標記的 RetentionId 參數。 在跨樹系或跨單位部署中匯入保留標籤時，會自動填入此參數。

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

SystemTag 參數會指定是否為內部 Exchange 功能建立保留原則標籤。

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

-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

輸入

Input types

若要查看此指令程式可接受的輸入類型，請參閱指令程式輸入和輸出類型。 如果指令程式的 [輸入類型] 欄位是空的，表示指令程式不接受輸入資料。

輸出

Output types

若要查看此指令程式可接受的傳回類型 (也就是所謂的輸出類型)，請參閱指令程式輸入和輸出類型。 如果 [輸出類型] 欄位是空的，表示指令程式不會傳回資料。