Get-CaseHoldPolicy
This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.
Use the Get-CaseHoldPolicy to view existing case hold policies in the Microsoft Purview compliance portal. To get relevant information about how the hold was applied and the affected locations, you need to include the DistributionDetail switch.
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.
Syntax
Default (Default)
Get-CaseHoldPolicy
[[-Identity] <PolicyIdParameter>]
[-Case <String>]
[-DistributionDetail]
[-IncludeBindings]
[-IncludeBindingsOnly]
[<CommonParameters>]
Description
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-CaseHoldPolicy -Case "Contoso Legal"
This example displays detailed information for the policy that's associated with the eDiscovery case named Contoso Legal.
Example 2
Get-CaseHoldPolicy -Identity "Regulation 123 Compliance"
This example displays detailed information for the policy named "Regulation 123 Compliance".
Parameters
-Case
Applicable: Security & Compliance
The Case parameter specifies the case hold policy that you want to view by using the eDiscovery case that's associated with the policy. You can use the following values to identify the eDiscovery case:
- Name
- Identity (GUID value).
You can find these values by running the command: Get-ComplianceCase | Format-Table -Auto Name,Status,Identity.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DistributionDetail
Applicable: Security & Compliance
The DistributionDetail switch returns detailed policy distribution information on the case hold policy. You don't need to specify a value with this switch.
If you don't use this switch, the command doesn't return information about the current deployment status, and the DistributionStatus property shows as "Pending".
The following properties are affected by this switch:
- SharePointLocation
- ExchangeLocation
- PublicFolderLocation
- DistributionStatus
- DistributionResults
- LastStatusUpdateTime
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
Applicable: Security & Compliance
The Identity parameter specifies the case hold policy that you want to view. You can use any value that uniquely identifies the policy. For example:
- Name
- Distinguished name (DN)
- GUID
Parameter properties
| Type: | PolicyIdParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-IncludeBindings
Applicable: Security & Compliance
PARAMVALUE: SwitchParameter
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-IncludeBindingsOnly
Applicable: Security & Compliance
{{ Fill IncludeBindingsOnly Description }}
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.