-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Update Set-RetentionCompliancePolicy.md #12548
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
Merged
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
45aecc1
Update Set-RetentionCompliancePolicy.md
vilega c16a228
Update DeletedResources parameter details and examples
vilega a2830c8
Fix broken link in documentation
vilega 0475f3b
Clarify policy exclusion example description
vilega 90db49e
Clarify exclusion of soft-deleted mailboxes
vilega ca61d3b
Update link format in documentation
vilega 8c3c35f
Fix capitalization and formatting in documentation
chrisda 2829863
Update wording for clarity in documentation
chrisda 79934f6
Clarify wording for limits to match other cmdlet
cabailey 3a55e57
Merge branch 'main' into patch-2
cabailey 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 |
---|---|---|
|
@@ -180,6 +180,36 @@ Set-RetentionCompliancePolicy -Identity "Sales Policy" -RemoveModernGroupLocatio | |
|
||
This example is similar to Example 2, except multiple deleted resources are specified. | ||
|
||
### Example 5 | ||
```powershell | ||
$stringJson = @" | ||
[{ | ||
'EmailAddress': '[email protected]' | ||
}] | ||
"@ | ||
|
||
Set-RetentionCompliancePolicy -Identity "Teams Chat Retention Policy" -AddTeamsChatLocationException "[email protected]" -DeletedResources $stringJson | ||
``` | ||
|
||
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 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) | ||
|
||
### Example 6 | ||
```powershell | ||
$stringJson = @" | ||
[{ | ||
'EmailAddress': '[email protected]' | ||
}, | ||
{ | ||
'EmailAddress': '[email protected]' | ||
}] | ||
"@ | ||
|
||
Set-RetentionCompliancePolicy -Identity "Teams Chat Retention Policy" -AddTeamsChatLocationException "[email protected]", "[email protected]" -DeletedResources $stringJson | ||
``` | ||
|
||
This example is similar to Example 5, except multiple deleted resources are specified. | ||
|
||
## PARAMETERS | ||
|
||
### -Identity | ||
|
@@ -629,11 +659,13 @@ Accept wildcard characters: False | |
``` | ||
|
||
### -DeletedResources | ||
The DeletedResources parameter specifies the Sharepoint sites to be removed from the list of included sites or excluded from a tenant level policy when the associated group has been deleted. You use this parameter with the AddModernGroupLocationException and RemoveModernGroupLocation parameters. | ||
The DeletedResources parameter specifies the deleted Microsoft 365 Group, mailbox, or mail user to be removed or added as an exclusion to the respective location list. Use this parameter with the AddModernGroupLocationException and RemoveModernGroupLocation parameters for deleted Microsoft 365 Groups, or with the AddTeamsChatLocationException parameter for deleted mailboxes or mail users. | ||
|
||
A valid value is a JSON string. Refer to the Examples section for syntax and usage examples of this parameter. | ||
|
||
A valid value is a JSON String. See the Examples section for syntax and examples using 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). | ||
|
||
For more information about this 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). | ||
|
||
```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.