Set-AppRetentionCompliancePolicy

此 Cmdlet 僅適用於安全性與合規性 PowerShell。 如需詳細資訊,請參閱 安全性與合規性 PowerShell。

使用 Set-AppRetentionCompliancePolicy 來修改應用程式保留合規性原則。

如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法。

語法

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

*-AppRetentionCompliance* Cmdlet 用於具有調適性原則範圍的原則,以及 較新位置的保留 Cmdlet 中所述位置中的所有靜態原則。 您只能為所有包含的工作負載設定包含或排除的範圍清單,這表示您可能需要為每個工作負載建立一個原則。

*-RetentionCompliance* Cmdlet 繼續主要支援 舊位置的保留 Cmdlet 中所述的位置。

若要在安全性與合規性 PowerShell 中使用此 Cmdlet,您必須獲得指派權限。 如需詳細資訊,請參閱 Microsoft Purview 合規性入口網站中的權限。

範例

範例 1

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

本範例會將新使用者新增至為 Teams 私人頻道訊息所設定之名為法規 563 行銷的現有靜態範圍保留原則。

範例 2

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

此範例會從為 Teams 私人頻道訊息設定的保留原則中排除指定的虛刪除信箱或郵件使用者。 您可以使用信箱或郵件使用者的電子郵件地址來識別已刪除的資源。

重要: 在執行此命令之前,請務必閱讀有關重複 SMTP 位址的 DeletedResources 參數 警告資訊。

原則排除必須保持在保留原則支援的限制範圍內。 如需詳細資訊,請參閱 Microsoft 365 保留原則和保留標籤原則的限制。

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

此範例與範例 2 類似,但指定了多個已刪除的資源。

重要: 在執行此命令之前,請務必閱讀有關重複 SMTP 位址的 DeletedResources 參數 警告資訊。

參數

-AddAdaptiveScopeLocation

適用對象:安全性 & 合規性

AddAdaptiveScopeLocation 參數會指定要新增至原則的調適性範圍位置。 您可以使用 New-AdaptiveScope Cmdlet 建立調適性範圍。 您可以使用唯一識別調適性範圍的任何值。 例如:

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

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

參數屬性

類型:MultiValuedProperty
預設值:None
支援萬用字元:False
不要顯示:False

參數集

AdaptiveScopeLocation
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-AddExchangeLocation

適用對象:安全性 & 合規性

AddExchangeLocation 參數會指定當您未針對 ExchangeLocation 參數使用值 [全部] 時,要新增至所包含信箱清單的信箱。 有效值為:

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

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

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

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

參數屬性

類型:MultiValuedProperty
預設值:None
支援萬用字元:False
不要顯示:False

參數集

Identity
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-AddExchangeLocationException

適用對象:安全性 & 合規性

AddExchangeLocationException 參數會指定當您為 ExchangeLocation 參數使用值 [全部] 時,要新增至排除信箱清單的信箱。 有效值為:

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

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

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

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

參數屬性

類型:MultiValuedProperty
預設值:None
支援萬用字元:False
不要顯示:False

參數集

Identity
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-AddModernGroupLocation

適用對象:安全性 & 合規性

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

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

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

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

參數屬性

類型:MultiValuedProperty
預設值:None
支援萬用字元:False
不要顯示:False

參數集

Identity
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-AddModernGroupLocationException

適用對象:安全性 & 合規性

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

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

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

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

參數屬性

類型:MultiValuedProperty
預設值:None
支援萬用字元:False
不要顯示:False

參數集

Identity
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-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 and SQLCopilot,但這些值目前並不相關。

  • 企業 AI 應用程式:目前處於預覽階段。 您必須同時使用下列 所有 值:

    "User:Entrabased3PAIApps,ChatGPTEnterprise,AzureAIServices"

  • 其他 AI 應用程式: 目前處於預覽階段。 您必須同時使用下列 所有 值:

    "User:CloudAIAppChatGPTConsumer,CloudAIAppGoogleGemini,BingConsumer,DeepSeek"

參數屬性

類型:

