Get-TeamsRetentionComplianceRule

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-TeamsRetentionComplianceRule cmdlet to view retention rules for Microsoft Teams in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).

Syntax

Get-TeamsRetentionComplianceRule
   [[-Identity] <ComplianceRuleIdParameter>]
   [-Policy <PolicyIdParameter>]

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 (https://go.microsoft.com/fwlink/p/?LinkId=511920).

Examples

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

Get-TeamsRetentionComplianceRule

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

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

Get-TeamsRetentionComplianceRule -Identity "Teams - 30 Day Rule" | Format-List

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

Parameters

-Identity

The Identity parameter specifies the retention rule for Microsoft Teams that 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 retention rule for Microsoft Teams 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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Office 365 Security & Compliance Center

Inputs

Outputs