Set-AppRetentionCompliancePolicy

语法

Identity （默认值）

Set-AppRetentionCompliancePolicy
    [-Identity] <PolicyIdParameter>
    [-AddExchangeLocation <MultiValuedProperty>]
    [-AddExchangeLocationException <MultiValuedProperty>]
    [-AddModernGroupLocation <MultiValuedProperty>]
    [-AddModernGroupLocationException <MultiValuedProperty>]
    [-Applications <String[]>]
    [-Comment <String>]
    [-Confirm]
    [-DeletedResources <String>]
    [-Enabled <Boolean>]
    [-Force]
    [-PolicyRBACScopes <MultiValuedProperty>]
    [-RemoveExchangeLocation <MultiValuedProperty>]
    [-RemoveExchangeLocationException <MultiValuedProperty>]
    [-RemoveModernGroupLocation <MultiValuedProperty>]
    [-RemoveModernGroupLocationException <MultiValuedProperty>]
    [-RestrictiveRetention <Boolean>]
    [-WhatIf]
    [<CommonParameters>]

AdaptiveScopeLocation

Set-AppRetentionCompliancePolicy
    [-Identity] <PolicyIdParameter>
    [-AddAdaptiveScopeLocation <MultiValuedProperty>]
    [-Applications <String[]>]
    [-Comment <String>]
    [-Confirm]
    [-DeletedResources <String>]
    [-Enabled <Boolean>]
    [-Force]
    [-RemoveAdaptiveScopeLocation <MultiValuedProperty>]
    [-WhatIf]
    [<CommonParameters>]

DisableRestrictiveRetentionParameterSet

Set-AppRetentionCompliancePolicy
    [-Identity] <PolicyIdParameter>
    [-Confirm]
    [-DeletedResources <String>]
    [-WhatIf]
    [<CommonParameters>]

InformationBarrierDefault

Set-AppRetentionCompliancePolicy
    [-Identity] <PolicyIdParameter>
    [-Confirm]
    [-DeletedResources <String>]
    [-Force]
    [-WhatIf]
    [<CommonParameters>]

OrganizationSegmentsDefault

Set-AppRetentionCompliancePolicy
    [-Identity] <PolicyIdParameter>
    [-Confirm]
    [-DeletedResources <String>]
    [-WhatIf]
    [<CommonParameters>]

RetryDistributionParameterSet

Set-AppRetentionCompliancePolicy
    [-Identity] <PolicyIdParameter>
    [-Confirm]
    [-RetryDistribution]
    [-WhatIf]
    [<CommonParameters>]

TeamLocation

Set-AppRetentionCompliancePolicy
    [-Identity] <PolicyIdParameter>
    [-Comment <String>]
    [-Confirm]
    [-DeletedResources <String>]
    [-Enabled <Boolean>]
    [-Force]
    [-WhatIf]
    [<CommonParameters>]

说明

示例

示例 1

Set-AppRetentionCompliancePolicy -Identity "Regulation 563 Marketing" -Applications "User:MicrosoftTeams","Group:MicrosoftTeams,VivaEngage" -AddExchangeLocation "Scott Smith" -Comment "Added new counsel, 9/9/21"

示例 2

$stringJson = @"
[{
     'EmailAddress': 'SalesUser@contoso.onmicrosoft.com'
}]
"@
Set-AppRetentionCompliancePolicy -Identity "Teams Private Channel Retention Policy" -AddExchangeLocationException "SalesUser@contoso.onmicrosoft.com" -DeletedResources $stringJson

示例 3

$stringJson = @"
[{
     'EmailAddress': 'SalesUser1@contoso.onmicrosoft.com'
},
{
     'EmailAddress': 'SalesUser2@contoso.onmicrosoft.com'
}]
"@
Set-AppRetentionCompliancePolicy -Identity "Teams Private Chat Retention Policy" -AddExchangeLocationException "SalesUser1@contoso.onmicrosoft.com", "SalesUser2@contoso.onmicrosoft.com" -DeletedResources $stringJson

