|
| 1 | +--- |
| 2 | +external help file: Microsoft.Exchange.TransportMailflow-Help.xml |
| 3 | +online version: https://learn.microsoft.com/powershell/module/exchange/remove-complianceretentionevent |
| 4 | +applicable: Security & Compliance |
| 5 | +title: Remove-ComplianceRetentionEvent |
| 6 | +schema: 2.0.0 |
| 7 | +author: chrisda |
| 8 | +ms.author: chrisda |
| 9 | +ms.reviewer: |
| 10 | +--- |
| 11 | + |
| 12 | +# Remove-ComplianceRetentionEvent |
| 13 | + |
| 14 | +## SYNOPSIS |
| 15 | +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). |
| 16 | + |
| 17 | +Use the Remove-ComplianceRetentionEvent cmdlet to remove compliance retention events in the Microsoft Purview compliance portal. |
| 18 | + |
| 19 | +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). |
| 20 | + |
| 21 | +## SYNTAX |
| 22 | + |
| 23 | +``` |
| 24 | +Remove-ComplianceRetentionEvent [-Identity] <PolicyIdParameter> |
| 25 | + [-Confirm] |
| 26 | + [-ForceDeletion] |
| 27 | + [-PreviewOnly] |
| 28 | + [-WhatIf] [<CommonParameters>] |
| 29 | +``` |
| 30 | + |
| 31 | +## DESCRIPTION |
| 32 | +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). |
| 33 | + |
| 34 | +## EXAMPLES |
| 35 | + |
| 36 | +### Example 1 |
| 37 | +```powershell |
| 38 | +Remove-ComplianceRetentionEvent -Identity "Research Project Employees" |
| 39 | +``` |
| 40 | + |
| 41 | +This example removes the specified compliance retention event. |
| 42 | + |
| 43 | +## PARAMETERS |
| 44 | + |
| 45 | +### -Identity |
| 46 | +The Identity parameter specifies the compliance retention event that you want to remove. You can use any value that uniquely identifies the event. For example: |
| 47 | + |
| 48 | +- Name |
| 49 | +- Distinguished name (DN) |
| 50 | +- GUID |
| 51 | + |
| 52 | +```yaml |
| 53 | +Type: PolicyIdParameter |
| 54 | +Parameter Sets: (All) |
| 55 | +Aliases: |
| 56 | +Applicable: Security & Compliance |
| 57 | + |
| 58 | +Required: True |
| 59 | +Position: 0 |
| 60 | +Default value: None |
| 61 | +Accept pipeline input: True (ByPropertyName, ByValue) |
| 62 | +Accept wildcard characters: False |
| 63 | +``` |
| 64 | +
|
| 65 | +### -Confirm |
| 66 | +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. |
| 67 | +
|
| 68 | +- 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`. |
| 69 | +- 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. |
| 70 | + |
| 71 | +```yaml |
| 72 | +Type: SwitchParameter |
| 73 | +Parameter Sets: (All) |
| 74 | +Aliases: cf |
| 75 | +Applicable: Security & Compliance |
| 76 | +
|
| 77 | +Required: False |
| 78 | +Position: Named |
| 79 | +Default value: None |
| 80 | +Accept pipeline input: False |
| 81 | +Accept wildcard characters: False |
| 82 | +``` |
| 83 | + |
| 84 | +### -ForceDeletion |
| 85 | +{{ Fill ForceDeletion Description }} |
| 86 | + |
| 87 | +```yaml |
| 88 | +Type: SwitchParameter |
| 89 | +Parameter Sets: (All) |
| 90 | +Aliases: |
| 91 | +Applicable: Security & Compliance |
| 92 | +
|
| 93 | +Required: False |
| 94 | +Position: Named |
| 95 | +Default value: None |
| 96 | +Accept pipeline input: False |
| 97 | +Accept wildcard characters: False |
| 98 | +``` |
| 99 | + |
| 100 | +### -PreviewOnly |
| 101 | +{{ Fill PreviewOnly Description }} |
| 102 | + |
| 103 | +```yaml |
| 104 | +Type: SwitchParameter |
| 105 | +Parameter Sets: (All) |
| 106 | +Aliases: |
| 107 | +Applicable: Security & Compliance |
| 108 | +
|
| 109 | +Required: False |
| 110 | +Position: Named |
| 111 | +Default value: None |
| 112 | +Accept pipeline input: False |
| 113 | +Accept wildcard characters: False |
| 114 | +``` |
| 115 | + |
| 116 | +### -WhatIf |
| 117 | +The WhatIf switch doesn't work in Security & Compliance PowerShell. |
| 118 | + |
| 119 | +```yaml |
| 120 | +Type: SwitchParameter |
| 121 | +Parameter Sets: (All) |
| 122 | +Aliases: wi |
| 123 | +Applicable: Security & Compliance |
| 124 | +
|
| 125 | +Required: False |
| 126 | +Position: Named |
| 127 | +Default value: None |
| 128 | +Accept pipeline input: False |
| 129 | +Accept wildcard characters: False |
| 130 | +``` |
| 131 | + |
| 132 | +### CommonParameters |
| 133 | +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). |
| 134 | + |
| 135 | +## INPUTS |
| 136 | + |
| 137 | +## OUTPUTS |
| 138 | + |
| 139 | +## NOTES |
| 140 | + |
| 141 | +## RELATED LINKS |
0 commit comments