Skip to content

Commit 0b03b23

Browse files
Get-CaseHoldPolicy: Updating -DistributionDetail
The documentation did not explain how to get the correct data and could lead people into incorrect assumptions about the results returned
1 parent 06ab18c commit 0b03b23

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/Get-CaseHoldPolicy.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ Get-CaseHoldPolicy [[-Identity] <PolicyIdParameter>] [-Case <String>] [-Distribu
2727
```
2828

2929
## DESCRIPTION
30+
Use the Get-CaseHoldPolicy to view existing case hold policies in the Security & Compliance Center.
31+
32+
Note: To get relevant information to how the hold has been applied and what the currently affected locations are, you must include the `-DistributionDetail` parameter!
33+
3034
You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see [Permissions in Office 365 Security & Compliance Center](https://go.microsoft.com/fwlink/p/?LinkId=511920).
3135

3236
## EXAMPLES
@@ -70,7 +74,17 @@ Accept wildcard characters: False
7074
```
7175
7276
### -DistributionDetail
73-
The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch.
77+
Retrieve detailed policy distribution information on the case hold policy.
78+
Without this parameter, there will be no information about the current deployment status and the DistributionStatus property will only show as "Pending".
79+
80+
The following properties are affected by this switch:
81+
82+
- SharePointLocation
83+
- ExchangeLocation
84+
- PublicFolderLocation
85+
- DistributionStatus
86+
- DistributionResults
87+
- LastStatusUpdateTime
7488
7589
```yaml
7690
Type: SwitchParameter

0 commit comments

Comments
 (0)