Get-ComplianceRetentionEventType
This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.
Use the Get-ComplianceRetentionEventType cmdlet to view retention event types 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-ComplianceRetentionEventType
[-Identity <ComplianceRuleIdParameter>]
[-LoadTag]
[<CommonParameters>]
Description
You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.
Examples
Example 1
Get-ComplianceRetentionEventType | Format-Table Name,Priority
This example returns a summary list of all retention event types
Example 2
Get-ComplianceRetentionEventType -Identity "Fabrikam Project" -LoadTag
This example returns detailed information for the retention event type named Fabrikam Project, including the associated compliance tags.
Parameters
-Identity
Applicable: Security & Compliance
The Identity parameter specifies the retention event type that you want to view. You can use any value that uniquely identifies the retention event type. 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 |
-LoadTag
Applicable: Security & Compliance
The LoadTag switch specifies whether to show the compliance tags that are associated with the retention event types. You don't need to specify a value with this switch.
If you don't use this switch, the ComplianceTag property always appears empty in the results.
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.