Skip to content

Commit b25070b

Browse files
authored
Merge pull request #12575 from cabailey/cabailey-m365powershell-deletedresources
Add Caution info about duplicate SMTP addresses
2 parents 82a5925 + 2675d53 commit b25070b

File tree

2 files changed

+30
-5
lines changed

2 files changed

+30
-5
lines changed

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

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,8 @@ Set-AppRetentionCompliancePolicy -Identity "Teams Private Channel Retention Poli
130130
```
131131
This example excludes the specified soft-deleted mailbox or mail user from the retention policy configured for Teams private channel messages. You can identify the deleted resources using the mailbox or mail user's email address.
132132

133+
**IMPORTANT**: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses.
134+
133135
Policy exclusions must remain within the supported limits for retention policies. For more information, see [Limits for Microsoft 365 retention policies and retention label policies](https://learn.microsoft.com/purview/retention-limits#maximum-number-of-items-per-policy).
134136

135137
### Example 3
@@ -147,6 +149,8 @@ Set-AppRetentionCompliancePolicy -Identity "Teams Private Chat Retention Policy"
147149

148150
This example is similar to Example 2, except multiple deleted resources are specified.
149151

152+
**IMPORTANT**: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses.
153+
150154
## PARAMETERS
151155

152156
### -Identity
@@ -375,11 +379,15 @@ Accept wildcard characters: False
375379
```
376380

377381
### -DeletedResources
378-
The DeletedResources parameter specifies the deleted mailbox or mail user to add 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 a Teams only retention policy.
382+
The DeletedResources parameter specifies the deleted mailbox or mail user to add as an exclusion to the respective location list. Use this parameter with the AddTeamsChatLocationException parameter for deleted mailboxes or mail users that need to be excluded from a Teams only retention policy.
379383

380384
A valid value is a JSON string. Refer to the Examples section for syntax and usage examples of this parameter.
381385

382-
For information on the inactive mailbox scenario, see [Learn about inactive mailboxes](https://learn.microsoft.com/purview/inactive-mailboxes-in-office-365).
386+
For information about the inactive mailbox scenario, see [Learn about inactive mailboxes](https://learn.microsoft.com/purview/inactive-mailboxes-in-office-365).
387+
388+
**CAUTION**: This parameter uses the SMTP address of the deleted mailbox or mail user, which might also be specified for other mailboxes or mail users. If you use this parameter without first taking additional steps, other mailboxes and mail users with the same SMTP address in the retention policy will also be excluded. To check for additional mailboxes or mail users with the same SMTP address, use the following command and replace *user@example.com* with the SMTP address to check: `Get-Recipient -IncludeSoftDeletedRecipients user@contoso.com |Select-Object DisplayName, EmailAddresses, Description, Alias, RecipientTypeDetails, WhenSoftDeleted`
389+
390+
To prevent active mailboxes or mail users with the same SMTP address from being excluded, put the mailbox on [Litigation Hold](https://learn.microsoft.com/purview/ediscovery-create-a-litigation-hold) before you run the command with the DeletedResources parameter.
383391

384392
```yaml
385393
Type: String

exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,8 @@ Set-RetentionCompliancePolicy -Identity "Sales Policy" -RemoveModernGroupLocatio
148148

149149
The example removes the specified deleted Microsoft 365 Group and site from the specified policy. You identify the deleted resources using the Microsoft 365 Group email address and the related site ID.
150150

151+
**IMPORTANT**: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses.
152+
151153
### Example 3
152154
```powershell
153155
$stringJson = @"
@@ -162,6 +164,9 @@ Set-RetentionCompliancePolicy -Identity "Tenant Level Policy" -AddModernGroupLoc
162164

163165
The example excludes the specified deleted Microsoft 365 Group and site from the specified tenant level policy. You identify the deleted resources using the Microsoft 365 Group email address and the related site ID.
164166

167+
**IMPORTANT**: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses.
168+
169+
165170
### Example 4
166171
```powershell
167172
$stringJson = @"
@@ -180,6 +185,8 @@ Set-RetentionCompliancePolicy -Identity "Sales Policy" -RemoveModernGroupLocatio
180185

181186
This example is similar to Example 2, except multiple deleted resources are specified.
182187

188+
**IMPORTANT**: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses.
189+
183190
### Example 5
184191
```powershell
185192
$stringJson = @"
@@ -192,7 +199,8 @@ Set-RetentionCompliancePolicy -Identity "Teams Chat Retention Policy" -AddTeamsC
192199
```
193200

194201
This example excludes the specified soft-deleted mailbox or mail user from the mentioned Teams Retention Policy. You can identify the deleted resources using the mailbox or mail user's email address.
195-
Policy exclusions must remain within the supported limits for retention policies: [Limits for Microsoft 365 retention policies and retention label policies](https://learn.microsoft.com/purview/retention-limits#maximum-number-of-items-per-policy)
202+
203+
**IMPORTANT**: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses.
196204

197205
### Example 6
198206
```powershell
@@ -210,6 +218,11 @@ Set-RetentionCompliancePolicy -Identity "Teams Chat Retention Policy" -AddTeamsC
210218

211219
This example is similar to Example 5, except multiple deleted resources are specified.
212220

221+
**IMPORTANT**: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses.
222+
223+
Policy exclusions must remain within the supported limits for retention policies: [Limits for Microsoft 365 retention policies and retention label policies](https://learn.microsoft.com/purview/retention-limits#maximum-number-of-items-per-policy)
224+
225+
213226
## PARAMETERS
214227

215228
### -Identity
@@ -663,9 +676,13 @@ The DeletedResources parameter specifies the deleted Microsoft 365 Group, mailbo
663676

664677
A valid value is a JSON string. Refer to the Examples section for syntax and usage examples of this parameter.
665678

666-
For more information on the deleted Microsoft 365 Group scenario, see [Learn more about modern group deletion under retention hold](https://learn.microsoft.com/purview/retention-settings#what-happens-if-a-microsoft-365-group-is-deleted-after-a-policy-is-applied).
679+
**CAUTION**: When you use a SMTP address with this parameter, be aware that the same address might also be in use for other mailboxes or mail users. To check for additional mailboxes or mail users with the same SMTP address, use the following command and replace *user@example.com* with the SMTP address to check: `Get-Recipient -IncludeSoftDeletedRecipients user@contoso.com |Select-Object DisplayName, EmailAddresses, Description, Alias, RecipientTypeDetails, WhenSoftDeleted`
680+
681+
To prevent active mailboxes or mail users with the same SMTP address from being excluded, put the mailbox on [Litigation Hold](https://learn.microsoft.com/purview/ediscovery-create-a-litigation-hold) before you run the command with the DeletedResources parameter.
682+
683+
For more information about the deleted Microsoft 365 Group scenario, see [Learn more about modern group deletion under retention hold](https://learn.microsoft.com/purview/retention-settings#what-happens-if-a-microsoft-365-group-is-deleted-after-a-policy-is-applied).
667684

668-
For more information on the inactive mailbox scenario, see [Learn about inactive mailboxes](https://learn.microsoft.com/purview/inactive-mailboxes-in-office-365).
685+
For more information about the inactive mailbox scenario, see [Learn about inactive mailboxes](https://learn.microsoft.com/purview/inactive-mailboxes-in-office-365).
669686

670687
```yaml
671688
Type: String

0 commit comments

Comments
 (0)