New-ComplianceRetentionEvent
此 Cmdlet 僅適用于安全 & 性合規性 PowerShell。 如需詳細資訊,請參閱 安全 & 性合規性 PowerShell。
使用 New-ComplianceRetentionEvent Cmdlet 在您的組織中建立合規性保留事件。
如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法。
Syntax
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"
此範例會使用下列設定建立名為 Research Project Employees 的合規性保留事件:
- EventTag:80e0d620-13ea-4ed9-b6a6-aa883278bcca
- EventTpe:e823b782-9a07-4e30-8091-034fc01f9347
- SharePointAssetIDQuery:EmployeeNumber:123456 EmployeeNumber:456789
參數
-AssetId
AssetId 參數會指定 SharePoint 屬性中找到的 Property:Value 組,或商務用 OneDrive用於保留的檔。 例如:
- 產品代碼,您可以用來保留僅限特定產品的內容。
- 專案代碼,您可以用來保留僅限特定專案的內容。
- 員工識別碼,您可以用來保留僅限特定人員的內容。
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 |
-DomainController
將保留此參數供 Microsoft 內部使用。
Type: | Fqdn |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-EventDateTime
EventDateTime 參數會指定事件的日期時間。
在您要執行命令的電腦上,使用該電腦的 [地區選項] 設定中定義的簡短日期格式。 例如,如果電腦設定成使用簡短日期格式 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 |
-EventTags
EventTags 參數會指定標籤 tha 與合規性保留事件相關聯的 GUID 值。 執行下列命令以查看可用的 GUID 值: Get-ComplianceTag | Format-Table Name,GUID
。
您可以指定多個以逗號分隔的值。
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-EventType
EventType 參數會指定事件的 GUID 值,該事件會針對使用此事件種類的標籤啟動保留期間。 執行下列命令以查看可用的 GUID 值: Get-ComplianceRetentionEventType | Format-Table Name,GUID
。
Type: | ComplianceRuleIdParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-ExchangeAssetIdQuery
ExchangeAssetIdQuery 參數會指定用來為合規性保留事件設定 Exchange 內容約制的關鍵字。 如需詳細資訊,請 參閱內容搜尋的關鍵字查詢和搜尋條件。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-Name
Name 參數會指定合規性保留事件的唯一名稱。 最大長度為 64 個字元。 如果值包含空格,請使用引號 (") 括住值。
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-PreviewOnly
{{ Fill PreviewOnly Description }}
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-SharePointAssetIdQuery
SharePointAssetIdQuery 參數會指定您在屬性中指定的一或多個 Property:Value 配對, (也稱為 SharePoint 的資料行) ,並商務用 OneDrive檔來設定合規性保留事件的範圍。
Type: | String |
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 |