Edit

Share via

Get-RetentionComplianceRule

  • Reference
Module:
ExchangePowerShell
Applies to:
Security & Compliance

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-RetentionComplianceRule to view retention rules in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Syntax

Get-RetentionComplianceRule
   [[-Identity] <ComplianceRuleIdParameter>]
   [-Policy <PolicyIdParameter>]
   [-PriorityCleanup]
   [<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.

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-RetentionComplianceRule

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

Example 2

Get-RetentionComplianceRule -Identity "30 Day Rule" | Format-List

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

Parameters

-Identity

The Identity parameter specifies the retention 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 retention rule results by the associated retention 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

-PriorityCleanup

{{ Fill PriorityCleanup Description }}

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