Get-CaseHoldPolicy

This cmdlet is available only in Office 365 Security & Compliance Center PowerShell. For more information, see Office 365 Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/office-365-scc/office-365-scc-powershell).

Use the Get-CaseHoldPolicy to view existing case hold policies in the Security & Compliance Center. 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 (https://docs.microsoft.com/powershell/exchange/exchange-server/exchange-cmdlet-syntax).

Syntax

Get-CaseHoldPolicy
   [[-Identity] <PolicyIdParameter>]
   [-Case <String>]
   [-DistributionDetail]
   [-IncludeBindings]
   [<CommonParameters>]

Description

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.

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

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.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Office 365 Security & Compliance Center
-DistributionDetail

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 won't return information about the current deployment status, and the DistributionStatus property will only show as "Pending".

The following properties are affected by this switch:

  • SharePointLocation
  • ExchangeLocation
  • PublicFolderLocation
  • DistributionStatus
  • DistributionResults
  • LastStatusUpdateTime
Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Office 365 Security & Compliance Center
-Identity

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

Type:PolicyIdParameter
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Office 365 Security & Compliance Center
-IncludeBindings

PARAMVALUE: SwitchParameter

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Office 365 Security & Compliance Center

Inputs

Outputs