Edit

Share via

Get-AppRetentionComplianceRule

  • 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-AppRetentionComplianceRule to view app retention compliance rules.

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

Syntax

Get-AppRetentionComplianceRule
   [[-Identity] <ComplianceRuleIdParameter>]
   [-Policy <PolicyIdParameter>]
   [<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-AppRetentionComplianceRule | Format-Table Name,Policy

This example returns a summary list of all app retention compliance rules.

Example 1

Get-AppRetentionComplianceRule -Identity "Contoso Viva Engage"

This example returns detailed information for the app retention compliance rule named Contoso Viva Engage.

Parameters

-Identity

The Identity parameter specifies the app retention compliance rule that you want to view. You can use any value that uniquely identifies the policy. For example:

  • Name
  • Distinguished name (DN)
  • GUID
Type:ComplianceRuleIdParameter
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Security & Compliance

-Policy

The Policy parameter filters the app retention compliance rule results by the associated app retention compliance policy. You can use any value that uniquely identifies the policy. For example:

  • Name
  • Distinguished name (DN)
  • GUID
Type:PolicyIdParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance