Stop-MgGroupCalendarEvent
This action allows the organizer of a meeting to send a cancellation message and cancel the event. The action moves the event to the Deleted Items folder. The organizer can also cancel an occurrence of a recurring meeting by providing the occurrence event ID. An attendee calling this action gets an error (HTTP 400 Bad Request), with the followingerror message: 'Your request can't be completed. You need to be an organizer to cancel a meeting.' This action differs from Delete in that Cancel is available to only the organizer, and letsthe organizer send a custom message to the attendees about the cancellation.
Note
To view the beta release of this cmdlet, view Stop-MgBetaGroupCalendarEvent
Syntax
Stop-MgGroupCalendarEvent
-EventId <String>
-GroupId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-Comment <String>]
[-Headers <IDictionary>]
[-PassThru]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Stop-MgGroupCalendarEvent
-EventId <String>
-GroupId <String>
-BodyParameter <IPaths1HhqhocGroupsGroupIdCalendarEventsEventIdMicrosoftGraphCancelPostRequestbodyContentApplicationJsonSchema>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Stop-MgGroupCalendarEvent
-InputObject <IGroupsIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-Comment <String>]
[-Headers <IDictionary>]
[-PassThru]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Stop-MgGroupCalendarEvent
-InputObject <IGroupsIdentity>
-BodyParameter <IPaths1HhqhocGroupsGroupIdCalendarEventsEventIdMicrosoftGraphCancelPostRequestbodyContentApplicationJsonSchema>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
This action allows the organizer of a meeting to send a cancellation message and cancel the event. The action moves the event to the Deleted Items folder. The organizer can also cancel an occurrence of a recurring meeting by providing the occurrence event ID. An attendee calling this action gets an error (HTTP 400 Bad Request), with the followingerror message: 'Your request can't be completed. You need to be an organizer to cancel a meeting.' This action differs from Delete in that Cancel is available to only the organizer, and letsthe organizer send a custom message to the attendees about the cancellation.
Permissions
| Permission type | Least privileged permissions | Higher privileged permissions |
|---|---|---|
| Delegated (work or school account) | Calendars.ReadWrite | Not available. |
| Delegated (personal Microsoft account) | Calendars.ReadWrite | Not available. |
| Application | Calendars.ReadWrite | Not available. |
Parameters
-AdditionalProperties
Additional Parameters
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BodyParameter
. To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
| Type: | IPaths1HhqhocGroupsGroupIdCalendarEventsEventIdMicrosoftGraphCancelPostRequestbodyContentApplicationJsonSchema |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Comment
.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EventId
The unique identifier of event
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-GroupId
The unique identifier of group
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Headers
Optional headers that will be added to the request.
| Type: | IDictionary |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | IGroupsIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PassThru
Returns true when the command succeeds
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProgressAction
{{ Fill ProgressAction Description }}
| Type: | ActionPreference |
| Aliases: | proga |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResponseHeadersVariable
Optional Response Headers Variable.
| Type: | String |
| Aliases: | RHV |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.Graph.PowerShell.Models.IGroupsIdentity
Microsoft.Graph.PowerShell.Models.IPaths1HhqhocGroupsGroupIdCalendarEventsEventIdMicrosoftGraphCancelPostRequestbodyContentApplicationJsonSchema
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.
BODYPARAMETER <IPaths1HhqhocGroupsGroupIdCalendarEventsEventIdMicrosoftGraphCancelPostRequestbodyContentApplicationJsonSchema>: .
[(Any) <Object>]: This indicates any property can be added to this object.[Comment <String>]:
INPUTOBJECT <IGroupsIdentity>: Identity Parameter
[AttachmentId <String>]: The unique identifier of attachment[BaseSitePageId <String>]: The unique identifier of baseSitePage[ContentTypeId <String>]: The unique identifier of contentType[ConversationId <String>]: The unique identifier of conversation[ConversationThreadId <String>]: The unique identifier of conversationThread[DirectoryObjectId <String>]: The unique identifier of directoryObject[DocumentSetVersionId <String>]: The unique identifier of documentSetVersion[DriveId <String>]: The unique identifier of drive[DriveItemId <String>]: The unique identifier of driveItem[DriveItemVersionId <String>]: The unique identifier of driveItemVersion[EndDateTime <String>]: Usage: endDateTime='{endDateTime}'[EventId <String>]: The unique identifier of event[ExtensionId <String>]: The unique identifier of extension[GroupId <String>]: The unique identifier of group[GroupLifecyclePolicyId <String>]: The unique identifier of groupLifecyclePolicy[GroupSettingId <String>]: The unique identifier of groupSetting[GroupSettingTemplateId <String>]: The unique identifier of groupSettingTemplate[HorizontalSectionColumnId <String>]: The unique identifier of horizontalSectionColumn[HorizontalSectionId <String>]: The unique identifier of horizontalSection[IncludePersonalNotebooks <Boolean?>]: Usage: includePersonalNotebooks={includePersonalNotebooks}[Interval <String>]: Usage: interval='{interval}'[ListId <String>]: The unique identifier of list[ListItemId <String>]: The unique identifier of listItem[ListItemVersionId <String>]: The unique identifier of listItemVersion[NotebookId <String>]: The unique identifier of notebook[OnenotePageId <String>]: The unique identifier of onenotePage[OnenoteSectionId <String>]: The unique identifier of onenoteSection[Path <String>]: Usage: path='{path}'[PermissionId <String>]: The unique identifier of permission[PostId <String>]: The unique identifier of post[ProfilePhotoId <String>]: The unique identifier of profilePhoto[Q <String>]: Usage: q='{q}'[ResourceSpecificPermissionGrantId <String>]: The unique identifier of resourceSpecificPermissionGrant[SiteId <String>]: The unique identifier of site[StartDateTime <String>]: Usage: startDateTime='{startDateTime}'[SubscriptionId <String>]: The unique identifier of subscription[Token <String>]: Usage: token='{token}'[UniqueName <String>]: Alternate key of group[User <String>]: Usage: User='{User}'[WebPartId <String>]: The unique identifier of webPart