New-CaseHoldPolicy
此 cmdlet 仅在安全性 & 合规性 PowerShell 中可用。 有关详细信息,请参阅 安全性 & 合规性 PowerShell。
使用 New-CaseHoldPolicy cmdlet 在Microsoft Purview 合规门户创建新的案例保留策略。
使用 New-CaseHoldPolicy cmdlet 创建事例保留策略后,需要使用 New-CaseHoldRule cmdlet 创建事例保留规则并将其分配到该策略。 如果不为该策略创建规则,将不会创建该保留,也不会将内容位置置于保留状态。
有关以下语法部分的参数设置的详细信息,请参阅 Exchange cmdlet 语法。
语法
New-CaseHoldPolicy
[-Name] <String>
-Case <String>
[-Comment <String>]
[-Confirm]
[-Enabled <Boolean>]
[-ExchangeLocation <MultiValuedProperty>]
[-Force]
[-PublicFolderLocation <MultiValuedProperty>]
[-SharePointLocation <MultiValuedProperty>]
[-WhatIf]
[<CommonParameters>]
说明
若要在安全性 & 合规性 PowerShell 中使用此 cmdlet,需要分配权限。 有关详细信息,请参阅 Microsoft Purview 合规门户中的权限。
示例
示例 1
New-CaseHoldPolicy -Name "Regulation 123 Compliance" -Case "123 Compliance Case" -ExchangeLocation "Kitty Petersen", "Scott Nakamura" -SharePointLocation "https://contoso.sharepoint.com/sites/teams/finance"
本示例为 Kitty Petersen 和 Scott Nakamura 的邮箱创建名为“条例 123 合规性”的案例保留策略,并为名为“123 Compliance Case”的电子数据展示案例创建财务 SharePoint Online 网站。
请记住,创建此策略后,需要通过使用 New-CaseHoldRule cmdlet 为该策略创建规则。
参数
-Case
Case 参数指定要与事例保留策略相关联的电子数据展示事例。 可以使用下列值来标识电子数据展示事例:
- 名称
- 标识(GUID 值)。
可以通过运行命令 Get-ComplianceCase | Format-Table -Auto Name,Status,Identity 查找这些值。
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
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 |
-Enabled
Enabled 参数指定启用还是禁用策略。 有效值包含:
- $true:已启用策略。 此值为默认值。
- $true:启用此策略。此为默认值。
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-ExchangeLocation
ExchangeLocation 参数指定要包含在策略中的邮箱。 有效值包含:
- ExchangeLocation 参数指定了要添加到策略中的邮箱。有效值为:
- 邮箱
若要指定邮箱或通讯组,可以使用以下值:
- 名称
- SMTP 地址。 若要指定非活动邮箱,请在地址前面加上句点 (.) 。
- Azure AD ObjectId。 使用 Microsoft Graph PowerShell 中的 Get-MgUser 或 Get-MgGroup cmdlet 查找此值。
Update 如果值包含空格或需要引号,请使用以下语法: "Value1","Value2",..."ValueN"
。
如果未指定任何邮箱,则不会将任何邮箱置于保留状态。
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-Force
强制开关隐藏警告或确认消息。 不必为此开关指定值。
您可以在以编程方式运行任务时使用此开关,因为此时并不适合提示用户提供管理输入。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-Name
Name 参数指定事例保留策略的唯一名称。 如果值包含空格,则使用引号括住该值。
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-PublicFolderLocation
PublicFolderLocation 参数指定要将所有公用文件夹包括到事例保留策略中。 可以对此参数使用值 All。
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-SharePointLocation
SharePointLocation 参数指定要包含的 SharePoint Online 和OneDrive for Business网站。 按 URL 值标识站点。
Update 如果值包含空格或需要引号,请使用以下语法: "Value1","Value2",..."ValueN"
。
在为网站编制索引之前,无法将其添加到策略。 如果未指定任何网站,则不会将任何网站置于保留状态。
Type: | MultiValuedProperty |
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 |