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>]

Description

範例

範例 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

您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號，請使用下列語法: "Value1","Value2",..."ValueN"。

參數屬性

參數集

-AddExchangeLocation

適用：安全性 & 合規性

當您未針對 ExchangeLocation 參數使用 All 值時，AddExchangeLocation 參數會指定要新增至內含信箱清單的信箱。 有效值為：

• ExchangeLocation 參數會指定要包含在原則中的信箱。有效值為：
• 信箱

所有信箱的 All 值。 您只能使用這個值本身。

• 名稱
• 名稱
• 辨別名稱 (DN)
• GUID

您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號，請使用下列語法: "Value1","Value2",..."ValueN"。

參數屬性

參數集

-AddExchangeLocationException

適用：安全性 & 合規性

當您針對 ExchangeLocation 參數使用 All 值時，AddExchangeLocationException 參數會指定要新增至排除信箱清單的信箱。 有效值為：

• 當您針對 ExchangeLocation 參數使用 All 值時，此參數會指定要從排除信箱清單中移除的信箱。有效值為：
• 信箱

所有信箱的 All 值。 您只能使用這個值本身。

• 名稱
• 名稱
• 辨別名稱 (DN)
• GUID

您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號，請使用下列語法: "Value1","Value2",..."ValueN"。

參數屬性

參數集

-AddModernGroupLocation

適用：安全性 & 合規性

當您未針對ModernGroupLocation 參數使用All值時，AddModernGroupLocation 參數會指定要新增至包含 Microsoft 365 群組 清單的 Microsoft 365 群組。

您可以使用可唯一識別Microsoft 365 群組的任何值。 例如：

• 名稱
• 名稱
• 辨別名稱 (DN)
• GUID

您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號，請使用下列語法: "Value1","Value2",..."ValueN"。

參數屬性

參數集

-AddModernGroupLocationException

適用：安全性 & 合規性

當您使用ModernGroupLocation 參數的All值時，AddModernGroupLocationException 參數會指定要新增至排除 Microsoft 365 群組 清單的 Microsoft 365 群組。

您可以使用可唯一識別Microsoft 365 群組的任何值。 例如：

• 名稱
• 名稱
• 辨別名稱 (DN)
• GUID

您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號，請使用下列語法: "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 參數會指定選擇性註解。 如果指定的值含有空格，則必須以雙引號 (") 括住值，例如︰"This is an admin note"。

參數屬性

參數集

-Confirm

適用：安全性 & 合規性

Confirm 參數會指定要顯示或隱藏確認提示。 這個參數對 Cmdlet 的影響取決於 Cmdlet 是否需要確認才能繼續作業。

• 破壞性的 Cmdlet (如 Remove-* cmdlets) 有內建暫停，它會先強迫您確認命令才會繼續作業。 對於這些 Cmdlet，您可以使用以下確切語法來略過確認提示：-Confirm:$false。
• 其他大部分的 Cmdlet (如 New-* 和 Set-* cmdlets) 則沒有內建暫停。 在使用這些 Cmdlet 時，指定不含任何值的 Confirm 參數會引入強迫您認可命令後才繼續作業的暫停。

參數屬性

參數集

-DeletedResources

適用：安全性 & 合規性

DeletedResources 參數會指定要新增為個別位置清單排除的已刪除信箱或郵件使用者。 針對需要從僅限 Teams 保留原則排除的已刪除信箱或郵件使用者，使用此參數搭配 AddTeamsChatLocationException 參數。

有效的值是 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

適用：安全性 & 合規性

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

您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號，請使用下列語法: "Value1","Value2",..."ValueN"。

參數屬性

參數集

-RemoveExchangeLocation

適用：安全性 & 合規性

RemoveExchangeLocation 參數會指定當您未針對 ExchangeLocation 參數使用 All 值時，要從內含信箱清單中移除的信箱。 有效值為：

• 當您針對 ExchangeLocation 參數使用 All 值時，此參數會指定要從排除信箱清單中移除的信箱。有效值為：
• 信箱

所有信箱的 All 值。 您只能使用這個值本身。

• 名稱
• 名稱
• 辨別名稱 (DN)
• GUID

您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號，請使用下列語法: "Value1","Value2",..."ValueN"。

參數屬性

參數集

-RemoveExchangeLocationException

適用：安全性 & 合規性

RemoveExchangeLocationException 參數會指定當您針對 ExchangeLocation 參數使用 All 值時，要從排除信箱清單中移除的信箱。 有效值為：

• 當您針對 ExchangeLocation 參數使用 All 值時，此參數會指定要從排除信箱清單中移除的信箱。有效值為：
• 信箱

所有信箱的 All 值。 您只能使用這個值本身。

• 名稱
• 名稱
• 辨別名稱 (DN)
• GUID

您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號，請使用下列語法: "Value1","Value2",..."ValueN"。

參數屬性

參數集

-RemoveModernGroupLocation

適用：安全性 & 合規性

RemoveModernGroupLocation 參數會指定當您未針對 ModernGroupLocation 參數使用 All 值時，要從包含群組清單中移除的 Microsoft 365 群組。

您可以使用可唯一識別Microsoft 365 群組的任何值。 例如：

• 名稱
• 名稱
• 辨別名稱 (DN)
• GUID

您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號，請使用下列語法: "Value1","Value2",..."ValueN"。

參數屬性

參數集

-RemoveModernGroupLocationException

適用：安全性 & 合規性

RemoveModernGroupLocationException 參數會指定當您使用 ModernGroupLocation 參數的 All 值時，要從排除群組清單中移除的 Microsoft 365 群組。

您可以使用可唯一識別Microsoft 365 群組的任何值。 例如：

• 名稱
• 名稱
• 辨別名稱 (DN)
• GUID

您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號，請使用下列語法: "Value1","Value2",..."ValueN"。

參數屬性

參數集

-RestrictiveRetention

適用：安全性 & 合規性

RestrictiveRetention 參數會指定是否啟用原則的保留鎖定。 有效值為：

• $true：已啟用原則的保留鎖定。 包括系統管理員在內的任何人員都無法關閉原則，或使其較不嚴格。
• $false：原則未啟用保留鎖定。 此值為預設值。

鎖定原則之後，沒有人可以關閉或停用原則，或從原則中移除應用程式。 您可以修改原則的唯一方式是將應用程式新增至原則，或延長其持續時間。 鎖定的原則可以增加或擴充，但無法減少、停用或關閉。

因此，在您鎖定原則之前，請務必瞭解組織的合規性需求，而且在確定這是您需要的原則之前，不要鎖定原則。

參數屬性

參數集

-RetryDistribution

適用：安全性 & 合規性

RetryDistribution 參數會指定是否要將原則重新發佈至所有位置。 您不需要使用此參數指定值。

初始配送成功的位置不包含在重試中。 當您使用此參數時會回報原則配送錯誤。

注意：因為重試散發的程式是一項相當重要的作業，所以請只在必要時執行它，並一次針對一個原則執行它。 並非要在每次更新原則時執行。 如果您執行腳本來更新多個原則，請等到原則發佈成功之後，再針對下一個原則再次執行命令。

參數屬性

參數集

-WhatIf

適用：安全性 & 合規性

WhatIf 開關無法在安全性與合規性 PowerShell 中使用。

參數屬性

參數集

CommonParameters