New-RetentionPolicyTag

參考

模組:: ExchangePowerShell

適用於:: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

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

使用 New-RetentionPolicyTag 指令程式可建立保留標記。

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

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

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

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

保留標記支援以當地語系化的語言顯示標記名稱和選用註解。基於此目的，會使用來自 CultureInfo 類別的語言文化代碼。

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

範例

範例 1

New-RetentionPolicyTag "Finance-DeletedItems" -Type DeletedItems -RetentionEnabled $true -AgeLimitForRetention 30 -RetentionAction PermanentlyDelete

此範例會為 [刪除的郵件] 預設資料夾建立保留原則標記 Finance-DeletedItems。當套用到信箱作為保留原則的一部分時，標記會在 30 天後永久刪除 [刪除的郵件] 資料夾中所有類型的項目。

範例 2

New-RetentionPolicyTag "Finance-Default" -Type All -RetentionEnabled $true -AgeLimitForRetention 365 -RetentionAction PermanentlyDelete

此範例會建立預設原則標記 Finance-Default。當套用到信箱作為保留原則的一部分時，標記會永久刪除 365 天內沒有保留標記的所有項目。存在預設標記 (類型為 All 的保留標記) 的特定郵件類別項目 (例如語音信箱)，將不會受到影響。

範例 3

New-RetentionPolicyTag "Business Critical" -Type Personal -Comment "Use this tag for all business critical mail" -RetentionEnabled $true -AgeLimitForRetention 2556 -RetentionAction PermanentlyDelete

此範例會建立 Personal 類型的保留標記 Business Critical。當套用到信箱項目作為保留原則的一部分時，會在大約 7 年後永久刪除這些項目。

參數

-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

-IsDefaultAutoGroupPolicyTag

此參數只能在雲端式服務中使用。

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-IsDefaultModeratedRecipientsPolicyTag

此參數只能在雲端式服務中使用。

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	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

-LocalizedComment

LocalizedComment 參數會指定當地語系化的註解與其語言。當使用者的語言設定符合為此參數指定的語言時，Microsoft Outlook 和 Outlook 網頁版顯示對應的當地語系化批註。註解會以 ISO 語言代碼:註解的形式來指定，例如：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

LocalizedRetentionPolicyTagName 參數會指定當地語系化的標記名稱與其語言。當使用者的語言設定符合為此參數指定的語言時，Outlook 和 Outlook 網頁版會顯示對應的當地語系化標記名稱。名稱會以 ISO 語言代碼:名稱的形式來指定，例如：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

此參數僅適用於內部部署 Exchange。

ManagedFolderToUpgrade 參數會指定用作保留標記範本之受管理資料夾的名稱。

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

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

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 伺服器時的標記。此參數用於跨單位部署。您無須在只有內部部署的情況下指定此參數。

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

-Type

Type 參數會指定要建立之保留標記的類型。有效值包括：

全部
封存
行事曆
雜亂：僅適用于Exchange Online。
連絡人
ConversationHistory
DeletedItems
草稿
收件匣
日誌
垃圾郵件
LegacyArchiveJournals
ManagedCustomFolder
注意事項
寄件匣
個人版
RecoverableItems
RssSubscriptions
SentItems
SyncIssues
工作

若要建立預設原則標記 (DPT)，請指定類型 All。對於 RecoverableItems 類型的標記，其唯一有效的保留動作為 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

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

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

共用方式為

New-RetentionPolicyTag

Syntax

Description

範例

範例 1

範例 2

範例 3

參數

-AddressForJournaling

-AgeLimitForRetention

-Comment

-Confirm

-DomainController

-IsDefaultAutoGroupPolicyTag

-IsDefaultModeratedRecipientsPolicyTag

-JournalingEnabled

-LabelForJournaling

-LocalizedComment

-LocalizedRetentionPolicyTagName

-ManagedFolderToUpgrade

-MessageClass

-MessageFormatForJournaling

-MustDisplayCommentEnabled

-Name

-RetentionAction

-RetentionEnabled

-RetentionId

-SystemTag

-Type

-WhatIf

輸入

輸出

意見反應

其他資源