New-CaseHoldRule
此 Cmdlet 僅適用於安全性與合規性 PowerShell。 如需詳細資訊,請參閱 安全性與合規性 PowerShell。
使用 New-CaseHoldRule Cmdlet 在Microsoft Purview 合規性入口網站中建立新的案例保留規則。
如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法。
語法
Default (預設值)
New-CaseHoldRule
[-Name] <String>
-Policy <PolicyIdParameter>
[-Comment <String>]
[-Confirm]
[-ContentMatchQuery <String>]
[-Disabled <Boolean>]
[-WhatIf]
[<CommonParameters>]
Description
您需要使用 Policy 參數將案例保留規則新增至現有的案例保留原則。 每個案例保留原則只能新增一個規則。
若要在安全性與合規性 PowerShell 中使用此 Cmdlet,您必須獲得指派權限。 如需詳細資訊,請參閱 Microsoft Purview 合規性入口網站中的權限。
範例
範例 1
New-CaseHoldRule -Name "2016 Budget Spreadsheets" -Policy "Internal Company Policy" -ContentMatchQuery "filename:2016 budget filetype:xlsx"
本範例會建立名為 [2016 年預算試算表] 的新案例保留規則,並將它新增至名為 [公司內部原則] 的現有案例保留原則。 此規則適用於包含片語 2016 年預算的 Excel 工作表,例如「2016 年預算 planning.xlsx」和「2016 年預算 review.xlsx」
範例 2
New-CaseHoldRule -Name "Contoso Case 07172018 Hold 1" -Policy "Contoso Case 07172018" -ContentMatchQuery "received:12/01/2017..12/31/2018"
此範例會將收件者在 2018 年 12 月 1 日到 2018 年 12 月 31 日之間收到的電子郵件置於保留狀態。
參數
-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 |
| 別名: | CF |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ContentMatchQuery
適用對象:安全性 & 合規性
ContentMatchQuery 參數會指定內容搜尋篩選器。 使用此參數可建立查詢型保留,以便僅保留符合指定搜尋查詢的內容。
此參數使用利用關鍵字查詢語言 (KQL) 格式化的文字搜尋字串或查詢。 如需詳細資訊,請參閱 關鍵字查詢語言 (KQL) 語法參考和電子文件探索的關鍵字查詢和搜尋條件。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Disabled
適用對象:安全性 & 合規性
Disabled 參數會指定已啟用或已停用案例保留規則。 有效值為:
- $true: 停用此規則。
- $false: 啟用此規則。 此值為預設值。
參數屬性
| 類型: | Boolean |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Name
適用對象:安全性 & 合規性
Name 參數會指定案例保留規則的唯一名稱。 如果值包含空格,請使用引號括住值。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 1 |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Policy
適用對象:安全性 & 合規性
Policy 參數會指定包含規則的案例保留原則。 您可以使用唯一識別原則的任何值。 例如:
- 名稱
- 辨別名稱 (DN)
- GUID
參數屬性
| 類型: | PolicyIdParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| 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。