-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Add Caution info about duplicate SMTP addresses #12575
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
cabailey
merged 7 commits into
MicrosoftDocs:main
from
cabailey:cabailey-m365powershell-deletedresources
Mar 11, 2025
Merged
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
18501ed
Add Caution info about duplicate SMTP addresses
a956b9a
Format text as bold in documentation
chrisda 37d7c2b
Format important notes in bold
chrisda e1c13c5
Incorporate tech review & formatting requests
559722f
Fix merge conflicts & incorporate tech review
c7d2448
Merge branch 'main' of https://github.com/MicrosoftDocs/office-docs-p…
2675d53
missing space
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -130,6 +130,8 @@ Set-AppRetentionCompliancePolicy -Identity "Teams Private Channel Retention Poli | |
``` | ||
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. | ||
|
||
IMPORTANT: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses. | ||
|
||
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). | ||
|
||
### Example 3 | ||
|
@@ -147,6 +149,8 @@ Set-AppRetentionCompliancePolicy -Identity "Teams Private Chat Retention Policy" | |
|
||
This example is similar to Example 2, except multiple deleted resources are specified. | ||
|
||
**IMPORTANT**: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses. | ||
|
||
## PARAMETERS | ||
|
||
### -Identity | ||
|
@@ -375,11 +379,15 @@ Accept wildcard characters: False | |
``` | ||
|
||
### -DeletedResources | ||
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. | ||
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. | ||
|
||
A valid value is a JSON string. Refer to the Examples section for syntax and usage examples of this parameter. | ||
|
||
For information on the inactive mailbox scenario, see [Learn about inactive mailboxes](https://learn.microsoft.com/purview/inactive-mailboxes-in-office-365). | ||
For information about the inactive mailbox scenario, see [Learn about inactive mailboxes](https://learn.microsoft.com/purview/inactive-mailboxes-in-office-365). | ||
|
||
**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 *[email protected]* with the SMTP address to check: `Get-Mailbox -RecipientTypeDetails UserMailbox,SharedMailbox | Where-Object { $_.EmailAddresses -contains "SMTP:[email protected]" } | Select-Object DisplayName, EmailAddresses, Description, Alias, OrganizationalUnit` | ||
|
||
To prevent other 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. | ||
cabailey marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
```yaml | ||
Type: String | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -148,6 +148,8 @@ Set-RetentionCompliancePolicy -Identity "Sales Policy" -RemoveModernGroupLocatio | |
|
||
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. | ||
|
||
IMPORTANT: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses. | ||
|
||
### Example 3 | ||
```powershell | ||
$stringJson = @" | ||
|
@@ -162,6 +164,9 @@ Set-RetentionCompliancePolicy -Identity "Tenant Level Policy" -AddModernGroupLoc | |
|
||
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. | ||
|
||
**IMPORTANT**: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses. | ||
|
||
|
||
### Example 4 | ||
```powershell | ||
$stringJson = @" | ||
|
@@ -180,6 +185,8 @@ Set-RetentionCompliancePolicy -Identity "Sales Policy" -RemoveModernGroupLocatio | |
|
||
This example is similar to Example 2, except multiple deleted resources are specified. | ||
|
||
**IMPORTANT**: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses. | ||
|
||
### Example 5 | ||
```powershell | ||
$stringJson = @" | ||
|
@@ -192,7 +199,8 @@ Set-RetentionCompliancePolicy -Identity "Teams Chat Retention Policy" -AddTeamsC | |
``` | ||
|
||
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. | ||
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) | ||
|
||
**IMPORTANT**: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses. | ||
|
||
### Example 6 | ||
```powershell | ||
|
@@ -210,6 +218,11 @@ Set-RetentionCompliancePolicy -Identity "Teams Chat Retention Policy" -AddTeamsC | |
|
||
This example is similar to Example 5, except multiple deleted resources are specified. | ||
|
||
IMPORTANT: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses. | ||
|
||
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) | ||
|
||
|
||
## PARAMETERS | ||
|
||
### -Identity | ||
|
@@ -663,9 +676,13 @@ The DeletedResources parameter specifies the deleted Microsoft 365 Group, mailbo | |
|
||
A valid value is a JSON string. Refer to the Examples section for syntax and usage examples of this parameter. | ||
|
||
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). | ||
**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 *[email protected]* with the SMTP address to check: `Get-Mailbox -RecipientTypeDetails UserMailbox,SharedMailbox | Where-Object { $_.EmailAddresses -contains "SMTP:[email protected]" } | Select-Object DisplayName, EmailAddresses, Description, Alias, OrganizationalUnit` | ||
cabailey marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
To prevent other 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. | ||
cabailey marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
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). | ||
|
||
For more information on the inactive mailbox scenario, see [Learn about inactive mailboxes](https://learn.microsoft.com/purview/inactive-mailboxes-in-office-365). | ||
For more information about the inactive mailbox scenario, see [Learn about inactive mailboxes](https://learn.microsoft.com/purview/inactive-mailboxes-in-office-365). | ||
|
||
```yaml | ||
Type: String | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.