New-RetentionComplianceRule
此 Cmdlet 僅適用於安全性與合規性 PowerShell。 如需詳細資訊,請參閱 安全性與合規性 PowerShell。
使用 New-RetentionComplianceRule Cmdlet 在Microsoft Purview 合規性入口網站中建立新的保留規則。
如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法。
語法
ComplianceTag
New-RetentionComplianceRule
-ApplyComplianceTag <String>
-Policy <PolicyIdParameter>
[-ContentContainsSensitiveInformation <PswsHashtable[]>]
[-Confirm]
[-ContentMatchQuery <String>]
[-ExpirationDateOption <String>]
[-IRMRiskyUserProfiles <String>]
[-MachineLearningModelIDs <MultiValuedProperty>]
[-PriorityCleanup]
[-RetentionComplianceAction <String>]
[-WhatIf]
[<CommonParameters>]
Default
New-RetentionComplianceRule
[-Name] <String>
-Policy <PolicyIdParameter>
[-Comment <String>]
[-ExcludedItemClasses <MultiValuedProperty>]
[-RetentionDuration <Unlimited>]
[-RetentionDurationDisplayHint <HoldDurationHint>]
[-Confirm]
[-ContentMatchQuery <String>]
[-ExpirationDateOption <String>]
[-PriorityCleanup]
[-RetentionComplianceAction <String>]
[-WhatIf]
[<CommonParameters>]
PublishComplianceTag
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 -RetentionComplianceAction Keep
此範例會建立名為 InternalCompanyRule 的新保留保留規則,並將它新增至名為 “Internal Company Policy” 的現有保留保留原則。 內容會無限期保留。
範例 2
New-RetentionComplianceRule -Name SeptOneYear -Policy "Internal Company Policy" -RetentionDuration 365 -RetentionComplianceAction KeepAndDelete -ExpirationDateOption ModificationAgeInDays
此範例會建立名為 SeptOneYear 的新保留規則,並將它新增至名為 “Internal Company Policy” 的現有保留原則。 內容會從上次修改內容之日起保留一年,然後才被刪除。
參數
-ApplyComplianceTag
適用對象:安全性 & 合規性
ApplyComplianceTag 參數會指定由規則 (套用於電子郵件訊息或文件的標籤,這會影響內容保留) 多久。 此參數的有效值是現有標籤的名稱。 如果值包含空格,請使用引號括住值。
您可以使用 Get-ComplianceTag 和 New-ComplianceTag Cmdlet 來檢視和建立標籤。
您無法將此參數與 Name 或 PublishComplianceTag 參數搭配使用。
您無法針對 Teams 保留規則使用此參數。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
ComplianceTag
| Position: | Named |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Comment
適用對象:安全性 & 合規性
Comment 參數會指定選擇性註解。 如果指定的值含有空格,則必須以雙引號 (") 括住值,例如︰"This is an admin note"。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
Default
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Confirm
適用對象:安全性 & 合規性
Confirm 參數會指定要顯示或隱藏確認提示。 此參數對 Cmdlet 的影響取決於 Cmdlet 是否需要確認才能繼續。
- 破壞性的 Cmdlet (如 Remove-* cmdlets) 有內建暫停,它會先強迫您確認命令才會繼續作業。 對於這些 Cmdlet,您可以使用以下確切語法來略過確認提示:
-Confirm:$false。 - 其他大部分的 Cmdlet (如 New-* 和 Set-* cmdlets) 則沒有內建暫停。 針對這些 Cmdlet,指定不帶值的 Confirm 參數會造成暫停,強制您在繼續之前先確認命令。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | CF |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-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[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
ComplianceTag
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ContentMatchQuery
適用對象:安全性 & 合規性
ContentMatchQuery 參數會指定內容搜尋篩選器。
此參數使用利用關鍵字查詢語言 (KQL) 格式化的文字搜尋字串或查詢。 如需詳細資訊,請參閱 關鍵字查詢語言 (KQL) 語法參考和電子文件探索的關鍵字查詢和搜尋條件。
您無法針對 Teams 保留規則使用此參數。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
ComplianceTag
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
Default
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ExcludedItemClasses
適用對象:安全性 & 合規性
ExcludedItemClasses 參數會指定要從規則中排除的訊息類型。 您只能使用此參數來從保留原則中排除項目,這將排除保留指定的項目類別。 使用此參數不會從刪除原則中排除項目。 一般而言,您會使用此參數來排除語音信箱訊息、IM 交談及其他商務用 Skype Online 內容,使其不受保留原則保留。 常見的商務用 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 項目和自訂或非 Microsoft 郵件類別 指定訊息類別 。 您指定的值不會驗證,因此參數接受任何文字值。
您可以使用下列語法指定多個項目類別值: "Value1","Value2",..."ValueN"。
您無法針對 Teams 保留規則使用此參數。
參數屬性
| 類型: | MultiValuedProperty |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
Default
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ExpirationDateOption
適用對象:安全性 & 合規性
ExpirationDateOption 參數會指定到期日是從內容建立日期或上次修改日期來計算。 有效值為:
- CreationAgeInDays
- ModificationAgeInDays
您無法針對 Teams 保留規則使用此參數。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-IRMRiskyUserProfiles
適用對象:安全性 & 合規性
{{ Fill IRMRiskyUserProfiles 描述 }}
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
ComplianceTag
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-MachineLearningModelIDs
適用對象:安全性 & 合規性
將保留此參數供 Microsoft 內部使用。
參數屬性
| 類型: | MultiValuedProperty |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
ComplianceTag
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Name
適用對象:安全性 & 合規性
Name 參數會指定保留規則的唯一名稱。 如果值包含空格,請使用引號括住值。
您無法將此參數與 ApplyComplianceTag 或 PublishComplianceTag 參數搭配使用。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
Default
| Position: | 1 |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Policy
適用對象:安全性 & 合規性
Policy 參數會指定要包含規則的原則。
參數屬性
| 類型: | PolicyIdParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-PriorityCleanup
適用對象:安全性 & 合規性
PriorityCleanup 參數可指定是否要建立與優先順序清除原則相關聯的規則。 您不需要使用此參數指定值。
優先順序清除原則可覆寫任何現有的保留設定或電子文件探索保留,以加速刪除敏感性內容。 如需詳細資訊,請參閱 優先清除。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-PublishComplianceTag
適用對象:安全性 & 合規性
PublishComplianceTag 參數會指定針對規則發佈的標籤,讓應用程式 (例如 Outlook、SharePoint 和 OneDrive) 中的使用者可以看到標籤。 此參數的有效值是現有標籤的名稱。 如果值包含空格,請使用引號括住值。
您可以使用 Get-ComplianceTag 和 New-ComplianceTag Cmdlet 來檢視和建立標籤。
您無法在下列案例中使用此參數:
- 取代為 Name 或 ApplyComplianceTag 參數。
- 適用於 Teams 保留規則。
- 使用雲端附件原則。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
PublishComplianceTag
| Position: | Named |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-RetentionComplianceAction
適用對象:安全性 & 合規性
RetentionComplianceAction 參數會指定規則的保留動作。 有效值為:
- 刪除
- 保留
- KeepAndDelete
如果不使用此參數,則保留原則會建立為 “UniH” 原則,而不是 “mbx” 原則。 此參數為必要參數,以防止不符合規範的刪除。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-RetentionDuration
適用對象:安全性 & 合規性
RetentionDuration 參數會指定保留規則的保留持續時間。 有效值為:
- 整數:保留持續時間,以天為單位。
- 無限制:無限期保留內容。
參數屬性
| 類型: | Unlimited |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
Default
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-RetentionDurationDisplayHint
適用對象:安全性 & 合規性
RetentionDurationDisplayHint 參數會指定用來在 Microsoft Purview 合規性入口網站中顯示保留持續時間的單位。 有效值為:
- 天
- 月
- 年
例如,如果此參數設定為值 Years,而 RetentionDuration 參數設定為值 365,則 Microsoft Purview 合規性入口網站會將 1 年顯示為內容保留持續時間。
您無法針對 Teams 保留規則使用此參數。
參數屬性
| 類型: | HoldDurationHint |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
Default
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-WhatIf
適用對象:安全性 & 合規性
WhatIf 開關無法在安全性與合規性 PowerShell 中使用。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | WI |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
CommonParameters
此 Cmdlet 支援常見參數: -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters。