Skip to content

Commit 8b19a46

Browse files
committed
Added new *-ComplianceRetention* cmdlets for 3/31 GA
1 parent 94d5816 commit 8b19a46

File tree

6 files changed

+806
-0
lines changed

6 files changed

+806
-0
lines changed
Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
---
2+
external help file: Microsoft.Exchange.TransportMailflow-Help.xml
3+
applicable: Office 365 Security & Compliance Center
4+
title: Get-ComplianceRetentionEvent
5+
schema: 2.0.0
6+
---
7+
8+
# Get-ComplianceRetentionEvent
9+
10+
## SYNOPSIS
11+
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).
12+
13+
Use the Get-ComplianceRetentionEvent cmdlet to view compliance retention events in the Security & Compliance Center.
14+
15+
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).
16+
17+
18+
## SYNTAX
19+
20+
### Set1
21+
```
22+
Get-ComplianceRetentionEvent [-Identity <PolicyIdParameter>]
23+
```
24+
25+
## DESCRIPTION
26+
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).
27+
28+
29+
## EXAMPLES
30+
31+
### Example 1
32+
```
33+
Get-ComplianceRetentionEvent
34+
```
35+
36+
The example returns a summary list of all compliance retention events.
37+
38+
39+
40+
### Example 2
41+
```
42+
Get-ComplianceRetentionEvent -Identity "Case 1234"
43+
```
44+
45+
This example returns detailed information about the compliance retention event named Case 1234.
46+
47+
48+
49+
## PARAMETERS
50+
51+
### -Identity
52+
The Identity parameter specifies the compliance retention event that you want to view. You can use any value that uniquely identifies the event. For example:
53+
54+
- Name
55+
56+
- Distinguished name (DN)
57+
58+
- GUID
59+
60+
```yaml
61+
Type: PolicyIdParameter
62+
Parameter Sets: (All)
63+
Aliases:
64+
Applicable: Office 365 Security & Compliance Center
65+
Required: False
66+
Position: 1
67+
Default value: None
68+
Accept pipeline input: True
69+
Accept wildcard characters: False
70+
```
71+
72+
## INPUTS
73+
74+
###
75+
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data.
76+
77+
78+
## OUTPUTS
79+
80+
###
81+
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data.
82+
83+
84+
## NOTES
85+
86+
87+
## RELATED LINKS
88+
89+
[Online Version](https://docs.microsoft.com/en-us/powershell/module/exchange/policy-and-compliance-retention/Get-ComplianceRetentionEvent)
90+
Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
---
2+
external help file: Microsoft.Exchange.TransportMailflow-Help.xml
3+
applicable: Office 365 Security & Compliance Center
4+
title: Get-ComplianceRetentionEventType
5+
schema: 2.0.0
6+
---
7+
8+
# Get-ComplianceRetentionEventType
9+
10+
## SYNOPSIS
11+
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).
12+
13+
Use the Get-ComplianceRetentionEventType cmdlet to view retention event types in the Security & Compliance Center.
14+
15+
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).
16+
17+
18+
## SYNTAX
19+
20+
### Set1
21+
```
22+
Get-ComplianceRetentionEventType [-Identity <ComplianceRuleIdParameter>] [-LoadTag <SwitchParameter>]
23+
```
24+
25+
## DESCRIPTION
26+
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not 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 (https://technet.microsoft.com/library/mt432940.aspx).
27+
28+
29+
## EXAMPLES
30+
31+
### Example 1
32+
```
33+
Get-ComplianceRetentionEventType | Format-Table Name,Priority
34+
```
35+
36+
This example returns a summary list of all retention event types
37+
38+
39+
40+
### Example 2
41+
```
42+
Get-ComplianceRetentionEventType -Identity "Fabrikam Project" -LoadTag
43+
```
44+
45+
This example returns detailed information for the retention event type named Fabrikam Project, including the associated compliance tags.
46+
47+
48+
49+
## PARAMETERS
50+
51+
### -Identity
52+
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:
53+
54+
- Name
55+
56+
- Distinguished name (DN)
57+
58+
- GUID
59+
60+
```yaml
61+
Type: ComplianceRuleIdParameter
62+
Parameter Sets: (All)
63+
Aliases:
64+
Applicable: Office 365 Security & Compliance Center
65+
Required: False
66+
Position: 1
67+
Default value: None
68+
Accept pipeline input: True
69+
Accept wildcard characters: False
70+
```
71+
72+
### -LoadTag
73+
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.
74+
75+
If you don't use this switch, the ComplianceTag property will always appear empty in the results.
76+
77+
```yaml
78+
Type: SwitchParameter
79+
Parameter Sets: (All)
80+
Aliases:
81+
Applicable: Office 365 Security & Compliance Center
82+
Required: False
83+
Position: Named
84+
Default value: None
85+
Accept pipeline input: False
86+
Accept wildcard characters: False
87+
```
88+
89+
## INPUTS
90+
91+
###
92+
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data.
93+
94+
95+
## OUTPUTS
96+
97+
###
98+
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data.
99+
100+
101+
## NOTES
102+
103+
104+
## RELATED LINKS
105+
106+
[Online Version](https://docs.microsoft.com/en-us/powershell/module/exchange/policy-and-compliance-retention/Get-ComplianceRetentionEventType)
107+

0 commit comments

Comments
 (0)