New-ComplianceRetentionEvent

此 Cmdlet 僅適用於安全性與合規性 PowerShell。 如需詳細資訊,請參閱 安全性與合規性 PowerShell。

使用 New-ComplianceRetentionEvent Cmdlet 在組織中建立合規性保留事件。

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

語法

Default (預設值)

New-ComplianceRetentionEvent
    -Name <String>
    [-AssetId <String>]
    [-Comment <String>]
    [-Confirm]
    [-DomainController <Fqdn>]
    [-EventDateTime <DateTime>]
    [-EventTags <MultiValuedProperty>]
    [-EventType <ComplianceRuleIdParameter>]
    [-ExchangeAssetIdQuery <String>]
    [-PreviewOnly]
    [-SharePointAssetIdQuery <String>]
    [-WhatIf]
    [<CommonParameters>]

Description

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

範例

範例 1

New-ComplianceRetentionEvent -Name "Research Project Employees" -EventTag 80e0d620-13ea-4ed9-b6a6-aa883278bcca -EventType e823b782-9a07-4e30-8091-034fc01f9347 -SharePointAssetIDQuery "EmployeeNumber:123456 EmployeeNumber:456789"

此範例使用下列設定建立名為 [研究專案員工] 的合規性保留事件:

  • 事件標籤: 80e0d620-13ea-4ed9-b6a6-aa883278bcca
  • EventTpe: e823b782-9a07-4e30-8091-034fc01f9347
  • SharePointAssetIDQuery: EmployeeNumber:123456 EmployeeNumber:456789

參數

-AssetId

適用對象:安全性 & 合規性

AssetId 參數會指定在用於保留的 SharePoint 或 OneDrive 文件屬性中找到的 ComplianceAssetId 值。 例如:

  • 產品代碼,您可以用來保留僅限特定產品的內容。
  • 專案代碼,您可以用來保留僅限特定專案的內容。
  • 員工識別碼,您可以用來保留僅限特定人員的內容。

參數屬性

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

參數集

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

-Comment

適用對象:安全性 & 合規性

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

參數屬性

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

參數集

(All)
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

-DomainController

適用對象:安全性 & 合規性

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

參數屬性

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

參數集

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

-EventDateTime

適用對象:安全性 & 合規性

EventDateTime 參數會指定事件的日期/時間。

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

參數屬性

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

參數集

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

-EventTags

適用對象:安全性 & 合規性

EventTags 參數會指定與合規性保留事件相關聯之標籤的 GUID 值。 執行下列命令以查看可用的 GUID 值: Get-ComplianceTag | Format-Table Name,GUID。

您可以指定多個以逗號分隔的值。

參數屬性

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

參數集

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

-EventType

適用對象:安全性 & 合規性

EventType 參數會指定事件的 GUID 值,以開始使用此事件類型的標籤保留期間。 執行下列命令以查看可用的 GUID 值: Get-ComplianceRetentionEventType | Format-Table Name,GUID。

參數屬性

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

參數集

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

-ExchangeAssetIdQuery

適用對象:安全性 & 合規性

ExchangeAssetIdQuery 參數會指定可用來設定合規性保留事件 Exchange 內容範圍的關鍵字。 如需詳細資料,請參閱 內容搜尋的關鍵字查詢和搜尋條件。

參數屬性

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

參數集

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

-Name

適用對象:安全性 & 合規性

Name 參數會指定合規性保留事件的唯一名稱。 最大長度為 64 個字元。 如果值包含空格,請使用引號 (") 括住值。

參數屬性

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

參數集

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

-PreviewOnly

適用對象:安全性 & 合規性

{{ Fill PreviewOnly description }}

參數屬性

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

參數集

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

-SharePointAssetIdQuery

適用對象:安全性 & 合規性

SharePointAssetIdQuery 參數會指定您在屬性 (中指定的一或多個屬性:值組,也稱為 SharePoint 和 OneDrive 文件的欄) ,以限定合規性保留事件的範圍。 例如,"EmployeeNumber:123456 EmployeeNumber:456789"。

參數屬性

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

參數集

(All)
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。