New-RetentionPolicyTag

內部部署 Exchange 和雲端式服務有提供此 Cmdlet。 有些參數和設定可能只限於某一環境。

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

欲了解更多關於保留標籤的資訊,請參閱 Exchange Server 中的保留標籤與保留政策

如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法

語法

RetentionPolicy (預設值)

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

UpgradeManagedFolder

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 的所有參數,但如果某些參數未包含在你分配的權限中,你可能無法存取這些參數。 若要尋找在組織中執行任何 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

適用:Exchange Server 2010

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

參數屬性

類型:RecipientIdParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

RetentionPolicy
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-AgeLimitForRetention

適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

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

參數屬性

類型:EnhancedTimeSpan
預設值:None
支援萬用字元:False
不要顯示:False

參數集

RetentionPolicy
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Comment

適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

Comment 參數會指定標記的註解。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Confirm

適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

Confirm 參數會指定要顯示或隱藏確認提示。 此切換對指令令的影響取決於指令令是否需要確認後才能繼續。

  • 破壞性的 Cmdlet (如 Remove-* cmdlets) 有內建暫停,它會先強迫您確認命令才會繼續作業。 對於這些 Cmdlet,您可以使用以下確切語法來略過確認提示:-Confirm:$false
  • 其他大部分的 Cmdlet (如 New-* 和 Set-* cmdlets) 則沒有內建暫停。 對於這些指令,若未設定 Confirm 開關,會產生暫停,迫使你在繼續前確認該指令。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False
別名:參見

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-DomainController

適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

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

DomainController 參數會指定此 Cmdlet 用來向 Active Directory 讀取或寫入資料的網域控制站。 您可以透過網域控制站的完整網域名稱 (FQDN) 來識別網域控制站。 例如,dc01.contoso.com。

參數屬性

類型:Fqdn
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-IsDefaultAutoGroupPolicyTag

適用:Exchange Online

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

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

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-IsDefaultModeratedRecipientsPolicyTag

適用:Exchange Online

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

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

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-JournalingEnabled

適用:Exchange Server 2010

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

參數屬性

類型:Boolean
預設值:None
支援萬用字元:False
不要顯示:False

參數集

RetentionPolicy
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-LabelForJournaling

適用:Exchange Server 2010

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

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

RetentionPolicy
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-LocalizedComment

適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

LocalizedComment 參數會指定當地語系化的註解與其語言。 當使用者的語言設定與此參數指定的語言相符時,Microsoft Outlook 及 Outlook 網頁版會顯示對應的在地化註解。 註解會以 ISO 語言代碼:註解的形式來指定,例如:LocalizedComment EN-US:"This is a localized comment in U.S. English"。

參數屬性

類型:MultiValuedProperty
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-LocalizedRetentionPolicyTagName

適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

LocalizedRetentionPolicyTagName 參數會指定當地語系化的標記名稱與其語言。 當使用者的語言設定與此參數指定的語言相符時,Outlook 及 Outlook 網頁版會顯示對應的在地標籤名稱。 名稱會以 ISO 語言代碼:名稱的形式來指定,例如:LocalizedRetentionPolicyTagName EN-US:"Business Critical"。

參數屬性

類型:MultiValuedProperty
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ManagedFolderToUpgrade

適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

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

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

參數屬性

類型:ELCFolderIdParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

UpgradeManagedFolder
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-MessageClass

適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

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

除了語音信箱 (預設的政策標籤 DPT) 外,Exchange 不支援不同訊息類型的保留標籤。 僅支援具有 * 之 MessageClass 的標記,而且它們適用於所有郵件類型。

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

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

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

RetentionPolicy
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-MessageFormatForJournaling

適用:Exchange Server 2010

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

參數屬性

類型:JournalingFormat
預設值:None
支援萬用字元:False
不要顯示:False

參數集

RetentionPolicy
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-MustDisplayCommentEnabled

適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

