New-RetentionCompliancePolicy

 

Applies to: Office 365 Security & Compliance Center

Topic Last Modified: 2017-05-30

This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell.

Use the New-RetentionCompliancePolicy cmdlet to create new retention policies in the Security & Compliance Center.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-RetentionCompliancePolicy -Name <String> [-Comment <String>] [-Confirm [<SwitchParameter>]] [-Enabled <$true | $false>] [-ExchangeLocation <MultiValuedProperty>] [-ExchangeLocationException <MultiValuedProperty>] [-Force <SwitchParameter>] [-ModernGroupLocation <MultiValuedProperty>] [-ModernGroupLocationException <MultiValuedProperty>] [-OneDriveLocation <MultiValuedProperty>] [-OneDriveLocationException <MultiValuedProperty>] [-PublicFolderLocation <MultiValuedProperty>] [-RestrictiveRetention <$true | $false>] [-SharePointLocation <MultiValuedProperty>] [-SharePointLocationException <MultiValuedProperty>] [-SkypeLocation <MultiValuedProperty>] [-SkypeLocationException <MultiValuedProperty>] [-WhatIf [<SwitchParameter>]]

This example creates a retention policy named "Regulation 123 Compliance" for the mailboxes of Kitty Petersen and Scott Nakamura, and the finance SharePoint Online site.

New-RetentionCompliancePolicy -Name "Regulation 123 Compliance" -ExchangeLocation "Kitty Petersen", "Scott Nakamura" -SharePointLocation "http://contoso.sharepoint.com/sites/teams/finance"

New policies are not valid and will not be applied until a retention rule 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.

 

Parameter Required Type Description

Name

Required

System.String

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

Comment

Optional

System.String

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

Confirm

Optional

System.Management.Automation.SwitchParameter

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.

Enabled

Optional

System.Boolean

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

ExchangeLocation

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExchangeLocation parameter specifies the mailboxes to include. Valid values are:

  • A mailbox

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

  • The value All for all mailboxes. You can only use this value by itself.

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

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

If no mailboxes are specified, then no mailboxes are placed on hold.

ExchangeLocationException

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the mailboxes to remove from 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

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

Force

Optional

System.Management.Automation.SwitchParameter

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.

ModernGroupLocation

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ModernGroupLocation parameter specifies the Office 365 groups to include in the policy. Valid values are:

  • An Office 365 Group

  • The value All for all Office 365 groups. You can only use this value by itself.

To identify the Office 365 Group, you can use any value that uniquely identifies it. 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>".

ModernGroupLocationException

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ModernGroupLocationException parameter specifies the Office 365 groups to exclude when you're using the value All for the ModernGroupLocation parameter.

You can use any value that uniquely identifies the Office 365 Group. 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>".

OneDriveLocation

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The OneDriveLocation parameter specifies the OneDrive for Business sites to include. You identify the site by its URL value, or you can use the value All to include all sites.

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

OneDriveLocationException

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the OneDrive for Business sites to exclude when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value.

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

PublicFolderLocation

Optional

Microsoft.Exchange.Data.MultiValuedProperty

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

RestrictiveRetention

Optional

System.Boolean

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.

warningWarning:
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.

SharePointLocation

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value, or you can use the value All to include all sites.

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

SharePoint Online sites can't be added to the policy until they have been indexed. If no sites are specified, then no sites are placed on hold.

SharePointLocationException

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the SharePoint Online sites to exclude when you use the value All for the SharePointLocation parameter. You identify the site by its URL value.

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

SkypeLocation

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The SkypeLocation parameter specifies the Skype for Business Online users to include in the policy.

You can use any value that uniquely identifies the user. 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>".

SkypeLocationException

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter is reserved for internal Microsoft use.

WhatIf

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

 
Show: