Skip to content

Commit 9ed1bcc

Browse files
authored
Update Set-AppRetentionCompliancePolicy.md
to include deletedresources parameter
1 parent 3dec277 commit 9ed1bcc

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,34 @@ Set-AppRetentionCompliancePolicy -Identity "Regulation 563 Marketing" -Applicati
119119

120120
This example adds a new user to the existing static scope retention policy named Regulation 563 Marketing that's set up for Teams private channels messages.
121121

122+
### Example 2
123+
```powershell
124+
$stringJson = @"
125+
[{
126+
'EmailAddress': '[email protected]'
127+
}]
128+
"@
129+
Set-AppRetentionCompliancePolicy -Identity "Teams Private Chat Retention Policy" -AddExchangeLocationException "[email protected]" -DeletedResources $stringJson
130+
```
131+
132+
This example excludes the specified soft-deleted mailbox or mail user from the mentioned Teams Private Chat Retention Policy. You can identify the deleted resources using the mailbox or mail user's email address.
133+
Policy exclusions must ensure that locations remain within the established limits: [Limits for Microsoft 365 retention policies and retention label policies](https://learn.microsoft.com/purview/retention-limits#maximum-number-of-items-per-policy).
134+
135+
### Example 3
136+
```powershell
137+
$stringJson = @"
138+
[{
139+
'EmailAddress': '[email protected]'
140+
},
141+
{
142+
'EmailAddress': '[email protected]'
143+
}]
144+
"@
145+
Set-AppRetentionCompliancePolicy -Identity "Teams Private Chat Retention Policy" -AddExchangeLocationException "[email protected]", "[email protected]" -DeletedResources $stringJson
146+
```
147+
148+
This example is similar to Example 2, except multiple deleted resources are specified.
149+
122150
## PARAMETERS
123151

124152
### -Identity
@@ -347,7 +375,10 @@ Accept wildcard characters: False
347375
```
348376

349377
### -DeletedResources
350-
{{ Fill DeletedResources Description }}
378+
The DeletedResources parameter specifies the deleted mailbox, or mail user to be removed or added as an exclusion to the respective location list. Use this parameter with the AddTeamsChatLocationException parameter for deleted mailboxes or mail users that needs to be excluded from Teams only retention policy.
379+
380+
A valid value is a JSON string. Refer to the Examples section for syntax and usage examples of this parameter.
381+
For more details on the inactive mailbox scenario, please refer to the following article [Learn about inactive mailboxes](https://learn.microsoft.com/purview/inactive-mailboxes-in-office-365).
351382

352383
```yaml
353384
Type: String

0 commit comments

Comments
 (0)