String[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

Identity
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False
AdaptiveScopeLocation
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Comment

適用對象:安全性 & 合規性

Comment 參數會指定選擇性註解。 如果指定的值含有空格,則必須以雙引號 (") 括住值,例如︰"This is an admin note"。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

Identity
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False
AdaptiveScopeLocation
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False
TeamLocation
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Confirm

適用對象:安全性 & 合規性

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

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

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False
別名:CF

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-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 參數的命令之前,先將信箱置於 訴訟保留 狀態。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Enabled

適用對象:安全性 & 合規性

Enabled 參數會啟用或停用原則。 有效值為:

  • $true:已啟用原則。 此值為預設值。
  • $true:已啟用原則。此為預設值。

參數屬性

類型:Boolean
預設值:None
支援萬用字元:False
不要顯示:False

參數集

Identity
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False
AdaptiveScopeLocation
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False
TeamLocation
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Force

適用對象:安全性 & 合規性

強制開關會隱藏警告或確認訊息。 您不需要使用此參數指定值。

在不適合提示系統管理員輸入的場合中,您可以使用此參數來利用程式設計方式執行工作。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

Identity
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False
AdaptiveScopeLocation
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False
TeamLocation
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False
InformationBarrierDefault
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Identity

適用對象:安全性 & 合規性

Identity 參數會指定您要修改的應用程式保留合規性原則。 您可以使用唯一識別原則的任何值。 例如:

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

參數屬性

類型:PolicyIdParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:0
必要:True
來自管線的值:True
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-PolicyRBACScopes

適用對象:安全性 & 合規性

注意:目前不支援管理員單位,因此此參數無法運作。 此處所提供的資訊僅供參考,以在發行管理單位支援時之用。

PolicyRBACScopes 參數會指定要指派給原則的管理單位。 有效的值是管理單位的 Microsoft Entra ObjectID (GUID 值) 。 您可以指定多個以逗號分隔的值。

系統管理單位僅適用於 Microsoft Entra ID P1 或 P2。 您會在 Microsoft Graph PowerShell 中建立和管理管理單位。

參數屬性

類型:MultiValuedProperty
預設值:None
支援萬用字元:False
不要顯示:False

參數集

Identity
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-RemoveAdaptiveScopeLocation

適用對象:安全性 & 合規性

RemoveAdaptiveScopeLocation 參數會指定要從原則中移除的調適性範圍位置。 您可以使用 New-AdaptiveScope Cmdlet 建立調適性範圍。 您可以使用唯一識別調適性範圍的任何值。 例如:

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

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

參數屬性

類型:MultiValuedProperty
預設值:None
支援萬用字元:False
不要顯示:False

參數集

AdaptiveScopeLocation
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-RemoveExchangeLocation

適用對象:安全性 & 合規性

RemoveExchangeLocation 參數會指定當您未針對 ExchangeLocation 參數使用 [全部] 值時,要從包含的信箱清單中移除的信箱。 有效值為:

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

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

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

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

參數屬性

類型:MultiValuedProperty
預設值:None
支援萬用字元:False
不要顯示:False

參數集

Identity
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-RemoveExchangeLocationException

適用對象:安全性 & 合規性

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

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

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

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

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

參數屬性

類型:MultiValuedProperty
預設值:None
支援萬用字元:False
不要顯示:False

參數集

Identity
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-RemoveModernGroupLocation

適用對象:安全性 & 合規性

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

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

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

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

參數屬性

類型:MultiValuedProperty
預設值:None
支援萬用字元:False
不要顯示:False

參數集

Identity
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-RemoveModernGroupLocationException

適用對象:安全性 & 合規性

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

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

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

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

參數屬性

類型:MultiValuedProperty
預設值:None
支援萬用字元:False
不要顯示:False

參數集

Identity
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-RestrictiveRetention

適用對象:安全性 & 合規性

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

  • $true:已為原則啟用保留鎖定。 任何人(包括系統管理員)都無法關閉該原則或降低其限制。
  • $false:未為原則啟用保留鎖定。 此值為預設值。

鎖定原則之後,任何人都無法關閉或停用它,或從原則中移除應用程式。 修改原則的唯一方式是新增應用程式,或延長其持續時間。 鎖定原則可以增加或延長,但無法減少、停用或關閉。

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

參數屬性

類型:Boolean
預設值:None
支援萬用字元:False
不要顯示:False

參數集

Identity
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-RetryDistribution

適用對象:安全性 & 合規性

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

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

附註: 因為重試散發的程序是一項重大作業,所以請只在必要時執行,而且一次只執行一個原則。 它不應該在每次更新原則時執行。 如果您執行指令碼來更新多個原則,請等到原則發佈成功後,再針對下一個原則再次執行命令。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

RetryDistributionParameterSet
Position:Named
必要:True
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-WhatIf

適用對象:安全性 & 合規性

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

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False
別名:WI

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

CommonParameters

此 Cmdlet 支援常見參數: -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters。