Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Get-AppRetentionComplianceRule
- Module:
- Exchange PowerShell
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
Default (Default)
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
Applicable: Security & Compliance
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
Caution: The value $null or a non-existent value for the Identity parameter returns all objects as if you ran the Get- command without the Identity parameter. Verify any lists of values for the Identity parameter are accurate and don't contain non-existent $null values.
Parameter properties
| Type: | ComplianceRuleIdParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Policy
Applicable: Security & Compliance
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
Parameter properties
| Type: | PolicyIdParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
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.
Feedback
Was this page helpful?