Get-RetentionCompliancePolicy
此 Cmdlet 僅適用於安全性與合規性 PowerShell。 如需詳細資訊,請參閱 安全性與合規性 PowerShell。
使用 Get-RetentionCompliancePolicy 來檢視Microsoft Purview 合規性入口網站中現有的保留原則。
如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法。
語法
Default (預設值)
Get-RetentionCompliancePolicy
[[-Identity] <PolicyIdParameter>]
[-DistributionDetail]
[-ErrorPolicyOnly]
[-ExcludeTeamsPolicy]
[-IncludeTestModeResults]
[-PriorityCleanup]
[-RetentionRuleTypes]
[-TeamsPolicyOnly]
[<CommonParameters>]
Description
此清單描述預設顯示的內容。
- 名稱:原則的唯一名稱。
- 工作負載:目前,它會顯示 Exchange、SharePoint、OneDriveForBusiness、Skype、ModernGroup) (所有工作負載。 它不會顯示套用原則的實際工作負載。
- 已啟用:值 True 表示已啟用原則。
- 模式:原則目前的作業模式。 可能的值包括 Test (測試內容,但未強制執行任何規則) 、AuditAndNotify (當內容符合原則指定的條件時,不會強制執行規則,但傳送通知電子郵件) 或 強制執行 (啟用並強制執行原則的所有層面) 。
若要在安全性與合規性 PowerShell 中使用此 Cmdlet,您必須獲得指派權限。 如需詳細資訊,請參閱 Microsoft Purview 合規性入口網站中的權限。
範例
範例 1
Get-RetentionCompliancePolicy
此範例會顯示貴組織中所有保留原則的摘要資訊。
範例 2
Get-RetentionCompliancePolicy -Identity "Regulation 123 Compliance" -DistributionDetail | Format-List
此範例會顯示名為「法規 123 合規性」的原則的詳細資訊,包括 DistributionStatus 和 *Location 屬性的正確值。
參數
-DistributionDetail
適用對象:安全性 & 合規性
DistributionDetail 參數傳回 DistributionResults 屬性中詳細的原則散發資訊。 您不需要使用此參數指定值。
如果不使用此參數,DistributionStatus 和 *Location 屬性值的值將會不正確。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ErrorPolicyOnly
適用對象:安全性 & 合規性
ErrorPolicyOnly 參數可指定是否只顯示結果中有散發錯誤的原則。 您不需要使用此參數指定值。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | False |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ExcludeTeamsPolicy
適用對象:安全性 & 合規性
ExcludeTeamsPolicy 參數可指定是否要從結果中排除 Teams 原則。 您不需要使用此參數指定值。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Identity
適用對象:安全性 & 合規性
Identity 參數會指定您要檢視的保留原則。 您可以使用唯一識別原則的任何值。 例如:
- 名稱
- 辨別名稱 (DN)
- GUID
警告: Identity 參數的值 $null 或不存在的值會傳回 所有 物件,就像您在執行 Get- 命令而不使用Identity 參數一樣。 請確認 Identity 參數的任何值清單均正確無誤,且不包含不存在的$null值。
參數屬性
| 類型: | PolicyIdParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 1 |
| 必要: | False |
| 來自管線的值: | True |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-IncludeTestModeResults
適用對象:安全性 & 合規性
IncludeTestModeResults 參數會指定是否要在原則詳細資料中包含測試模式的狀態。 您不需要使用此參數指定值。
如需模擬模式的詳細資訊,請參閲 了解模擬模式。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-PriorityCleanup
適用對象:安全性 & 合規性
{{ 填滿 PriorityCleanup 說明 }}
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-RetentionRuleTypes
適用對象:安全性 & 合規性
RetentionRuleTypes 參數會指定是否要在結果中傳回 RetentionRuleTypes 和 HasRules 屬性的值。 您不需要使用此參數指定值。
若要查看 RetentionRuleTypes 屬性,您必須將命令透過管道傳送至格式設定 Cmdlet。 例如,Get-RetentionCompliancePolicy -RetentionRuleTypes | Format-Table -Auto Name,RetentionRuleTypes。 如果您未使用 RetentionRuleTypes 切換,則值 RetentionRuleTypes 會顯示空白,而 HasRules 會顯示為 False。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-TeamsPolicyOnly
適用對象:安全性 & 合規性
TeamsPolicyOnly 參數會指定是否要在結果中只顯示 Teams 原則。 您不需要使用此參數指定值。
參數屬性
| 類型: | 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。