Skip to content

Commit 91d4c9f

Browse files
committed
Updates per Issue #1299
1 parent 8c4a6ee commit 91d4c9f

File tree

2 files changed

+31
-15
lines changed

2 files changed

+31
-15
lines changed

exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-ComplianceRetentionEvent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ You need to be assigned permissions in the Office 365 Security & Compliance Cent
3232

3333
### Example 1
3434
```powershell
35-
Get-ComplianceRetentionEvent
35+
Get-ComplianceRetentionEvent | Format-Table Name,Description
3636
```
3737

3838
The example returns a summary list of all compliance retention events.

exchange/exchange-ps/exchange/policy-and-compliance-retention/New-ComplianceRetentionEvent.md

Lines changed: 30 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,16 @@ For information about the parameter sets in the Syntax section below, see [Excha
2222
## SYNTAX
2323

2424
```
25-
New-ComplianceRetentionEvent -Name <String> [-AssetId <String>] [-Comment <String>] [-Confirm] [-EventDateTime <DateTime>] [-EventTags <MultiValuedProperty>] [-EventType <ComplianceRuleIdParameter>] [-ExchangeAssetIdQuery <String>] [-SharePointAssetIdQuery <String>] [-WhatIf] [<CommonParameters>]
25+
New-ComplianceRetentionEvent -Name <String>
26+
[-AssetId <String>]
27+
[-Comment <String>]
28+
[-Confirm]
29+
[-EventDateTime <DateTime>]
30+
[-EventTags <MultiValuedProperty>]
31+
[-EventType <ComplianceRuleIdParameter>]
32+
[-ExchangeAssetIdQuery <String>]
33+
[-SharePointAssetIdQuery <String>]
34+
[-WhatIf] [<CommonParameters>]
2635
```
2736

2837
## DESCRIPTION
@@ -32,22 +41,21 @@ You need to be assigned permissions in the Office 365 Security & Compliance Cent
3241

3342
### Example 1
3443
```powershell
35-
Insert example commands for example 1.
44+
New-ComplianceRetentionEvent -Name "Research Project Employees" -EventTag 80e0d620-13ea-4ed9-b6a6-aa883278bcca -EventType e823b782-9a07-4e30-8091-034fc01f9347 -SharePointAssetIDQuery "EmployeeNumber:123456 EmployeeNumber:456789"
3645
```
3746

38-
Insert descriptive text for example 1.
47+
This example creates a compliance retention event named Research Project Employees with the following settings:
3948

40-
### Example 2
41-
```powershell
42-
Insert example commands for example 2.
43-
```
49+
- EventTag: 80e0d620-13ea-4ed9-b6a6-aa883278bcca
4450

45-
Insert descriptive text for example 2.
51+
- EventTpe: e823b782-9a07-4e30-8091-034fc01f9347
52+
53+
- SharePointAssetIDQuery: EmployeeNumber:123456 EmployeeNumber:456789
4654

4755
## PARAMETERS
4856

4957
### -Name
50-
The Name parameter specifies a unique name for the compliance retention event. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks.
58+
The Name parameter specifies a unique name for the compliance retention event. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks (").
5159

5260
```yaml
5361
Type: String
@@ -63,7 +71,13 @@ Accept wildcard characters: False
6371
```
6472
6573
### -AssetId
66-
The AssetId parameter.
74+
The AssetId parameter specifies the Property:Value pair found in the properties of SharePoint or OneDrive for Business documents that's used for retention. For example:
75+
76+
- Product codes that you can use to retain content for only a specific product.
77+
78+
- Project codes that you can use to retain content for only a specific project.
79+
80+
- Employee IDs that you can use to retain content for only a specific person.
6781
6882
```yaml
6983
Type: String
@@ -133,7 +147,9 @@ Accept wildcard characters: False
133147
```
134148
135149
### -EventTags
136-
The EventTags parameter.
150+
The EventTags parameter specifies the GUID value of the labels tha are associated with the compliance retention event. Run the following command to see the available GUID values: `Get-ComplianceTag | Format-Table Name,GUID`.
151+
152+
You can specify multiple values separated by commas.
137153

138154
```yaml
139155
Type: MultiValuedProperty
@@ -149,7 +165,7 @@ Accept wildcard characters: False
149165
```
150166

151167
### -EventType
152-
The EventType parameter.
168+
The EventType parameter specifies the GUID value of the event that will start the retention period for labels that use this event type. Run the following command to see the available GUID values: `Get-ComplianceRetentionEventType | Format-Table Name,GUID`.
153169

154170
```yaml
155171
Type: ComplianceRuleIdParameter
@@ -165,7 +181,7 @@ Accept wildcard characters: False
165181
```
166182

167183
### -ExchangeAssetIdQuery
168-
The ExchangeAssetIdQuery parameter.
184+
The ExchangeAssetIdQuery parameter specifies the keywords that are used to scope Exchange content for the compliance retention event. For details, see [Keyword queries and search conditions for Content Search](https://go.microsoft.com/fwlink/p/?linkid=828045).
169185

170186
```yaml
171187
Type: String
@@ -181,7 +197,7 @@ Accept wildcard characters: False
181197
```
182198

183199
### -SharePointAssetIdQuery
184-
The SharePointAssetIdQuery parameter.
200+
The SharePointAssetIdQuery parameter specifies one or more the Property:Value pairs that you've specified in the properties (also known as Columns) of SharePoint and OneDrive for Business documents to scope the compliance retention event.
185201

186202
```yaml
187203
Type: String

0 commit comments

Comments
 (0)