MustDisplayCommentEnabled 參數會指定是否可以隱藏註解。 預設值為 $true。

參數屬性

類型:Boolean
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Name

適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

Name 參數會指定標記的名稱。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:1
必要:True
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-RetentionAction

適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

RetentionAction 參數指定保留政策的動作。 有效值為:

  • DeleteAndAllowRecovery:刪除訊息並允許從可恢復物品資料夾中恢復。
  • DeleteAndAllowRecovery:會刪除郵件,並允許從可復原的項目資料夾進行復原。
  • MoveToArchive:將訊息移至使用者的檔案信箱。 你可以用這個動作來處理像是 All、Personal 和 RecoverableItems 這類保留標籤。
  • 永久刪除:永久刪除訊息。 永久刪除的訊息無法透過 Recoverable Items 資料夾來恢復。 永久刪除的郵件不會在證據調查中回傳,除非該信箱啟用訴訟暫停。

MoveToDeletedItems 和 MoveToFolder 動作可以使用,但沒有作用。 這些動作可以從郵件記錄管理 (MRM) 1.0 (受管理資料夾) 升級到 MRM 2.0 (保留原則)。 MRM 2.0 於 Exchange 2010 服務包 1 (SP1) 中引入。

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

參數屬性

類型:RetentionAction
預設值:None
支援萬用字元:False
不要顯示:False

參數集

RetentionPolicy
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-RetentionEnabled

適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

RetentionEnabled 參數會指定是否已啟用標記。 設定為 $false 時,則會停用標記,而在套用標記的郵件上不會採取任何保留動作。

帶有停用標籤的訊息仍被視為已標籤,因此使用者保留政策中與停用標籤相同類型的標籤不會套用到這些訊息上。

將 RetentionEnabled 參數設為 $false 時,標記的保留期間會顯示為 [永不]。 使用者可以將此標籤套用於他們希望標示永遠不應刪除或不應移入檔案庫的項目。 若後續啟用標籤,可能會導致項目不小心被刪除或歸檔。 為避免這種情況,若保留政策暫時被停用,建議更改該標籤名稱,以阻止使用者使用,例如 DISABLED_<Original Name>

參數屬性

類型:Boolean
預設值:None
支援萬用字元:False
不要顯示:False

參數集

RetentionPolicy
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-RetentionId

適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

RetentionId參數指定一個替代標籤ID,以確保在本地部署中標記的信箱項目上的保留標籤在將信箱移至雲端時與標籤相符,或雲端標記的信箱項目在將信箱移至本地Exchange伺服器時與標籤相符。 此參數用於跨單位部署。 您無須在只有內部部署的情況下指定此參數。

參數屬性

類型:Guid
預設值:None
支援萬用字元:False
不要顯示:False

參數集

RetentionPolicy
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-SystemTag

適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

SystemTag 參數指定該標籤是為內部 Exchange 功能所建立。

參數屬性

類型:Boolean
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Type

適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

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

  • 全部
  • 封存
  • 行事曆
  • 雜亂:僅在 Exchange Online 上提供。
  • 連絡人
  • 對話歷史
  • 刪除物品
  • 草稿
  • 收件匣
  • 日誌
  • 垃圾郵件
  • 遺產檔案期刊
  • ManagedCustomFolder
  • 注意事項
  • 寄件匣
  • 個人版
  • 可恢復項目
  • RSS訂閱
  • 已發送物品
  • 同步問題
  • 工作

若要建立預設原則標記 (DPT),請指定類型 All。 對於 RecoverableItems 類型的標記,其唯一有效的保留動作為 MoveToArchive。

參數屬性

類型:ElcFolderType
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-WhatIf

適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

WhatIf 開關顯示指令的功能,且不做任何修改。 您不需要使用此參數指定值。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False
別名:威斯康辛

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

CommonParameters

此 cmdlet 支援常見參數:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters

輸入

Input types

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

輸出

Output types

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