Remove-RetentionComplianceRule
This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell.
Use the Remove-RetentionComplianceRule cmdlet to remove retention rules from the Security & Compliance Center.
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.
Syntax
Remove-RetentionComplianceRule
[-Identity] <PolicyIdParameter>
[-Confirm]
[-ForceDeletion]
[-WhatIf]
[<CommonParameters>]
Description
Removing a retention rule causes the release of all Exchange mailbox and SharePoint site retentions that are associated with the rule. Removing a retention rule also causes the corresponding retention policy to become invalid, so you should remove it by using the Remove-RetentionCompliancePolicy cmdlet.
You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center.
Examples
Example 1
Remove-RetentionComplianceRule -Identity "One Year Standard"
This example removes the retention rule named "One Year Standard".
Parameters
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: | Security & Compliance Center |
The ForceDeletion switch forces the removal of the retention rule. 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: | Security & Compliance Center |
The Identity parameter specifies the retention rule to remove. You can use any value that uniquely identifies the rule. For example:
- Name
- Distinguished name (DN)
- GUID
Type: | PolicyIdParameter |
Position: | 1 |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | Security & Compliance Center |
The WhatIf switch doesn't work in Security & Compliance Center PowerShell.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance Center |
Inputs
Outputs