Get-HoldComplianceRule

This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx). Use the Get-HoldComplianceRule to view preservation rules in the Security & Compliance Center. The Get-HoldComplianceRule cmdlet has been replaced by the Get-RetentionComplianceRule cmdlet. If you have any scripts that use the Get-HoldComplianceRule cmdlet, update them to use the Get-RetentionComplianceRule cmdlet. For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).

Syntax

Get-HoldComplianceRule
   [[-Identity] <ComplianceRuleIdParameter>]
   [-Policy <PolicyIdParameter>]
   [<CommonParameters>]

Description

This list describes the properties that are displayed by default in the summary information.

  • Name: The unique name of the rule.

  • Disabled: The enabled or disabled status of the rule.

  • Mode: The current operating mode of the rule (for example, Enforce).

  • Comment: An administrative comment.

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).

Examples

-------------------------- Example 1 --------------------------

Get-HoldComplianceRule

This example displays summary information for all preservation rules in your organization.

-------------------------- Example 2 --------------------------

Get-HoldComplianceRule -Identity "30DayRule" | Format-List

This example displays detailed information for the preservation rule named "30 Day Rule".

Optional Parameters

-Identity

The Identity parameter specifies the preservation 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
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Office 365 Security & Compliance Center
-Policy

The Policy parameter filters the preservation rule results by the associated preservation 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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Office 365 Security & Compliance Center

Inputs

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data.

Outputs

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data.