New-CaseHoldPolicy
此 Cmdlet 僅適用於安全性與合規性 PowerShell。 如需詳細資訊,請參閱 安全性與合規性 PowerShell。
使用 New-CaseHoldPolicy Cmdlet 在Microsoft Purview 合規性入口網站中建立新的案例保留原則。
注意事項
此 Cmdlet 會在整個組織中造成完整同步處理,這是一項重要的作業。 如果您需要建立多個原則,請等到原則散發成功,再針對下一個原則再次執行 Cmdlet。 如需散發狀態的相關資訊,請參閱 Get-CaseHoldPolicy。
如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法。
語法
Default (預設值)
New-CaseHoldPolicy
[-Name] <String>
-Case <String>
[-Comment <String>]
[-Confirm]
[-Enabled <Boolean>]
[-ExchangeLocation <MultiValuedProperty>]
[-Force]
[-PublicFolderLocation <MultiValuedProperty>]
[-SharePointLocation <MultiValuedProperty>]
[-WhatIf]
[<CommonParameters>]
Description
若要在安全性與合規性 PowerShell 中使用此 Cmdlet,您必須獲得指派權限。 如需詳細資訊,請參閱 Microsoft Purview 合規性入口網站中的權限。
範例
範例 1
New-CaseHoldPolicy -Name "Regulation 123 Compliance" -Case "123 Compliance Case" -ExchangeLocation "Kitty Petersen", "Scott Nakamura" -SharePointLocation "https://contoso.sharepoint.com/sites/teams/finance"
此範例會針對 Kitty Petersen 和 Scott Nakamura 的信箱建立名為「Regulation 123 Compliance」 的案例保留原則,以及名為「123 合規性案例」的電子檔探索案例的財務 SharePoint 網站。
請記住,在建立原則之後,您需要使用 New-CaseHoldRule Cmdlet 為原則建立規則。
參數
-Case
適用:安全 & 合規
Case 參數會指定您想與案例保留原則關聯的 eDiscovery 案例。 您可以使用下列值來識別 eDiscovery 案例︰
- 名稱
- 識別碼 (GUID 值)。
您可以執行此命令來尋找這些值:Get-ComplianceCase | Format-Table -Auto Name,Status,Identity。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Comment
適用:安全 & 合規
Comment 參數會指定選擇性註解。 如果指定的值含有空格,則必須以雙引號 (") 括住值,例如︰"This is an admin note"。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| 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 |
| 別名: | 參閱 |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Enabled
適用:安全 & 合規
Enabled 參數會指定已啟用或已停用原則。 有效值為:
- $true:原則已啟用。 此值是預設值。
- $true:已啟用原則。此為預設值。
參數屬性
| 類型: | Boolean |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ExchangeLocation
適用:安全 & 合規
ExchangeLocation 參數會指定要包含在原則中的信箱。 有效值為:
- ExchangeLocation 參數會指定要包含在原則中的信箱。有效值為:
- 信箱
若要指定信箱或通訊群組,您可以使用下列值:
- 名稱
- SMTP 位址。 若要指定非作用中信箱,請在位址前面加上句點 (.) 。
- Microsoft Entra ObjectId 的 ObjectId 。 使用 Microsoft Graph PowerShell 中的 Get-MgUser 或 Get-MgGroup Cmdlet 來尋找此值。
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"。
若未指定任何信箱,則沒有信箱會處於保留狀態。
參數屬性
| 類型: | MultiValuedProperty |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Force
適用:安全 & 合規
強制開關隱藏警告或確認訊息。 您不需要使用此參數指定值。
在不適合提示系統管理員輸入的場合中,您可以使用此參數來利用程式設計方式執行工作。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Name
適用:安全 & 合規
Name 參數會指定案例保留原則的唯一名稱。 如果值包含空格,請使用引號括住值。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 1 |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-PublicFolderLocation
適用:安全 & 合規
PublicFolderLocation 參數指定您要將所有公用資料夾包含在案例保留原則中。 您可對此參數使用 All 值。
參數屬性
| 類型: | MultiValuedProperty |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-SharePointLocation
適用:安全 & 合規
SharePointLocation 參數會指定要包含的 SharePoint 和 OneDrive 網站。 您可以透過網站的 URL 值來識別網站。
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"。
在為網站編製索引之前,無法將網站新增至原則。 若未指定任何網站,則沒有網站會處於保留狀態。
參數屬性
| 類型: | MultiValuedProperty |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-WhatIf
適用:安全 & 合規
WhatIf 開關無法在安全性與合規性 PowerShell 中使用。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | 威斯康星州 |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
CommonParameters
此 Cmdlet 支援常見參數:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters。