New-ComplianceRetentionEvent
此 cmdlet 仅在安全性 & 合规性 PowerShell 中可用。 有关详细信息,请参阅 安全性 & 合规性 PowerShell。
使用 New-ComplianceRetentionEvent cmdlet 在组织中创建符合性保留事件。
有关以下语法部分的参数设置的详细信息,请参阅 Exchange cmdlet 语法。
语法
New-ComplianceRetentionEvent
-Name <String>
[-AssetId <String>]
[-Comment <String>]
[-Confirm]
[-DomainController <Fqdn>]
[-EventDateTime <DateTime>]
[-EventTags <MultiValuedProperty>]
[-EventType <ComplianceRuleIdParameter>]
[-ExchangeAssetIdQuery <String>]
[-PreviewOnly]
[-SharePointAssetIdQuery <String>]
[-WhatIf]
[<CommonParameters>]
说明
若要在安全性 & 合规性 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 的属性或用于保留OneDrive for Business文档的属性中的 Property:Value 对。 例如:
- 产品代码:可用于仅保留特定产品的内容。
- 项目代码:可用于仅保留特定项目的内容。
- 员工 ID:可用于仅保留特定人员的内容。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-Comment
Comment 参数指定可选注释。 如果您指定包含空格的值,为该值加上双引号("),例如:"这是管理员备注"。
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 参数指定与符合性保留事件关联的标签的 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 for Business文档来限定符合性保留事件的范围。
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 |