Skip to content

Update Set-AppRetentionCompliancePolicy.md #12549

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.

Sign up for GitHub

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
merged 4 commits into from
Feb 26, 2025
Merged

Update Set-AppRetentionCompliancePolicy.md #12549

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9ed1bcc
Update Set-AppRetentionCompliancePolicy.md
vilega Feb 26, 2025
9a130bd
Clarify DeletedResources parameter description
vilega Feb 26, 2025
ed068f9
Update documentation for policy exclusions and parameters
chrisda Feb 26, 2025
89958aa
Update retention policy example and documentation
vilega Feb 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 34 additions & 1 deletion exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,35 @@ Set-AppRetentionCompliancePolicy -Identity "Regulation 563 Marketing" -Applicati

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.

### Example 2
```powershell
$stringJson = @"
[{
'EmailAddress': '[email protected]'
}]
"@
Set-AppRetentionCompliancePolicy -Identity "Teams Private Chat Retention Policy" -AddExchangeLocationException "[email protected]" -DeletedResources $stringJson
```

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.

Policy exclusions must ensure that locations remain within the established limits. 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
```powershell
$stringJson = @"
[{
'EmailAddress': '[email protected]'
},
{
'EmailAddress': '[email protected]'
}]
"@
Set-AppRetentionCompliancePolicy -Identity "Teams Private Chat Retention Policy" -AddExchangeLocationException "[email protected]", "[email protected]" -DeletedResources $stringJson
```

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

## PARAMETERS

### -Identity
Expand Down Expand Up @@ -347,7 +376,11 @@ Accept wildcard characters: False
```

### -DeletedResources
{{ Fill DeletedResources Description }}
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.

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).

```yaml
Type: String
Expand Down