参数

-AddAdaptiveScopeLocation

适用：安全 & 合规性

AddAdaptiveScopeLocation 参数指定要添加到策略的自适应范围位置。 使用 New-AdaptiveScope cmdlet 创建自适应范围。 可以使用唯一标识自适应范围的任何值。 例如：

• 名称
• 可分辨名称 (DN)
• GUID

Update 如果值中有空格或需要使用双引号，请使用以下语法："Value1","Value2",..."ValueN"。

参数属性

参数集

-AddExchangeLocation

适用：安全 & 合规性

当 ExchangeLocation 参数未使用值 All 时，AddExchangeLocation 参数指定要添加到包含邮箱列表的邮箱。 有效值包含:

• ExchangeLocation 参数指定了要添加到策略中的邮箱。有效值为：
• 邮箱

所有邮箱的值 All。 只能使用此值本身。

• 名称
• 名称
• 可分辨名称 (DN)
• GUID

Update 如果值中有空格或需要使用双引号，请使用以下语法："Value1","Value2",..."ValueN"。

参数属性

参数集

-AddExchangeLocationException

适用：安全 & 合规性

当对 ExchangeLocation 参数使用值 All 时，AddExchangeLocationException 参数指定要添加到已排除邮箱列表的邮箱。 有效值包含:

• 此参数指定了在对 ExchangeLocation 参数使用值 All 时要从已排除邮箱列表中删除的邮箱。有效值为：
• 邮箱

所有邮箱的值 All。 只能使用此值本身。

• 名称
• 名称
• 可分辨名称 (DN)
• GUID

Update 如果值中有空格或需要使用双引号，请使用以下语法："Value1","Value2",..."ValueN"。

参数属性

参数集

-AddModernGroupLocation

适用：安全 & 合规性

当未对 ModernGroupLocation 参数使用值 All 时，AddModernGroupLocation 参数指定要添加到包含Microsoft 365 组列表的Microsoft 365 组。

可以使用唯一标识 Microsoft 365 组的任何值。 例如：

• 名称
• 名称
• 可分辨名称 (DN)
• GUID

Update 如果值中有空格或需要使用双引号，请使用以下语法："Value1","Value2",..."ValueN"。

参数属性

参数集

-AddModernGroupLocationException

适用：安全 & 合规性

AddModernGroupLocationException 参数指定要在 ModernGroupLocation 参数使用值 All 时添加到已排除Microsoft 365 组列表中的Microsoft 365 组。

可以使用唯一标识 Microsoft 365 组的任何值。 例如：

• 名称
• 名称
• 可分辨名称 (DN)
• GUID

Update 如果值中有空格或需要使用双引号，请使用以下语法："Value1","Value2",..."ValueN"。

参数属性

参数集

-Applications

适用：安全 & 合规性

Applications 参数指定要包含在策略中的应用程序。

此参数使用以下语法： ： "LocationType:App1,LocationType:App2,...LocationType:AppN

LocationType 是“用户”或“组”。

App 是受支持的值，如以下示例所示。

• Microsoft 365 个应用：例如：

  "User:Exchange,User:OneDriveForBusiness,Group:Exchange,Group:SharePoint" 或 "User:MicrosoftTeams","User:VivaEngage"

• Microsoft Copilot体验：目前为预览版。 必须同时使用以下 所有 值：

  "User:M365Copilot,CopilotForSecurity,CopilotinFabricPowerBI,CopilotStudio,CopilotinBusinessApplicationplatformsSales,SQLCopilot"

  注意：即使必须使用 CopilotinBusinessApplicationplatformsSales 和 SQLCopilot，这些值目前也无关紧要。

• 企业 AI 应用：目前为预览版。 必须同时使用以下 所有 值：

  "User:Entrabased3PAIApps,ChatGPTEnterprise,AzureAIServices"

