Get-CaseHoldRule
This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.
Use the Get-CaseHoldRule to view case hold rules in the Microsoft Purview compliance portal.
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.
Syntax
Get-CaseHoldRule
[[-Identity] <ComplianceRuleIdParameter>]
[-Policy <PolicyIdParameter>]
[<CommonParameters>] Description
In large environments, running this cmdlet without any parameters results in a timeout. As a workaround, you can run the following command:
Get-ComplianceCase | foreach {Get-CaseHoldPolicy -Case $_.Identity | foreach {Get-CaseHoldRule -Policy $_.Guid}}
To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see Permissions in the Microsoft Purview compliance portal.
Examples
Example 1
Get-CaseHoldRule -Identity "30 Day Rule"This example displays detailed information for the case hold rule named "30 Day Rule".
Parameters
-Identity
The Identity parameter specifies the case hold rule you want to view. You can use any value that uniquely identifies the rule. For example:
- Name
- Distinguished name (DN)
- GUID
| Type: | ComplianceRuleIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Security & Compliance |
-Policy
The Policy parameter filters the case hold rule results by the associated case hold policy. You can use any value that uniquely identifies the policy. For example:
- Name
- Distinguished name (DN)
- GUID
You can use this parameter with the Identity parameter in the same command.
| Type: | PolicyIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Security & Compliance |