New-RetentionComplianceRule
此 Cmdlet 僅適用於安全性與合規性 PowerShell。 如需詳細資訊,請參閱 安全性與合規性 PowerShell。
使用 New-RetentionComplianceRule Cmdlet 在 Microsoft Purview 合規性入口網站 中建立新的保留規則。
如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法。
語法
New-RetentionComplianceRule
-ApplyComplianceTag <String>
-Policy <PolicyIdParameter>
[-ContentContainsSensitiveInformation <PswsHashtable[]>]
[-Confirm]
[-ContentMatchQuery <String>]
[-ExpirationDateOption <String>]
[-IRMRiskyUserProfiles <String>]
[-MachineLearningModelIDs <MultiValuedProperty>]
[-PriorityCleanup]
[-RetentionComplianceAction <String>]
[-WhatIf]
[<CommonParameters>]
New-RetentionComplianceRule
[-Name] <String>
-Policy <PolicyIdParameter>
[-Comment <String>]
[-ExcludedItemClasses <MultiValuedProperty>]
[-RetentionDuration <Unlimited>]
[-RetentionDurationDisplayHint <HoldDurationHint>]
[-Confirm]
[-ContentMatchQuery <String>]
[-ExpirationDateOption <String>]
[-PriorityCleanup]
[-RetentionComplianceAction <String>]
[-WhatIf]
[<CommonParameters>]
New-RetentionComplianceRule
-Policy <PolicyIdParameter>
-PublishComplianceTag <String>
[-Confirm]
[-ExpirationDateOption <String>]
[-PriorityCleanup]
[-RetentionComplianceAction <String>]
[-WhatIf]
[<CommonParameters>]
Description
保留規則必須使用 Policy 參數新增至現有的保留原則。 每個保留原則只能新增一個規則。
若要在安全性與合規性 PowerShell 中使用此 Cmdlet,您必須獲得指派權限。 如需詳細資訊,請參閱 Microsoft Purview 合規性入口網站中的權限。
範例
範例 1
New-RetentionComplianceRule -Name InternalCompanyRule -Policy "Internal Company Policy" -RetentionDuration Unlimited
此範例會建立名為 InternalCompanyRule 的新案例保留規則,並將它新增至名為「內部公司原則」的現有案例保留原則。 內容會無限期保留。
範例 2
New-RetentionComplianceRule -Name SeptOneYear -Policy "Internal Company Policy" -RetentionDuration 365 -RetentionComplianceAction KeepAndDelete -ExpirationDateOption ModificationAgeInDays
此範例會建立名為 9OneYear 的新保留規則,並將它新增至名為「內部公司原則」的現有保留原則。 內容會保留一年,從內容上次修改到刪除前一天起。
參數
-ApplyComplianceTag
ApplyComplianceTag 參數會指定規則 (套用至電子郵件訊息或檔的標籤,這會影響) 保留內容的時間長度。 此參數的有效值是現有標籤的名稱。 如果值包含空格,請使用引號括住值。
您可以使用 Get-ComplianceTag 和 New-ComplianceTag Cmdlet 來檢視和建立標籤。
您無法將此參數與 Name 或 PublishComplianceTag 參數搭配使用。
您無法將此參數用於 Teams 保留規則。
類型: | String |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-Comment
Comment 參數會指定選擇性註解。 如果指定的值含有空格,則必須以雙引號 (") 括住值,例如︰"This is an admin note"。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-Confirm
Confirm 參數會指定要顯示或隱藏確認提示。 這個參數對 Cmdlet 的影響取決於 Cmdlet 是否需要確認才能繼續作業。
- 破壞性的 Cmdlet (如 Remove-* cmdlets) 有內建暫停,它會先強迫您確認命令才會繼續作業。 對於這些 Cmdlet,您可以使用以下確切語法來略過確認提示:
-Confirm:$false
。 - 其他大部分的 Cmdlet (如 New-* 和 Set-* cmdlets) 則沒有內建暫停。 在使用這些 Cmdlet 時,指定不含任何值的 Confirm 參數會引入強迫您認可命令後才繼續作業的暫停。
類型: | SwitchParameter |
別名: | cf |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-ContentContainsSensitiveInformation
ContentContainsSensitiveInformation 參數會根據內容中的敏感性資訊類型比對,指定規則的條件。 規則會套用到包含指定之敏感資訊類型的內容。
此參數使用基本語法 @(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)
。 例如,@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})
。
使用 Get-DLPSensitiveInformationType cmdlet 列出貴組織的敏感資訊類型。 如需有關敏感性資訊類型的詳細資訊,請參閱 Exchange 中的敏感性資訊類型在找什麼。
您可以使用此參數搭配 ApplyComplianceTag 參數。
您無法將此參數用於 Teams 保留規則。
類型: | PswsHashtable[] |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-ContentMatchQuery
ContentMatchQuery 參數會指定內容搜尋篩選器。
此參數使用利用關鍵字查詢語言 (KQL) 格式化的文字搜尋字串或查詢。 如需詳細資訊,請 參閱關鍵詞查詢語言 (KQL) 語法參考 和 eDiscovery 的關鍵詞查詢和搜尋條件。
您無法將此參數用於 Teams 保留規則。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-ExcludedItemClasses
ExcludedItemClasses 參數會指定要從規則中排除的訊息類型。 您只能使用此參數來排除保留原則中的專案,這會排除保留指定的項目類別。 使用此參數不會從刪除原則中排除專案。 一般而言,您會使用此參數來排除語音信箱訊息、IM 交談及其他 商務用 Skype 在線內容不受保留原則的保留。 常見的 商務用 Skype 值包括:
- IPM。Note.Microsoft.Conversation
- IPM。Note.Microsoft.Conversation.Voice
- IPM。Note.Microsoft.Missed
- IPM。Note.Microsoft.Missed.Voice
- IPM。Note.Microsoft.Voicemail
- IPM.Note.Microsoft.VoiceMessage.UA
- IPM。Note.Microsoft.Voicemail.UM
- IPM.Note.Microsoft.Voicemail.UM.CA
此外,您可以 指定 Exchange 專案的訊息類別 ,以及自定義或第三方訊息類別。 請注意,您指定的值不會經過驗證,因此 參數會接受任何文字值。
您可以使用下列語法來指定多個項目類別值: "Value1","Value2",..."ValueN"
。
您無法將此參數用於 Teams 保留規則。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-ExpirationDateOption
ExpirationDateOption 參數會指定要從內容建立日期或上次修改日期計算到期日。 有效值為:
- CreationAgeInDays
- ModificationAgeInDays
您無法將此參數用於 Teams 保留規則。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-IRMRiskyUserProfiles
{{ 填滿 IRMRiskyUserProfiles 描述 }}
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-MachineLearningModelIDs
將保留此參數供 Microsoft 內部使用。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-Name
Name 參數會指定保留規則的唯一名稱。 如果值包含空格,請使用引號括住值。
您無法搭配 ApplyComplianceTag 或 PublishComplianceTag 參數使用此參數。
類型: | String |
Position: | 1 |
預設值: | None |
必要: | True |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-Policy
Policy 參數會指定要包含規則的原則。
類型: | PolicyIdParameter |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-PriorityCleanup
{{ Fill PriorityCleanup Description }}
類型: | SwitchParameter |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-PublishComplianceTag
PublishComplianceTag 參數會指定針對規則發佈的標籤,讓使用者在應用程式中看到標籤 (例如 Outlook、SharePoint 和 OneDrive) 。 此參數的有效值是現有標籤的名稱。 如果值包含空格,請使用引號括住值。
您可以使用 Get-ComplianceTag 和 New-ComplianceTag Cmdlet 來檢視和建立標籤。
在下列案例中,您無法使用此參數:
- 使用 Name 或 ApplyComplianceTag 參數。
- 針對 Teams 保留規則。
- 使用雲端附件原則。
類型: | String |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-RetentionComplianceAction
RetentionComplianceAction 參數會指定規則的保留動作。 有效值為:
- 刪除
- 保留
- KeepAndDelete
如果您未使用此參數,保留原則會建立為 “UniH” 原則,而不是 “mbx” 原則。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-RetentionDuration
RetentionDuration 參數會指定保留規則的保留期間。 有效值為:
- 整數:保留期間以天為單位。
- 無限制:內容會無限期保留。
類型: | Unlimited |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-RetentionDurationDisplayHint
RetentionDurationDisplayHint 參數會指定用來在 Microsoft Purview 合規性入口網站 中顯示保留期間的單位。 有效值為:
- 天
- 月
- 年
例如,如果此參數設定為值 Years,且 RetentionDuration 參數設定為值 365,則 Microsoft Purview 合規性入口網站 會顯示 1 年作為內容保留期間。
您無法將此參數用於 Teams 保留規則。
類型: | HoldDurationHint |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-WhatIf
WhatIf 開關無法在安全性與合規性 PowerShell 中使用。
類型: | SwitchParameter |
別名: | wi |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |