Get-RetentionComplianceRule
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
Default (Default)
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
Applicable: Security & Compliance
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
Parameter properties
| Type: | ComplianceRuleIdParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Policy
Applicable: Security & Compliance
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.
Parameter properties
| Type: | PolicyIdParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PriorityCleanup
Applicable: Security & Compliance
{{ Fill PriorityCleanup Description }}
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.