Set-AppRetentionCompliancePolicy
此 Cmdlet 僅適用於安全性與合規性 PowerShell。 如需詳細資訊,請參閱 安全性與合規性 PowerShell。
使用 Set-AppRetentionCompliancePolicy 來修改應用程式保留合規性原則。
如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法。
語法
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>]
Set-AppRetentionCompliancePolicy
[-Identity] <PolicyIdParameter>
[-AddAdaptiveScopeLocation <MultiValuedProperty>]
[-Applications <String[]>]
[-Comment <String>]
[-Confirm]
[-DeletedResources <String>]
[-Enabled <Boolean>]
[-Force]
[-RemoveAdaptiveScopeLocation <MultiValuedProperty>]
[-WhatIf]
[<CommonParameters>]
Set-AppRetentionCompliancePolicy
[-Identity] <PolicyIdParameter>
[-Confirm]
[-DeletedResources <String>]
[-WhatIf]
[<CommonParameters>]
Set-AppRetentionCompliancePolicy
[-Identity] <PolicyIdParameter>
[-Confirm]
[-DeletedResources <String>]
[-Force]
[-WhatIf]
[<CommonParameters>]
Set-AppRetentionCompliancePolicy
[-Identity] <PolicyIdParameter>
[-Confirm]
[-DeletedResources <String>]
[-WhatIf]
[<CommonParameters>]
Set-AppRetentionCompliancePolicy
[-Identity] <PolicyIdParameter>
[-Confirm]
[-RetryDistribution]
[-WhatIf]
[<CommonParameters>]
Set-AppRetentionCompliancePolicy
[-Identity] <PolicyIdParameter>
[-Comment <String>]
[-Confirm]
[-DeletedResources <String>]
[-Enabled <Boolean>]
[-Force]
[-WhatIf]
[<CommonParameters>]
Description
若要在安全性與合規性 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行銷。
參數
-AddAdaptiveScopeLocation
AddAdaptiveScopeLocation 參數會指定要新增至原則的調適型範圍位置。 您可以使用 New-AdaptiveScope Cmdlet 來建立調適型範圍。 您可以使用可唯一識別調適型範圍的任何值。 例如:
- 名稱
- 辨別名稱 (DN)
- GUID
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-AddExchangeLocation
當您未針對 ExchangeLocation 參數使用 All 值時,AddExchangeLocation 參數會指定要新增至內含信箱清單的信箱。 有效值為:
- ExchangeLocation 參數會指定要包含在原則中的信箱。有效值為:
- 信箱
所有信箱的 All 值。 您只能使用這個值本身。
- 名稱
- 名稱
- 辨別名稱 (DN)
- GUID
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-AddExchangeLocationException
當您針對 ExchangeLocation 參數使用 All 值時,AddExchangeLocationException 參數會指定要新增至排除信箱清單的信箱。 有效值為:
- 當您針對 ExchangeLocation 參數使用 All 值時,此參數會指定要從排除信箱清單中移除的信箱。有效值為:
- 信箱
所有信箱的 All 值。 您只能使用這個值本身。
- 名稱
- 名稱
- 辨別名稱 (DN)
- GUID
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-AddModernGroupLocation
當您未針對ModernGroupLocation 參數使用All值時,AddModernGroupLocation 參數會指定要新增至包含 Microsoft 365 群組 清單的 Microsoft 365 群組。
您可以使用可唯一識別Microsoft 365 群組的任何值。 例如:
- 名稱
- 名稱
- 辨別名稱 (DN)
- GUID
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-AddModernGroupLocationException
當您使用ModernGroupLocation 參數的All值時,AddModernGroupLocationException 參數會指定要新增至排除 Microsoft 365 群組 清單的 Microsoft 365 群組。
您可以使用可唯一識別Microsoft 365 群組的任何值。 例如:
- 名稱
- 名稱
- 辨別名稱 (DN)
- GUID
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-Applications
Applications 參數會指定要包含的應用程式,而且只與下列位置參數相關:
- ExchangeLocation
- ModernGroupLocation
- AdaptiveScopeLocation
此參數使用下列語法: "LocationtType:App1,LocationType:App2,...LocationType:AppN
其中 LocationType 是 User 或 Group。 例如,"User:Exchange,User:OneDriveForBusiness,Group:Exchange,Group:SharePoint"
或 "User:MicrosoftTeams","User:VivaEngage"
。
類型: | String[] |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-Comment
Comment 參數會指定選擇性註解。 如果指定的值含有空格,則必須以雙引號 (") 括住值,例如︰"This is an admin note"。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-Confirm
Confirm 參數會指定要顯示或隱藏確認提示。 這個參數對 Cmdlet 的影響取決於 Cmdlet 是否需要確認才能繼續作業。
- 破壞性的 Cmdlet (如 Remove-* cmdlets) 有內建暫停,它會先強迫您確認命令才會繼續作業。 對於這些 Cmdlet,您可以使用以下確切語法來略過確認提示:
-Confirm:$false
。 - 其他大部分的 Cmdlet (如 New-* 和 Set-* cmdlets) 則沒有內建暫停。 在使用這些 Cmdlet 時,指定不含任何值的 Confirm 參數會引入強迫您認可命令後才繼續作業的暫停。
類型: | SwitchParameter |
別名: | cf |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-DeletedResources
{{ Fill DeletedResources Description }}
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-Enabled
Enabled 參數會啟用或停用原則。 有效值為:
- $true:已啟用原則。 這是預設值。
- $true:已啟用原則。此為預設值。
類型: | Boolean |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-Force
Force 參數會隱藏警告或確認訊息。 您不需要使用此參數指定值。
在不適合提示系統管理員輸入的場合中,您可以使用此參數來利用程式設計方式執行工作。
類型: | SwitchParameter |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-Identity
Identity 參數會指定您想要修改的應用程式保留合規性原則。 您可以使用唯一識別原則的任何值。 例如:
- 名稱
- 辨別名稱 (DN)
- GUID
類型: | PolicyIdParameter |
Position: | 0 |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
適用於: | Security & Compliance |
-PolicyRBACScopes
PolicyRBACScopes 參數會指定要指派給原則的管理單位。 有效的值是管理單位的 Microsoft Entra ObjectID (GUID 值) 。 您可以指定多個以逗號分隔的值。
管理單位僅適用於 P1 或 P2 Microsoft Entra ID。 您可以在 Microsoft Graph PowerShell 中建立和管理管理單位。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-RemoveAdaptiveScopeLocation
RemoveAdaptiveScopeLocation 參數會指定要從原則中移除的調適型範圍位置。 您可以使用 New-AdaptiveScope Cmdlet 來建立調適型範圍。 您可以使用可唯一識別調適型範圍的任何值。 例如:
- 名稱
- 辨別名稱 (DN)
- GUID
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-RemoveExchangeLocation
RemoveExchangeLocation 參數會指定當您未針對 ExchangeLocation 參數使用 All 值時,要從內含信箱清單中移除的信箱。 有效值為:
- 當您針對 ExchangeLocation 參數使用 All 值時,此參數會指定要從排除信箱清單中移除的信箱。有效值為:
- 信箱
所有信箱的 All 值。 您只能使用這個值本身。
- 名稱
- 名稱
- 辨別名稱 (DN)
- GUID
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-RemoveExchangeLocationException
RemoveExchangeLocationException 參數會指定當您針對 ExchangeLocation 參數使用 All 值時,要從排除信箱清單中移除的信箱。 有效值為:
- 當您針對 ExchangeLocation 參數使用 All 值時,此參數會指定要從排除信箱清單中移除的信箱。有效值為:
- 信箱
所有信箱的 All 值。 您只能使用這個值本身。
- 名稱
- 名稱
- 辨別名稱 (DN)
- GUID
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-RemoveModernGroupLocation
RemoveModernGroupLocation 參數會指定當您未針對 ModernGroupLocation 參數使用 All 值時,要從包含群組清單中移除的 Microsoft 365 群組。
您可以使用可唯一識別Microsoft 365 群組的任何值。 例如:
- 名稱
- 名稱
- 辨別名稱 (DN)
- GUID
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-RemoveModernGroupLocationException
RemoveModernGroupLocationException 參數會指定當您使用 ModernGroupLocation 參數的 All 值時,要從排除群組清單中移除的 Microsoft 365 群組。
您可以使用可唯一識別Microsoft 365 群組的任何值。 例如:
- 名稱
- 名稱
- 辨別名稱 (DN)
- GUID
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
類型: | MultiValuedProperty |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-RestrictiveRetention
RestrictiveRetention 參數會指定是否啟用原則的保留鎖定。 有效值為:
- $true:已啟用原則的保留鎖定。 包括系統管理員在內的任何人員都無法關閉原則,或使其較不嚴格。
- $false:原則未啟用保留鎖定。 這是預設值。
鎖定原則之後,沒有人可以關閉或停用原則,或從原則中移除應用程式。 您可以修改原則的唯一方式是將應用程式新增至原則,或延長其持續時間。 鎖定的原則可以增加或擴充,但無法減少、停用或關閉。
因此,在您鎖定原則之前,請務必瞭解組織的合規性需求,而且在確定這是您需要的原則之前,不要鎖定原則。
類型: | Boolean |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-RetryDistribution
RetryDistribution 參數會指定是否要將原則重新發佈至所有位置。 您不需要使用此參數指定值。
初始配送成功的位置不包含在重試中。 當您使用此參數時會回報原則配送錯誤。
注意:因為重試散發的程式是一項相當重要的作業,所以請只在必要時執行它,並一次針對一個原則執行它。 並非要在每次更新原則時執行。 如果您執行腳本來更新多個原則,請等到原則發佈成功之後,再針對下一個原則再次執行命令。
類型: | SwitchParameter |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |
-WhatIf
WhatIf 開關無法在安全性與合規性 PowerShell 中使用。
類型: | SwitchParameter |
別名: | wi |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
適用於: | Security & Compliance |