Remove-MgBetaUserEventPermanent
Permanently delete an event and place it in the Purges folder in the dumpster in the user's mailbox. Email clients such as Outlook or the Outlook on the web can't access permanently deleted items. Unless there's a hold set on the mailbox, the items are permanently deleted after a set period of time. For more information about item retention, see Configure Deleted Item retention and Recoverable Items quotas.
Note
To view the v1.0 release of this cmdlet, view Remove-MgUserEventPermanent
Syntax
Delete (Default)
Remove-MgBetaUserEventPermanent
-EventId <String>
-UserId <String>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
DeleteViaIdentity
Remove-MgBetaUserEventPermanent
-InputObject <ICalendarIdentity>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Permanently delete an event and place it in the Purges folder in the dumpster in the user's mailbox. Email clients such as Outlook or the Outlook on the web can't access permanently deleted items. Unless there's a hold set on the mailbox, the items are permanently deleted after a set period of time. For more information about item retention, see Configure Deleted Item retention and Recoverable Items quotas.
Permissions
Permission type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | Calendars.ReadWrite, |
Delegated (personal Microsoft account) | Calendars.ReadWrite, |
Application | Calendars.ReadWrite, |
Examples
Example 1: Code snippet
Import-Module Microsoft.Graph.Beta.Calendar
Remove-MgBetaUserEventPermanent -UserId $userId -EventId $eventId
This example shows how to use the Remove-MgBetaUserEventPermanent Cmdlet.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: | SwitchParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Aliases: | cf |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-EventId
The unique identifier of event
Parameter properties
Type: | String |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
Delete
Position: | Named |
Mandatory: | True |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-Headers
Optional headers that will be added to the request.
Parameter properties
Type: | IDictionary |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | True |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Parameter properties
Type: | ICalendarIdentity |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
DeleteViaIdentity
Position: | Named |
Mandatory: | True |
Value from pipeline: | True |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-PassThru
Returns true when the command succeeds
Parameter properties
Type: | SwitchParameter |
Default value: | False |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-ResponseHeadersVariable
Optional Response Headers Variable.
Parameter properties
Type: | String |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Aliases: | RHV |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-UserId
The unique identifier of user
Parameter properties
Type: | String |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
Delete
Position: | Named |
Mandatory: | True |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
Type: | SwitchParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Aliases: | wi |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Microsoft.Graph.Beta.PowerShell.Models.ICalendarIdentity
System.Collections.IDictionary
Outputs
System.Boolean
Notes
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
INPUTOBJECT <ICalendarIdentity>
: Identity Parameter
[AttachmentId <String>]
: The unique identifier of attachment[CalendarGroupId <String>]
: The unique identifier of calendarGroup[CalendarId <String>]
: The unique identifier of calendar[CalendarPermissionId <String>]
: The unique identifier of calendarPermission[EventId <String>]
: The unique identifier of event[EventId1 <String>]
: The unique identifier of event[EventId2 <String>]
: The unique identifier of event[ExtensionId <String>]
: The unique identifier of extension[GroupId <String>]
: The unique identifier of group[PlaceId <String>]
: The unique identifier of place[RoomId <String>]
: The unique identifier of room[User <String>]
: Usage: User='{User}'[UserId <String>]
: The unique identifier of user[WorkspaceId <String>]
: The unique identifier of workspace