• 其他 AI 应用：目前为预览版。 必须同时使用以下 所有 值：

  "User:CloudAIAppChatGPTConsumer,CloudAIAppGoogleGemini,BingConsumer,DeepSeek"

参数属性

参数集

-Comment

适用：安全 & 合规性

Comment 参数指定可选注释。 如果您指定包含空格的值，为该值加上双引号(")，例如："这是管理员备注"。

参数属性

参数集

-Confirm

适用：安全 & 合规性

Confirm 开关指定是否显示确认提示。 此开关对 cmdlet 造成的影响取决于在你继续操作之前 cmdlet 是否需要确认。

• 破坏性 cmdlet（例如 Remove-* cmdlets）内置有暂停，可强制要求先确认命令，然后再继续操作。 对于这些 cmdlet，您可以使用此确切语法跳过确认提示：-Confirm:$false。
• 其他大多数 cmdlet（例如 New-* 和 Set-* cmdlet）都没有内置暂停。 对于这些 cmdlet，指定不含值的 Confirm 开关会引入暂停，从而强制要求你先确认命令，然后再继续操作。

参数属性

参数集

-DeletedResources

适用：安全 & 合规性

DeletedResources 参数指定要添加为相应位置列表的排除项的已删除邮箱或邮件用户。 将此参数与 AddTeamsChatLocationException 参数一起使用，用于已删除的邮箱或需要从仅 Teams 保留策略中排除的邮件用户。

有效值为 JSON 字符串。 有关此参数的语法和用法示例，请参阅示例部分。

有关非活动邮箱方案的信息，请参阅 了解非活动邮箱。

警告：此参数使用已删除邮箱或邮件用户的 SMTP 地址，也可能是为其他邮箱或邮件用户指定的。 如果在未先执行其他步骤的情况下使用此参数，则也会排除保留策略中具有相同 SMTP 地址的其他邮箱和邮件用户。 若要为具有相同 SMTP 地址的其他邮箱或邮件用户检查，请使用以下命令并将 替换为 user@contoso.com SMTP 地址以检查：Get-Recipient -IncludeSoftDeletedRecipients user@contoso.com | Select-Object DisplayName, EmailAddresses, Description, Alias, RecipientTypeDetails, WhenSoftDeleted

若要防止排除活动邮箱或具有相同 SMTP 地址的邮件用户，请先将邮箱置于 诉讼保留 状态，然后再使用 DeletedResources 参数运行命令。

参数属性

参数集

-Enabled

适用：安全 & 合规性

Enabled 参数启用或禁用策略。 有效值包含:

• $true：已启用策略。 此值为默认值。
• $true：启用此策略。此为默认值。

参数属性

参数集

-Force

适用：安全 & 合规性

强制开关隐藏警告或确认消息。 不必为此开关指定值。

您可以在以编程方式运行任务时使用此开关，因为此时并不适合提示用户提供管理输入。

参数属性

参数集

-Identity

适用：安全 & 合规性

Identity 参数指定要修改的应用保留符合性策略。 可以使用任何能够唯一标识该策略的值。 例如：

• 名称
• 可分辨名称 (DN)
• GUID

参数属性

参数集

-PolicyRBACScopes

适用：安全 & 合规性

注意：当前不支持管理员单位，因此此参数不起作用。 此处提供的信息用于发布对管理单元的支持时的信息。

PolicyRBACScopes 参数指定要分配给策略的管理单元。 有效值是管理单元的 Microsoft Entra ObjectID (GUID 值) 。 可以指定用逗号分隔的多个值。

管理单元仅在 Microsoft Entra ID P1 或 P2 中可用。 在 Microsoft Graph PowerShell 中创建和管理管理单元。

参数属性

参数集

-RemoveAdaptiveScopeLocation

适用：安全 & 合规性

RemoveAdaptiveScopeLocation 参数指定要从策略中删除的自适应范围位置。 使用 New-AdaptiveScope cmdlet 创建自适应范围。 可以使用唯一标识自适应范围的任何值。 例如：

• 名称
• 可分辨名称 (DN)
• GUID

Update 如果值中有空格或需要使用双引号，请使用以下语法："Value1","Value2",..."ValueN"。

参数属性

参数集

-RemoveExchangeLocation

适用：安全 & 合规性

RemoveExchangeLocation 参数指定要在未对 ExchangeLocation 参数使用值 All 时从包含邮箱列表中删除的邮箱。 有效值包含:

• 此参数指定了在对 ExchangeLocation 参数使用值 All 时要从已排除邮箱列表中删除的邮箱。有效值为：
• 邮箱

所有邮箱的值 All。 只能使用此值本身。

• 名称
• 名称
• 可分辨名称 (DN)
• GUID

Update 如果值中有空格或需要使用双引号，请使用以下语法："Value1","Value2",..."ValueN"。

参数属性

参数集

-RemoveExchangeLocationException

适用：安全 & 合规性

RemoveExchangeLocationException 参数指定要在对 ExchangeLocation 参数使用值 All 时从排除的邮箱列表中删除的邮箱。 有效值包含:

• 此参数指定了在对 ExchangeLocation 参数使用值 All 时要从已排除邮箱列表中删除的邮箱。有效值为：
• 邮箱

所有邮箱的值 All。 只能使用此值本身。

• 名称
• 名称
• 可分辨名称 (DN)
• GUID

Update 如果值中有空格或需要使用双引号，请使用以下语法："Value1","Value2",..."ValueN"。

参数属性

参数集

-RemoveModernGroupLocation

适用：安全 & 合规性

RemoveModernGroupLocation 参数指定要在未对 ModernGroupLocation 参数使用值 All 时从包含组列表中删除的Microsoft 365 组。

可以使用唯一标识 Microsoft 365 组的任何值。 例如：

• 名称
• 名称
• 可分辨名称 (DN)
• GUID

Update 如果值中有空格或需要使用双引号，请使用以下语法："Value1","Value2",..."ValueN"。

参数属性

参数集

-RemoveModernGroupLocationException

适用：安全 & 合规性

RemoveModernGroupLocationException 参数指定要在 ModernGroupLocation 参数使用值 All 时从排除组列表中删除的Microsoft 365 组。

可以使用唯一标识 Microsoft 365 组的任何值。 例如：

• 名称
• 名称
• 可分辨名称 (DN)
• GUID

Update 如果值中有空格或需要使用双引号，请使用以下语法："Value1","Value2",..."ValueN"。

参数属性

参数集

-RestrictiveRetention

适用：安全 & 合规性

限制性Retention 参数指定是否为策略启用保留锁。 有效值包含:

• $true：为策略启用保留锁。 任何人（包括管理员）都无法关闭策略或降低其限制。
• $false：未为策略启用保留锁定。 此值为默认值。

锁定策略后，任何人都无法关闭或禁用它，或从策略中删除应用。 修改策略的唯一方法是向策略添加应用或延长其持续时间。 可以增加或扩展锁定策略，但不能减少、禁用或关闭锁定策略。

因此，在锁定策略之前，必须了解组织的合规性要求，并且不要锁定策略，直到确定它符合你的需求。

参数属性

参数集

-RetryDistribution

适用：安全 & 合规性

RetryDistribution 开关指定是否将策略重新分发到所有位置。 不必为此开关指定值。

成功完成初始分发的位置不包括在重试范围内。 使用此开关时，会报告策略分配错误。

注意：由于重试分发的过程是一项重要作，因此仅在必要时运行它，一次运行一个策略。 并非每次更新策略时都会运行它。 如果运行脚本来更新多个策略，请等待策略分发成功，然后再次为下一个策略运行命令。

参数属性

参数集

-WhatIf

适用：安全 & 合规性

WhatIf 开关在安全与合规 PowerShell 中不起作用。

参数属性

参数集

CommonParameters