Set-RetentionCompliancePolicy

Syntax

Identity

Set-RetentionCompliancePolicy
    [-Identity] <PolicyIdParameter>
    [-AddExchangeLocation <MultiValuedProperty>]
    [-AddExchangeLocationException <MultiValuedProperty>]
    [-AddModernGroupLocation <MultiValuedProperty>]
    [-AddModernGroupLocationException <MultiValuedProperty>]
    [-AddOneDriveLocation <MultiValuedProperty>]
    [-AddOneDriveLocationException <MultiValuedProperty>]
    [-AddPublicFolderLocation <MultiValuedProperty>]
    [-AddSharePointLocation <MultiValuedProperty>]
    [-AddSharePointLocationException <MultiValuedProperty>]
    [-AddSkypeLocation <MultiValuedProperty>]
    [-AddSkypeLocationException <MultiValuedProperty>]
    [-Applications <MultiValuedProperty>]
    [-Comment <String>]
    [-Confirm]
    [-DeletedResources <String>]
    [-Enabled <Boolean>]
    [-EnforceSimulationPolicy <Boolean>]
    [-Force]
    [-PolicyTemplateInfo <PswsHashtable>]
    [-PolicyRBACScopes <MultiValuedProperty>]
    [-PriorityCleanup]
    [-RemoveExchangeLocation <MultiValuedProperty>]
    [-RemoveExchangeLocationException <MultiValuedProperty>]
    [-RemoveModernGroupLocation <MultiValuedProperty>]
    [-RemoveModernGroupLocationException <MultiValuedProperty>]
    [-RemoveOneDriveLocation <MultiValuedProperty>]
    [-RemoveOneDriveLocationException <MultiValuedProperty>]
    [-RemovePublicFolderLocation <MultiValuedProperty>]
    [-RemoveSharePointLocation <MultiValuedProperty>]
    [-RemoveSharePointLocationException <MultiValuedProperty>]
    [-RemoveSkypeLocation <MultiValuedProperty>]
    [-RemoveSkypeLocationException <MultiValuedProperty>]
    [-RestrictiveRetention <Boolean>]
    [-StartSimulation <Boolean>]
    [-WhatIf]
    [<CommonParameters>]

AdaptiveScopeLocation

Set-RetentionCompliancePolicy
    [-Identity] <PolicyIdParameter>
    [-AddAdaptiveScopeLocation <MultiValuedProperty>]
    [-Applications <MultiValuedProperty>]
    [-Comment <String>]
    [-Confirm]
    [-DeletedResources <String>]
    [-Enabled <Boolean>]
    [-EnforceSimulationPolicy <Boolean>]
    [-Force]
    [-PriorityCleanup]
    [-RemoveAdaptiveScopeLocation <MultiValuedProperty>]
    [-StartSimulation <Boolean>]
    [-WhatIf]
    [<CommonParameters>]

RetryDistribution

Set-RetentionCompliancePolicy
    [-Identity] <PolicyIdParameter>
    [-RetryDistribution]
    [-Confirm]
    [-DeletedResources <String>]
    [-EnforceSimulationPolicy <Boolean>]
    [-PriorityCleanup]
    [-StartSimulation <Boolean>]
    [-WhatIf]
    [<CommonParameters>]

TeamLocation

Set-RetentionCompliancePolicy
    [-Identity] <PolicyIdParameter>
    [-AddTeamsChannelLocation <MultiValuedProperty>]
    [-AddTeamsChannelLocationException <MultiValuedProperty>]
    [-AddTeamsChatLocation <MultiValuedProperty>]
    [-AddTeamsChatLocationException <MultiValuedProperty>]
    [-Comment <String>]
    [-Confirm]
    [-DeletedResources <String>]
    [-Enabled <Boolean>]
    [-EnforceSimulationPolicy <Boolean>]
    [-Force]
    [-PriorityCleanup]
    [-RemoveTeamsChannelLocation <MultiValuedProperty>]
    [-RemoveTeamsChannelLocationException <MultiValuedProperty>]
    [-RemoveTeamsChatLocation <MultiValuedProperty>]
    [-RemoveTeamsChatLocationException <MultiValuedProperty>]
    [-StartSimulation <Boolean>]
    [-WhatIf]
    [<CommonParameters>]

Description

Examples

Example 1

Set-RetentionCompliancePolicy -Identity "Regulation 123 Compliance" -AddExchangeLocation "Kitty Petersen" -AddSharePointLocation "https://contoso.sharepoint.com/sites/teams/finance" -RemovePublicFolderLocation All -Comment "Added new counsel, 9/9/14"

Example 2

$stringJson = @"
[{
     'EmailAddress': 'USSales@contoso.onmicrosoft.com',
     'SiteId': '9b2a8116-b9ec-4e2c-bf31-7eaa83697c4b'
}]
"@

Set-RetentionCompliancePolicy -Identity "Sales Policy" -RemoveModernGroupLocation "USSales@contoso.onmicrosoft.com" -DeletedResources $stringJson

Example 3

$stringJson = @"
[{
     'EmailAddress': 'USSales@contoso.onmicrosoft.com',
     'SiteId': '8b2a8345-b9ec-3b6a-bf31-6eaa83697c4b'
}]
"@

Set-RetentionCompliancePolicy -Identity "Tenant Level Policy" -AddModernGroupLocationException "USSales@contoso.onmicrosoft.com" -DeletedResources $stringJson

Example 4

$stringJson = @"
[{
     'EmailAddress': 'USSales2@contoso.onmicrosoft.com',
     'SiteId': '9b2a8116-b9ec-4e2c-bf31-7eaa83697c4b'
 },
{
     'EmailAddress': 'USSales2@contoso.onmicrosoft.com',
     'SiteId': '4afb7116-b9ec-4b2c-bf31-4abb83697c4b'
}]
"@

Set-RetentionCompliancePolicy -Identity "Sales Policy" -RemoveModernGroupLocation "USSales2@contoso.onmicrosoft.com" -DeletedResources $stringJson

Example 5

$stringJson = @"
[{
     'EmailAddress': 'SalesUser@contoso.onmicrosoft.com'
}]
"@

Set-RetentionCompliancePolicy -Identity "Teams Chat Retention Policy" -AddTeamsChatLocationException "SalesUser@contoso.onmicrosoft.com" -DeletedResources $stringJson

Example 6

$stringJson = @"
[{
     'EmailAddress': 'SalesUser1@contoso.onmicrosoft.com'
},
{
     'EmailAddress': 'SalesUser2@contoso.onmicrosoft.com'
}]
"@

Set-RetentionCompliancePolicy -Identity "Teams Chat Retention Policy" -AddTeamsChatLocationException "SalesUser1@contoso.onmicrosoft.com", "SalesUser2@contoso.onmicrosoft.com" -DeletedResources $stringJson

Parameters

-AddAdaptiveScopeLocation

Applicable: Security & Compliance

The AddAdaptiveScopeLocation parameter specifies the adaptive scope ___location to add to the policy. You create adaptive scopes by using the New-AdaptiveScope cmdlet. You can use any value that uniquely identifies the adaptive scope. For example:

• Name
• Distinguished name (DN)
• GUID

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-AddExchangeLocation

Applicable: Security & Compliance

The AddExchangeLocation parameter specifies the mailboxes to add to the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. Valid values are:

• A mailbox
• A distribution group or mail-enabled security group (all mailboxes that are currently members of the group).

To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example:

• Name
• Distinguished name (DN)
• Email address
• GUID

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-AddExchangeLocationException

Applicable: Security & Compliance

This parameter specifies the mailboxes to add to the list of excluded mailboxes when you use the value All for the ExchangeLocation parameter. Valid values are:

• A mailbox
• A distribution group or mail-enabled security group

To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example:

• Name
• Distinguished name (DN)
• Email address
• GUID

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-AddModernGroupLocation

Applicable: Security & Compliance

The AddModernGroupLocation parameter specifies the Microsoft 365 Groups to add to the list of included Microsoft 365 Groups when you aren't using the value All for the ModernGroupLocation parameter.

You can use any value that uniquely identifies the Microsoft 365 Group. For example:

• Name
• Distinguished name (DN)
• Email address
• GUID

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-AddModernGroupLocationException

Applicable: Security & Compliance

The AddModernGroupLocationException parameter specifies the Microsoft 365 Groups to add to the list of excluded Microsoft 365 Groups when you're using the value All for the ModernGroupLocation parameter.

You can use any value that uniquely identifies the Microsoft 365 Group. For example:

• Name
• Distinguished name (DN)
• Email address
• GUID

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-AddOneDriveLocation

Applicable: Security & Compliance

The AddOneDriveLocation parameter specifies the OneDrive sites to add to the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value.

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-AddOneDriveLocationException

Applicable: Security & Compliance

This parameter specifies the OneDrive sites to add to the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value.

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-AddPublicFolderLocation

Applicable: Security & Compliance

The AddPublicFolderLocation parameter specifies that you want to add all public folders to the retention policy. You use the value All for this parameter.

Parameter properties

Parameter sets

-AddSharePointLocation

Applicable: Security & Compliance

The AddSharePointLocation parameter specifies the SharePoint sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value.

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

SharePoint sites can't be added to the policy until they have been indexed.

Parameter properties

Parameter sets

-AddSharePointLocationException

Applicable: Security & Compliance

This parameter specifies the SharePoint sites to add to the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value.

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-AddSkypeLocation

Applicable: Security & Compliance

The AddSkypeLocation parameter specifies the Skype for Business Online users to add from the list of included Skype for Business Online users.

You can use any value that uniquely identifies the user. For example:

• Name
• Distinguished name (DN)
• Email address
• GUID

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-AddSkypeLocationException

Applicable: Security & Compliance

This parameter is reserved for internal Microsoft use.

Parameter properties

Parameter sets

-AddTeamsChannelLocation

Applicable: Security & Compliance

The AddTeamsChannelLocation parameter specifies the Teams to add to the policy.

You can use any value that uniquely identifies the team. For example:

• Name
• Email address
• GUID

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-AddTeamsChannelLocationException

Applicable: Security & Compliance

The AddTeamsChannelLocationException parameter specifies the Teams to add to the exclusion list when you use the value All for the TeamsChannelLocation parameter. You can use any value that uniquely identifies the team. For example:

• Name
• Email address
• GUID

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-AddTeamsChatLocation

Applicable: Security & Compliance

The AddTeamsChatLocation parameter specifies the Teams users to add to the policy.

You can use any value that uniquely identifies the user. For example:

• Name
• Distinguished name (DN)
• Email address
• GUID

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-AddTeamsChatLocationException

Applicable: Security & Compliance

The AddTeamsChatLocationException parameter specifies the Teams users to add to the exclusion list when you use the value All for the TeamsChatLocation parameter. You can use any value that uniquely identifies the user. For example:

• Name
• Email address
• GUID

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-Applications

Applicable: Security & Compliance

The Applications parameter specifies the target when Microsoft 365 Groups are included in the policy (the ModernGroups parameter is set). Valid values are:

• Group:Exchange for the mailbox that's connected to the Microsoft 365 Group.
• Group:SharePoint for the SharePoint site that's connected to the Microsoft 365 Group.
• "Group:Exchange,SharePoint" for both the mailbox and the SharePoint site that are connected to the Microsoft 365 Group.
• blank ($null): This value is the default, and is functionally equivalent to the value "Group:Exchange,SharePoint". To return to the default value of both the mailbox and SharePoint site for the selected Microsoft 365 groups, specify "Group:Exchange,SharePoint".

Parameter properties

Parameter sets

-Comment

Applicable: Security & Compliance

The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note".

Parameter properties

Parameter sets

-Confirm

Applicable: Security & Compliance

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

• Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.
• Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

Parameter properties

Parameter sets

-DeletedResources

Applicable: Security & Compliance

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.

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@contoso.com with the SMTP address to check: Get-Recipient -IncludeSoftDeletedRecipients user@contoso.com | Select-Object DisplayName, EmailAddresses, Description, Alias, RecipientTypeDetails, WhenSoftDeleted

To prevent active mailboxes or mail users with the same SMTP address from being excluded, put the mailbox on Litigation Hold before you run the command with the DeletedResources parameter.

For more information about the deleted Microsoft 365 Group scenario, see Learn more about modern group deletion under retention hold.

For more information about the inactive mailbox scenario, see Learn about inactive mailboxes.

Parameter properties

Parameter sets

-Enabled

Applicable: Security & Compliance

The Enabled parameter specifies whether the policy is enabled. Valid values are:

• $true: The policy is enabled. This value is the default.
• $false: The policy is disabled.

Parameter properties

Parameter sets

-EnforceSimulationPolicy

Applicable: Security & Compliance

The EnforceSimulationPolicy parameter specifies whether to enforce a simulation policy as an active policy. Valid values are:

• $true: Enforce the simulation policy as an active policy.
• $false: Don't enforce the simulation policy as an active policy. This value is the default.

For more information about simulation mode, see Learn about simulation mode.

Parameter properties

Parameter sets

-Force

Applicable: Security & Compliance

The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch.

You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate.

Parameter properties

Parameter sets

-Identity

Applicable: Security & Compliance

The Identity parameter specifies the retention policy that you want to modify. You can use any value that uniquely identifies the policy. For example:

• Name
• Distinguished name (DN)
• GUID

Parameter properties

Parameter sets

-PolicyRBACScopes

Applicable: Security & Compliance

Note: Admin units aren't currently supported, so this parameter isn't functional. The information presented here is for informational purposes when support for admin units is released.

The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas.

Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell.

Parameter properties

Parameter sets

-PolicyTemplateInfo

Applicable: Security & Compliance

This parameter is reserved for internal Microsoft use.

Parameter properties

Parameter sets

-PriorityCleanup

Applicable: Security & Compliance

The PriorityCleanup switch specifies whether to update a Priority cleanup policy. You don't need to specify a value with this switch.

Priority cleanup policies expedite the deletion of sensitive content by overriding any existing retention settings or eDiscovery holds. For more information, see Priority Cleanup.

Parameter properties

Parameter sets

-RemoveAdaptiveScopeLocation

Applicable: Security & Compliance

The RemoveAdaptiveScopeLocation parameter specifies the adaptive scope ___location to remove from the policy. You create adaptive scopes by using the New-AdaptiveScope cmdlet. You can use any value that uniquely identifies the adaptive scope. For example:

• Name
• Distinguished name (DN)
• GUID

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-RemoveExchangeLocation

Applicable: Security & Compliance

The RemoveExchangeLocation parameter specifies the mailboxes to remove from the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter.

You can use any value that uniquely identifies the mailbox. For example:

• Name
• Distinguished name (DN)
• Email address
• GUID

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-RemoveExchangeLocationException

Applicable: Security & Compliance

The RemoveExchangeLocationException parameter specifies the mailboxes to remove from the list of excluded mailboxes when you use the value All for the ExchangeLocation parameter.

You can use any value that uniquely identifies the mailbox. For example:

• Name
• Distinguished name (DN)
• Email address
• GUID

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-RemoveModernGroupLocation

Applicable: Security & Compliance

The RemoveModernGroupLocation parameter specifies the Microsoft 365 Groups to remove from the list of included groups when you aren't using the value All for the ModernGroupLocation parameter.

You can use any value that uniquely identifies the Microsoft 365 Group. For example:

• Name
• Distinguished name (DN)
• Email address
• GUID

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-RemoveModernGroupLocationException

Applicable: Security & Compliance

The RemoveModernGroupLocationException parameter specifies the Microsoft 365 Groups to remove from the list of excluded groups when you're using the value All for the ModernGroupLocation parameter.

You can use any value that uniquely identifies the Microsoft 365 Group. For example:

• Name
• Distinguished name (DN)
• Email address
• GUID

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-RemoveOneDriveLocation

Applicable: Security & Compliance

The RemoveOneDriveLocation parameter specifies the OneDrive sites to remove from the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value.

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-RemoveOneDriveLocationException

Applicable: Security & Compliance

This parameter specifies the OneDrive sites to remove from the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value.

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-RemovePublicFolderLocation

Applicable: Security & Compliance

The RemovePublicFolderLocation parameter specifies that you want to remove all public folders from the retention policy. You use the value All for this parameter.

Parameter properties

Parameter sets

-RemoveSharePointLocation

Applicable: Security & Compliance

The RemoveSharePointLocation parameter specifies the SharePoint sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value.

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-RemoveSharePointLocationException

Applicable: Security & Compliance

This parameter specifies the SharePoint sites to remove from the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value.

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-RemoveSkypeLocation

Applicable: Security & Compliance

The RemoveSkypeLocation parameter specifies the Skype for Business Online users to remove from the list of included Skype for Business Online users.

You can use any value that uniquely identifies the user. For example:

• Name
• Distinguished name (DN)
• Email address
• GUID

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-RemoveSkypeLocationException

Applicable: Security & Compliance

This parameter is reserved for internal Microsoft use.

Parameter properties

Parameter sets

-RemoveTeamsChannelLocation

Applicable: Security & Compliance

The RemoveTeamsChannelLocation parameter specifies the Teams to remove from the policy.

You can use any value that uniquely identifies the team. For example:

• Name
• Email address
• GUID

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-RemoveTeamsChannelLocationException

Applicable: Security & Compliance

The RemoveTeamsChannelLocationException parameter specifies the Teams to remove from the exclusion list when you use the value All for the TeamsChannelLocation parameter. You can use any value that uniquely identifies the team. For example:

• Name
• Email address
• GUID

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-RemoveTeamsChatLocation

Applicable: Security & Compliance

The RemoveTeamsChatLocation parameter specifies the Teams users to remove from the policy.

You can use any value that uniquely identifies the user. For example:

• Name
• Distinguished name (DN)
• Email address
• GUID

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-RemoveTeamsChatLocationException

Applicable: Security & Compliance

The RemoveTeamsChatLocationException parameter specifies the Teams users to remove from the exclusion list when you use the value All for the TeamsChatLocation parameter. You can use any value that uniquely identifies the user. For example:

• Name
• Email address
• GUID

You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "Value1","Value2",..."ValueN".

Parameter properties

Parameter sets

-RestrictiveRetention

Applicable: Security & Compliance

The RestrictiveRetention parameter specifies whether Preservation Lock is enabled for a retention policy or retention label policy. Valid values are:

• $true: Preservation Lock is enabled for the policy. No one (including an administrator) can turn off the policy or make it less restrictive.
• $false: Preservation Lock isn't enabled for the policy. This value is the default.

After a policy is locked, no one can turn off or disable it, or remove content from the policy. And it's not possible to modify or delete content that's subject to the policy during the retention period. The only way that you can modify the retention policy are by adding content to it, or extending its duration. A locked policy can be increased or extended, but it can't be reduced, disabled, or turned off.

Therefore, before you lock a policy for retention, it's critical that you understand your organization's compliance requirements, and that you don't lock a policy until you are certain that it's what you need.

Parameter properties

Parameter sets

-RetryDistribution

Applicable: Security & Compliance

The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint locations. You don't need to specify a value with this switch.

Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch.

Parameter properties

Parameter sets

-StartSimulation

Applicable: Security & Compliance

The StartSimulation parameter specifies whether to start the simulation for a policy that was created in simulation mode. Valid values are:

• $true: Start the simulation.
• $false: Don't start the simulation. This value is the default.

For more information about simulation mode, see Learn about simulation mode.

Parameter properties

Parameter sets

-WhatIf

Applicable: Security & Compliance

The WhatIf switch doesn't work in Security & Compliance PowerShell.

Parameter properties

Parameter sets

CommonParameters