New-RetentionCompliancePolicy
此 cmdlet 仅在安全与合规中心 PowerShell 内可用。 有关更多信息,请参见 安全与合规中心 PowerShell。
使用 New-RetentionCompliancePolicy cmdlet 在Microsoft Purview 合规门户创建新的保留策略和新的保留标签策略。 创建新策略还需要使用 New-RetentionComplianceRule cmdlet。
有关以下语法部分的参数设置的详细信息,请参阅 Exchange cmdlet 语法。
语法
New-RetentionCompliancePolicy
[-Name] <String>
[-Applications <MultiValuedProperty>]
[-Comment <String>]
[-Confirm]
[-Enabled <Boolean>]
[-ExchangeLocation <MultiValuedProperty>]
[-ExchangeLocationException <MultiValuedProperty>]
[-Force]
[-IsSimulation]
[-ModernGroupLocation <MultiValuedProperty>]
[-ModernGroupLocationException <MultiValuedProperty>]
[-OneDriveLocation <MultiValuedProperty>]
[-OneDriveLocationException <MultiValuedProperty>]
[-PolicyRBACScopes <MultiValuedProperty>]
[-PolicyTemplateInfo <PswsHashtable>]
[-PriorityCleanup]
[-PublicFolderLocation <MultiValuedProperty>]
[-RestrictiveRetention <Boolean>]
[-RetainCloudAttachment <Boolean>]
[-SharePointLocation <MultiValuedProperty>]
[-SharePointLocationException <MultiValuedProperty>]
[-SkipPriorityCleanupConfirmation]
[-SkypeLocation <MultiValuedProperty>]
[-SkypeLocationException <MultiValuedProperty>]
[-WhatIf]
[<CommonParameters>]
New-RetentionCompliancePolicy
[-Name] <String>
[-Comment <String>]
[-Confirm]
[-Enabled <Boolean>]
[-Force]
[-IsSimulation]
[-PriorityCleanup]
[-RestrictiveRetention <Boolean>]
[-RetainCloudAttachment <Boolean>]
[-SkipPriorityCleanupConfirmation]
[-TeamsChannelLocation <MultiValuedProperty>]
[-TeamsChannelLocationException <MultiValuedProperty>]
[-TeamsChatLocation <MultiValuedProperty>]
[-TeamsChatLocationException <MultiValuedProperty>]
[-WhatIf]
[<CommonParameters>]
New-RetentionCompliancePolicy
[-Name] <String>
-AdaptiveScopeLocation <MultiValuedProperty>
[-Applications <MultiValuedProperty>]
[-Comment <String>]
[-Confirm]
[-Enabled <Boolean>]
[-Force]
[-IsSimulation]
[-PriorityCleanup]
[-RestrictiveRetention <Boolean>]
[-RetainCloudAttachment <Boolean>]
[-SkipPriorityCleanupConfirmation]
[-WhatIf]
[<CommonParameters>]
说明
在为保留策略添加规则 () 或为保留标签策略添加标签 () 之前,策略无效。 有关详细信息,请参阅 New-RetentionComplianceRule。 此外,必须至少定义一个位置参数才能创建保留策略或保留标签策略。
要在安全与合规中心 PowerShell 中使用此 cmdlet,必须分配权限。 有关详细信息,请参阅 [Microsoft Purview 合规门户中的权限]/purview/microsoft-365-compliance-center-permissions) 。
示例
示例 1
New-RetentionCompliancePolicy -Name "Regulation 123 Compliance" -ExchangeLocation "Kitty Petersen", "Scott Nakamura" -SharePointLocation "https://contoso.sharepoint.com/sites/teams/finance"
此示例为 Kitty Petersen 和 Scott Nakamura 的邮箱以及财务 SharePoint Online 网站创建名为“法规 123 符合性”的保留策略。
下一步是使用 New-RetentionComplianceRule cmdlet 将规则添加到保留策略。
示例 2
New-RetentionCompliancePolicy -Name "Marketing Department" -Enabled $true -SharePointLocation https://contoso.sharepoint.com -RetainCloudAttachment $true -Comment "Regulatory compliance for Marketing Dept."
此示例创建一个新的自动应用标签策略,该策略面向名为“营销部”的云附件,其中包含指定的详细信息。
下一步是使用 New-RetentionComplianceRule cmdlet 将保留标签添加到保留标签策略。
参数
-AdaptiveScopeLocation
AdaptiveScopeLocation 参数指定要包含在策略中的自适应范围位置。 使用 New-AdaptiveScope cmdlet 创建自适应范围。 可以使用唯一标识自适应范围的任何值。 例如:
- 名称
- 可分辨名称 (DN)
- GUID
类型: | MultiValuedProperty |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-Applications
应用程序参数指定在策略中包含Microsoft 365 组时的目标, (将 ModernGroups 参数设置为) 。 有效值包含:
-
Group:Exchange
用于连接到 Microsoft 365 组的邮箱。 -
Group:SharePoint
用于连接到 Microsoft 365 组的 SharePoint 网站。 -
"Group:Exchange,SharePoint"
用于连接到 Microsoft 365 组的邮箱和 SharePoint 网站。 - 空白 (
$null
) :这是默认值,在功能上等效于值"Group:Exchange,SharePoint"
。
类型: | MultiValuedProperty |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-Comment
Comment 参数指定可选注释。 如果您指定包含空格的值,为该值加上双引号("),例如:"这是管理员备注"。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-Confirm
Confirm 开关指定是否显示确认提示。 此开关对 cmdlet 造成的影响取决于在你继续操作之前 cmdlet 是否需要确认。
- 破坏性 cmdlet(例如 Remove-* cmdlets)内置有暂停,可强制要求先确认命令,然后再继续操作。 对于这些 cmdlet,您可以使用此确切语法跳过确认提示:
-Confirm:$false
。 - 其他大多数 cmdlet(例如 New-* 和 Set-* cmdlet)都没有内置暂停。 对于这些 cmdlet,指定不含值的 Confirm 开关会引入暂停,从而强制要求你先确认命令,然后再继续操作。
类型: | SwitchParameter |
别名: | cf |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-Enabled
Enabled 参数指定启用还是禁用策略。 有效值包含:
- $true:已启用策略。 此值为默认值。
- $true:启用此策略。此为默认值。
类型: | Boolean |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-ExchangeLocation
ExchangeLocation 参数指定要包含在策略中的邮箱。 有效值包含:
- ExchangeLocation 参数指定了要添加到策略中的邮箱。有效值为:
- 邮箱
- 所有邮箱的值 All。 您只能自行使用此值。
所有邮箱的值 All。 只能使用此值本身。
- 名称
- 名称
- 可分辨名称 (DN)
- GUID
Update 如果值中有空格或需要使用双引号,请使用以下语法:"Value1","Value2",..."ValueN"
。
如果未指定任何邮箱,则不会将任何邮箱置于保留状态。
类型: | MultiValuedProperty |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-ExchangeLocationException
当对 ExchangeLocation 参数使用值 All 时,ExchangeLocationException 参数指定要从策略中排除的邮箱。 有效值包含:
- 此参数指定了在对 ExchangeLocation 参数使用值 All 时要从已排除邮箱列表中删除的邮箱。有效值为:
- 邮箱
所有邮箱的值 All。 只能使用此值本身。
- 名称
- 名称
- 可分辨名称 (DN)
- GUID
Update 如果值中有空格或需要使用双引号,请使用以下语法:"Value1","Value2",..."ValueN"
。
类型: | MultiValuedProperty |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-Force
强制开关隐藏警告或确认消息。 不必为此开关指定值。
您可以在以编程方式运行任务时使用此开关,因为此时并不适合提示用户提供管理输入。
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-IsSimulation
IsSimulation 开关指定在模拟模式下创建策略。 不必为此开关指定值。
有关模拟模式的信息,请参阅 了解模拟模式。
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-ModernGroupLocation
ModernGroupLocation 参数指定要包含在策略中的Microsoft 365 组。 有效值包含:
- Microsoft 365 组
- 值 All 表示所有Microsoft 365 组。 您只能自行使用此值。
若要标识 Microsoft 365 组,可以使用唯一标识它的任何值。 例如:
- 名称
- 名称
- 可分辨名称 (DN)
- GUID
Update 如果值中有空格或需要使用双引号,请使用以下语法:"Value1","Value2",..."ValueN"
。
类型: | MultiValuedProperty |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-ModernGroupLocationException
ModernGroupLocationException 参数指定要在对 ModernGroupLocation 参数使用值 All 时从策略中排除Microsoft 365 组。
可以使用唯一标识 Microsoft 365 组的任何值。 例如:
- 名称
- 名称
- 可分辨名称 (DN)
- GUID
Update 如果值中有空格或需要使用双引号,请使用以下语法:"Value1","Value2",..."ValueN"
。
类型: | MultiValuedProperty |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-Name
Name 参数指定保留策略的唯一名称。 如果值包含空格,则使用引号括住该值。
类型: | String |
Position: | 1 |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-OneDriveLocation
OneDriveLocation 参数指定要包含OneDrive for Business网站。 可以按 URL 值标识网站,也可以使用值 All 添加所有网站。
Update 如果值中有空格或需要使用双引号,请使用以下语法:"Value1","Value2",..."ValueN"
。
类型: | MultiValuedProperty |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-OneDriveLocationException
此参数指定要在对 OneDriveLocation 参数使用值 All 时排除OneDrive for Business网站。 可以按 URL 值标识网站。
Update 如果值中有空格或需要使用双引号,请使用以下语法:"Value1","Value2",..."ValueN"
。
类型: | MultiValuedProperty |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-PolicyRBACScopes
PolicyRBACScopes 参数指定要分配给策略的管理单元。 有效值是管理单元的 Microsoft Entra ObjectID (GUID 值) 。 可以指定用逗号分隔的多个值。
管理单元仅在 Microsoft Entra ID P1 或 P2 中可用。 在 Microsoft Graph PowerShell 中创建和管理管理单元。
类型: | MultiValuedProperty |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-PolicyTemplateInfo
保留此参数以供 Microsoft 内部使用。
类型: | PswsHashtable |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-PriorityCleanup
{{ Fill PriorityCleanup Description }}
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-PublicFolderLocation
PublicFolderLocation 参数指定要在保留策略中包含所有公用文件夹。 可以对此参数使用值 All。
类型: | MultiValuedProperty |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-RestrictiveRetention
限制性Retention 参数指定是否为策略启用保留锁。 有效值包含:
- $true:为策略启用保留锁。 任何人(包括管理员)都无法关闭策略或降低其限制。
- $false:未为策略启用保留锁定。 此值为默认值。
锁定某个策略后,任何人都无法关闭或禁用它,也无法从策略中删除内容。 并且无法在保留期内修改或删除受策略约束的内容。 你只能通过向策略添加内容或延长其持续时间的方式来修改保留策略。 可以增加或扩展锁定策略,但不能减少、禁用或关闭锁定策略。
因此,在锁定保留策略之前,必须了解组织的合规性要求,并且不要锁定策略,直到你确定它符合你的需求。
类型: | Boolean |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-RetainCloudAttachment
注意:此参数目前为预览版,并非在所有组织中都可用,并且可能会发生更改。
RetainCloudAttachment 参数指定这是云附件策略。 有效值包含:
- $true:该策略是云附件策略。
- $false:该策略不是云附件策略。 此值为默认值。
对于值$true,只能使用以下位置参数:
- SharePointLocation 和 SharePointLocationException
- OneDriveLocation 和 OneDriveLocationException
- ModernGroupLocation 和 ModernGroupLocationException
使用云附件策略创建规则的标记可以是记录标签或法规标签。 不能使用云附件策略的发布标记来创建规则;仅支持应用标记。
retainCloudAttachment 参数在 Set-RetentionCompliancePolicy cmdlet 上不可用。
类型: | Boolean |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-SharePointLocation
SharePointLocation 参数指定要包含的 SharePoint Online 网站。 可以按 URL 值标识网站,也可以使用值 All 添加所有网站。
Update 如果值中有空格或需要使用双引号,请使用以下语法:"Value1","Value2",..."ValueN"
。
在为 SharePoint Online 网站编制索引之前,无法将其添加到策略。 如果未指定任何网站,则不会将任何网站置于保留状态。
类型: | MultiValuedProperty |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-SharePointLocationException
此参数指定要在对 SharePointLocation 参数使用值 All 时排除的 SharePoint Online 网站。 可以按 URL 值标识网站。
Update 如果值中有空格或需要使用双引号,请使用以下语法:"Value1","Value2",..."ValueN"
。
类型: | MultiValuedProperty |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-SkipPriorityCleanupConfirmation
{{ Fill SkipPriorityCleanupConfirmation Description }}
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-SkypeLocation
SkypeLocation 参数指定要包含在策略中的Skype for Business Online 用户。
可以使用任何能够唯一标识该用户的值。 例如:
- 名称
- 名称
- 可分辨名称 (DN)
- GUID
Update 如果值中有空格或需要使用双引号,请使用以下语法:"Value1","Value2",..."ValueN"
。
类型: | MultiValuedProperty |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-SkypeLocationException
保留此参数以供 Microsoft 内部使用。
类型: | MultiValuedProperty |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-TeamsChannelLocation
TeamsChannelLocation 参数指定要包含在策略中的 Teams。
可以使用唯一标识团队的任何值。 例如:
- 名称
- 电子邮件地址
- GUID
Update 如果值中有空格或需要使用双引号,请使用以下语法:"Value1","Value2",..."ValueN"
。
类型: | MultiValuedProperty |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-TeamsChannelLocationException
TeamsChannelLocationException 参数指定要在 TeamsChannelLocation 参数使用值 All 时排除的 Teams。 可以使用唯一标识团队的任何值。 例如:
- 名称
- 电子邮件地址
- GUID
Update 如果值中有空格或需要使用双引号,请使用以下语法:"Value1","Value2",..."ValueN"
。
类型: | MultiValuedProperty |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-TeamsChatLocation
TeamsChatLocation 参数指定要包含在策略中的 Teams 用户。
可以使用任何能够唯一标识该用户的值。 例如:
- 名称
- 名称
- 可分辨名称 (DN)
- GUID
Update 如果值中有空格或需要使用双引号,请使用以下语法:"Value1","Value2",..."ValueN"
。
类型: | MultiValuedProperty |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-TeamsChatLocationException
TeamsChatLocationException 参数指定要在对 TeamsChatLocation 参数使用值 All 时排除的 Teams 用户。 可以使用任何能够唯一标识该用户的值。 例如:
- 名称
- 名称
- 可分辨名称 (DN)
- GUID
Update 如果值中有空格或需要使用双引号,请使用以下语法:"Value1","Value2",..."ValueN"
。
类型: | MultiValuedProperty |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |
-WhatIf
WhatIf 开关在安全与合规 PowerShell 中不起作用。
类型: | SwitchParameter |
别名: | wi |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
适用于: | Security & Compliance |