Set-CaseHoldPolicy
此 Cmdlet 僅適用于安全 & 性合規性 PowerShell。 如需詳細資訊,請參閱 安全 & 性合規性 PowerShell。
使用 Set-CaseHoldPolicy Cmdlet 來修改Microsoft Purview 合規性入口網站中現有的案例保存原則。
注意:執行此 Cmdlet 會導致整個組織進行完整同步處理,這是一項重要的作業。 如果您需要更新多個原則,請等到原則發佈成功,再再次執行 Cmdlet 以執行下一個原則。 如果您需要多次更新原則,請在 Cmdlet 的單一呼叫中進行所有變更。 如需發佈狀態的相關資訊,請參閱 Get-CaseHoldPolicy。
如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法。
Syntax
Set-CaseHoldPolicy
[-Identity] <PolicyIdParameter>
[-RetryDistribution]
[-Confirm]
[-WhatIf]
[<CommonParameters>]
Set-CaseHoldPolicy
[-Identity] <PolicyIdParameter>
[-AddExchangeLocation <MultiValuedProperty>]
[-AddPublicFolderLocation <MultiValuedProperty>]
[-AddSharePointLocation <MultiValuedProperty>]
[-Comment <String>]
[-Confirm]
[-Enabled <Boolean>]
[-Force]
[-RemoveExchangeLocation <MultiValuedProperty>]
[-RemovePublicFolderLocation <MultiValuedProperty>]
[-RemoveSharePointLocation <MultiValuedProperty>]
[-WhatIf]
[<CommonParameters>]
Description
若要在安全 & 性合規性 PowerShell 中使用此 Cmdlet,您必須獲指派許可權。 如需詳細資訊,請參閱 Microsoft Purview 合規性入口網站中的權限。
注意:新增或移除範圍位置時,請勿使用管道Foreach-Object命令: "Value1","Value2",..."ValueN" | Foreach-Object {Set-CaseHoldPolicy -Identity "Regulation 123 Compliance" -RemoveExchangeLocation $_}
。
範例
範例 1
Set-CaseHoldPolicy -Identity "Regulation 123 Compliance" -AddExchangeLocation "Kitty Petersen" -AddSharePointLocation "https://contoso.sharepoint.com/sites/teams/finance" -RemovePublicFolderLocation All -Comment "Added new counsel, 9/9/14"
本範例會對名為 "Regulation 123 Compliance" 的現有案例保留原則進行下列變更:
- 新增名為 Kitty Petersen 的使用者的信箱。
- 新增 SharePoint Online 網站
https://contoso.sharepoint.com/sites/teams/finance
。 - 移除公用資料夾。
- 更新註解。
參數
-AddExchangeLocation
AddExchangeLocation 參數會指定要新增至內含信箱清單的信箱。 有效值為:
- ExchangeLocation 參數會指定要包含在原則中的信箱。有效值為:
- 信箱
若要指定信箱或通訊群組,您可以使用下列值:
- 名稱
- SMTP 位址。 若要指定非作用中信箱,請在位址前面加上句號 (.) 。
- Azure AD ObjectId。 使用 Microsoft Graph PowerShell 中的 Get-MgUser 或 Get-MgGroup Cmdlet 來尋找此值。
您可以輸入多個以逗號分隔的值。 如果值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-AddPublicFolderLocation
AddPublicFolderLocation 參數指定您要將所有公用資料夾新增至案例保留原則。 您可對此參數使用 All 值。
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-AddSharePointLocation
當您未針對 SharePointLocation 參數使用 All 值時,AddSharePointLocation 參數會指定要新增至包含網站清單的 SharePoint Online 網站。 您可以依據其 URL 值識別網站。
您可以輸入多個以逗號分隔的值。 如果值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
在編制索引之前,無法將 SharePoint Online 網站新增至原則。
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-Comment
Comment 參數會指定選擇性註解。 如果指定的值含有空格,則必須以雙引號 (") 括住值,例如︰"This is an admin note"。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-Confirm
Confirm 參數會指定要顯示或隱藏確認提示。 這個參數對 Cmdlet 的影響取決於 Cmdlet 是否需要確認才能繼續作業。
- 例如,具破壞性的 Cmdlet (例如 Remove-* Cmdlet) 內建暫停,可強制您在繼續之前確認命令。 對於這些 Cmdlet,您可以使用以下確切語法來略過確認提示:
-Confirm:$false
。 - 其他大部分的 Cmdlet (例如,New-* 和 Set-* Cmdlet) 沒有內建暫停。 在使用這些 Cmdlet 時,指定不含任何值的 Confirm 參數會引入強迫您認可命令後才繼續作業的暫停。
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-Enabled
Enabled 參數會指定是否已啟用原則。 有效值為:
- $true:已啟用原則。 這是預設值。
- $true:已啟用原則。此為預設值。
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-Force
Force 參數會隱藏警告或確認訊息。 您不需要使用此參數指定值。
在不適合提示系統管理員輸入的場合中,您可以使用此參數來利用程式設計方式執行工作。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-Identity
Identity 參數會指定您要修改的案例保留原則。 您可以使用唯一識別原則的任何值。 例如:
- 名稱
- 辨別名稱 (DN)
- GUID
Type: | PolicyIdParameter |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-RemoveExchangeLocation
RemoveExchangeLocation 參數會指定要從原則中移除的現有信箱。 有效值為:
- 當您針對 ExchangeLocation 參數使用 All 值時,此參數會指定要從排除信箱清單中移除的信箱。有效值為:
- 信箱
所有信箱的 All 值。 您只能使用這個值本身。
- 名稱
- SMTP 位址。 若要指定非作用中信箱,請在位址前面加上句號 (.) 。
- Azure AD ObjectId。 使用 Microsoft Graph PowerShell 中的 Get-MgUser 或 Get-MgGroup Cmdlet 來尋找此值。
您可以輸入多個以逗號分隔的值。 如果值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-RemovePublicFolderLocation
RemovePublicFolderLocation 參數指定您要從案例保留原則中移除所有的公用資料夾。 您可對此參數使用 All 值。
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-RemoveSharePointLocation
RemoveSharePointLocation 參數會指定當您未針對 SharePointLocation 參數使用 All 值時,要從包含的網站清單中移除的 SharePoint Online 網站。 您可以依據其 URL 值識別網站。
您可以輸入多個以逗號分隔的值。 如果值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-RetryDistribution
RetryDistribution 參數會指定是否要將原則重新發佈至所有Exchange Online和 SharePoint Online 位置。 您不需要使用此參數指定值。
初始配送成功的位置不包含在重試中。 當您使用此參數時會回報原則配送錯誤。
注意:因為重試散發的程式是一項相當重要的作業,所以請只在必要時執行它,並一次針對一個原則執行它。 並非要在每次更新原則時執行。 如果您執行腳本來更新多個原則,請等到原則發佈成功之後,再針對下一個原則再次執行命令。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-WhatIf
WhatIf 參數無法在安全 & 性合規性 PowerShell 中運作。
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |