New-TeamsRetentionCompliancePolicy

This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx).

Use the New-TeamsRetentionCompliancePolicy cmdlet to create new retention policies for Microsoft Teams in the Security & Compliance Center.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).

Syntax

New-TeamsRetentionCompliancePolicy
   [-Name] <String>]
   [-Comment <String>]
   [-Enabled <$true | $false>]
   [-Force]
   [-RestrictiveRetention <$true | $false>]
   [-TeamsChannelLocation <MultiValuedProperty>]
   [-TeamsChatLocationException <MultiValuedProperty>]
   [-TeamsChatLocation <MultiValuedProperty>]
   [-TeamsChannelLocationException <MultiValuedProperty>]
   [-Confirm]
   [-WhatIf]

Description

New policies are not valid and will not be applied until a retention rule for Microsoft Teams is added to the policy.

You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920).

Examples

-------------------------- Example 1 --------------------------

New-TeamsRetentionCompliancePolicy -Name "Teams - Regulation 123 Compliance" -TeamsChannelLocation "Engineering Team", "UX Design Team" -TeamsChatLocation "Kitty Petersen", "Scott Nakamura"

This example creates a retention policy named "Teams - Regulation 123 Compliance" for the Teams channel messages in the teams by the names of Engineering Team and UX Design Team and Teams chats in the mailboxes of Kitty Petersen and Scott Nakamura.

Required Parameters

-Name

The Name parameter specifies the unique name of the retention policy for Microsoft Teams. If the value contains spaces, enclose the value in quotation marks.

Type:String
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Office 365 Security & Compliance Center

Optional Parameters

-Comment

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

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Office 365 Security & Compliance Center
-Confirm

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.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Office 365 Security & Compliance Center
-Enabled

he Enabled parameter specifies whether the policy is enabled or disabled. Valid values are:

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

  • $false: The policy is disabled.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Office 365 Security & Compliance Center
-Force

The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Office 365 Security & Compliance Center
-RestrictiveRetention

The RestrictiveRetention parameter specifies whether Preservation Lock is enabled for the 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 is the default value.

After a policy has been 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 ways 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 retention policy, 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.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Office 365 Security & Compliance Center
-TeamsChannelLocation

The TeamsChannelLocation parameter specifies the Team (group) mailbox for the team whose channel messages you want to include in the policy. You identify the channels by the parent team's (group) mailbox, or you can use the value All to include all Teams in the tenant.

You can use any value that uniquely identifies the group (team) mailbox. For example:

  • Name

  • Distinguished name (DN)

  • Email address

  • GUID

To enter multiple values, use the following syntax: <value1>,<value2>,...<valueX>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "<value1>","<value2>",..."<valueX>".

Type:MultiValuedProperty
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Office 365 Security & Compliance Center
-TeamsChannelLocationException

The TeamsChannelLocationException parameter specifies the Team (group) mailbox for the team whose channel messages you want to exclude in the policy when you use the value All in the TeamsChannelLocation parameter. You can use any value that uniquely identifies the group (team) mailbox.

To enter multiple values, use the following syntax: <value1>,<value2>,...<valueX>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "<value1>","<value2>",..."<valueX>".

Type:MultiValuedProperty
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Office 365 Security & Compliance Center
-TeamsChatLocation

The TeamsChatLocation parameter specifies the Microsoft Teams chats to include in the policy. You identify the chat by the user mailbox, or you can use the value All to include all chats for all users from all user mailboxes.

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

  • Name

  • Distinguished name (DN)

  • Email address

  • GUID

To enter multiple values, use the following syntax: <value1>,<value2>,...<valueX>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "<value1>","<value2>",..."<valueX>".

Type:MultiValuedProperty
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Office 365 Security & Compliance Center
-TeamsChatLocationException

The TeamsChatLocationException parameter specifies the Microsoft Teams chat locations to exclude when you use the value All for the TeamsChatLocation parameter. You identify the chat by the user mailbox.

To enter multiple values, use the following syntax: <value1>,<value2>,...<valueX>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "<value1>","<value2>",..."<valueX>".

Type:MultiValuedProperty
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Office 365 Security & Compliance Center
-WhatIf

The WhatIf switch doesn't work in the Office 365 Security & Compliance Center.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Office 365 Security & Compliance Center

Inputs

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data.

Outputs

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data.