Set-RetentionComplianceRule

  • 參考
模組:
ExchangePowerShell
適用於:
Security & Compliance

此 Cmdlet 僅適用于安全 & 性合規性 PowerShell。 如需詳細資訊，請參閱 安全 & 性合規性 PowerShell。

使用 Set-RetentionComplianceRule Cmdlet 來修改Microsoft Purview 合規性入口網站中的現有保留規則。

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

Syntax

Set-RetentionComplianceRule
   [-Identity] <ComplianceRuleIdParameter>
   [-ApplyComplianceTag <String>]
   [-Comment <String>]
   [-Confirm]
   [-ContentContainsSensitiveInformation <PswsHashtable[]>]
   [-ContentDateFrom <DateTime>]
   [-ContentDateTo <DateTime>]
   [-ContentMatchQuery <String>]
   [-ExcludedItemClasses <MultiValuedProperty>]
   [-ExpirationDateOption <String>]
   [-RetentionComplianceAction <String>]
   [-RetentionDuration <Unlimited>]
   [-RetentionDurationDisplayHint <HoldDurationHint>]
   [-WhatIf]
   [<CommonParameters>]

Description

若要在安全 & 性合規性 PowerShell 中使用此 Cmdlet，您必須獲指派許可權。 如需詳細資訊，請參閱 Microsoft Purview 合規性入口網站中的權限。

範例

範例 1

Set-RetentionComplianceRule -Identity "Internal Company Rule" -RetentionDuration 180 -RetentionDurationDisplayHint Days

此範例會變更名為「內部公司規則」之現有保留規則的保留期間。

參數

-ApplyComplianceTag

ApplyComplianceTag 參數會指定規則 (套用至電子郵件訊息或檔的標籤，這會影響) 保留內容的時間長度。 此參數的有效值是現有標籤的名稱。 如果值包含空格，請使用引號括住值。

您可以使用 Get-ComplianceTag 和 New-ComplianceTag Cmdlet 來檢視和建立標籤。

您無法將此參數與 Name 或 PublishComplianceTag 參數搭配使用。

您無法將此參數用於 Teams 保留規則。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-Comment

Comment 參數會指定選擇性註解。 如果指定的值含有空格，則必須以雙引號 (") 括住值，例如︰"This is an admin note"。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-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: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 中的敏感性資訊類型尋找的內容。

您無法將此參數用於 Teams 保留規則。

Type:PswsHashtable[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-ContentDateFrom

ContentDateFrom 參數會指定要納入之內容的日期範圍的開始日期。

在您要執行命令的電腦上，使用該電腦的 [地區選項] 設定中定義的簡短日期格式。 例如，如果電腦設定成使用簡短日期格式 mm/dd/yyyy，請輸入 09/01/2018 以指定 2018 年 9 月 1 日。 您可以只輸入日期，或者也可以輸入日期和時間。 如果輸入日期和時間，請使用引號 (") 括住值，例如 "09/01/2018 5:00 PM"。

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-ContentDateTo

ContentDateTo 參數會指定要納入之內容的日期範圍的結束日期。

在您要執行命令的電腦上，使用該電腦的 [地區選項] 設定中定義的簡短日期格式。 例如，如果電腦設定成使用簡短日期格式 mm/dd/yyyy，請輸入 09/01/2018 以指定 2018 年 9 月 1 日。 您可以只輸入日期，或者也可以輸入日期和時間。 如果輸入日期和時間，請使用引號 (") 括住值，例如 "09/01/2018 5:00 PM"。

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-ContentMatchQuery

ContentMatchQuery 參數會指定內容搜尋篩選器。

此參數使用利用關鍵字查詢語言 (KQL) 格式化的文字搜尋字串或查詢。 如需詳細資訊，請 參閱關鍵字查詢語言 (KQL) 語法參考 和 eDiscovery 的關鍵字查詢和搜尋條件。

您無法將此參數用於 Teams 保留規則。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-ExcludedItemClasses

ExcludedItemClasses 參數會指定要從規則中排除的訊息類型。 您只能使用此參數來排除保留原則中的專案，這會排除保留指定的專案類別。 使用此參數不會從刪除原則中排除專案。 一般而言，您會使用此參數來排除語音信箱訊息、IM 交談及其他商務用 Skype線上內容不受保留原則的保留。 常見的商務用 Skype值包括：

  • Ipm。注意。Microsoft。談話
  • Ipm。注意。Microsoft。Conversation.Voice
  • Ipm。注意。Microsoft。錯過
  • Ipm。注意。Microsoft。Missed.Voice
  • Ipm。注意。Microsoft。語音 信箱
  • Ipm。注意。Microsoft.VoiceMessage.UA
  • Ipm。注意。Microsoft。Voicemail.UM
  • Ipm。注意。Microsoft.Voicemail.UM.CA

此外，您可以 指定 Exchange 專案的訊息類別 ，以及自訂或協力廠商訊息類別。 請注意，您指定的值不會經過驗證，因此 參數會接受任何文字值。

您可以使用下列語法來指定多個專案類別值： "Value1","Value2",..."ValueN" 。

您無法將此參數用於 Teams 保留規則。

Type:MultiValuedProperty
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-ExpirationDateOption

ExpirationDateOption 參數會指定要從內容建立日期或上次修改日期計算到期日。 有效值為：

  • CreationAgeInDays
  • ModificationAgeInDays

您無法將此參數用於 Teams 保留規則。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-Identity

Identity 參數會指定您要修改的保留規則。 您可以使用唯一識別規則的任何值。 例如：

  • 名稱
  • 辨別名稱 (DN)
  • GUID
Type:ComplianceRuleIdParameter
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Security & Compliance

-RetentionComplianceAction

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

  • 刪除
  • 保留
  • KeepAndDelete
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-RetentionDuration

RetentionDuration 參數會指定保留規則的保留期間。 有效值為：

  • 整數：保留期間以天為單位。
  • 無限制：內容會無限期保留。
Type:Unlimited
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-RetentionDurationDisplayHint

RetentionDurationDisplayHint 參數會指定用來在Microsoft Purview 合規性入口網站中顯示保留期間的單位。 有效值為 Days、Months 或 Years。

  • 天
  • 月
  • 年

例如，如果此參數設定為值 Years，且 RetentionDuration 參數設定為值 365，則Microsoft Purview 合規性入口網站會顯示 1 年作為內容保留期間。

您無法將此參數用於 Teams 保留規則。

Type:HoldDurationHint
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-WhatIf

WhatIf 參數無法在安全 & 性合規性 PowerShell 中運作。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance