Share via


Microsoft.Graph.Calendar Module

Microsoft Graph PowerShell Cmdlets

Microsoft.Graph.Calendar Cmdlets

Cmdlet Description
Get-MgGroupCalendar

The group's calendar. Read-only.

Note

To view the beta release of this cmdlet, view Get-MgBetaGroupCalendar

Get-MgGroupCalendarEvent

The events in the calendar. Navigation property. Read-only.

Note

To view the beta release of this cmdlet, view Get-MgBetaGroupCalendarEvent

Get-MgGroupCalendarPermission

The permissions of the users with whom the calendar is shared.

Note

To view the beta release of this cmdlet, view Get-MgBetaGroupCalendarPermission

Get-MgGroupCalendarPermissionCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaGroupCalendarPermissionCount

Get-MgGroupCalendarSchedule

Get the free/busy availability information for a collection of users, distributions lists, or resources (rooms or equipment) for a specified time period.

Note

To view the beta release of this cmdlet, view Get-MgBetaGroupCalendarSchedule

Get-MgGroupCalendarView

The calendar view for the calendar. Navigation property. Read-only.

Note

To view the beta release of this cmdlet, view Get-MgBetaGroupCalendarView

Get-MgGroupEvent

Get an event object.

Note

To view the beta release of this cmdlet, view Get-MgBetaGroupEvent

Get-MgGroupEventAttachment

The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.

Note

To view the beta release of this cmdlet, view Get-MgBetaGroupEventAttachment

Get-MgGroupEventAttachmentCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaGroupEventAttachmentCount

Get-MgGroupEventCalendar

The calendar that contains the event. Navigation property. Read-only.

Note

To view the beta release of this cmdlet, view Get-MgBetaGroupEventCalendar

Get-MgGroupEventCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaGroupEventCount

Get-MgGroupEventDelta

Get a set of event resources that have been added, deleted, or updated in a calendarView (a range of events defined by start and end dates) of the user's primary calendar. Typically, synchronizing events in a calendarView in a local store entails a round of multiple delta function calls. The initial call is a full synchronization, and every subsequent delta call in the same round gets the incremental changes (additions, deletions, or updates). This allows you to maintain and synchronize a local store of events in the specified calendarView, without having to fetch all the events of that calendar from the server every time.

Note

To view the beta release of this cmdlet, view Get-MgBetaGroupEventDelta

Get-MgGroupEventExtension

Get an open extension (openTypeExtension object) identified by name or fully qualified name. The table in the Permissions section lists the resources that support open extensions. The following table lists the three scenarios where you can get an open extension from a supported resource instance.

Note

To view the beta release of this cmdlet, view Get-MgBetaGroupEventExtension

Get-MgGroupEventExtensionCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaGroupEventExtensionCount

Get-MgGroupEventInstance

The occurrences of a recurring series, if the event is a series master. This property includes occurrences that are part of the recurrence pattern, and exceptions modified, but doesn't include occurrences canceled from the series. Navigation property. Read-only. Nullable.

Note

To view the beta release of this cmdlet, view Get-MgBetaGroupEventInstance

Get-MgGroupEventInstanceDelta

Get a set of event resources that have been added, deleted, or updated in a calendarView (a range of events defined by start and end dates) of the user's primary calendar. Typically, synchronizing events in a calendarView in a local store entails a round of multiple delta function calls. The initial call is a full synchronization, and every subsequent delta call in the same round gets the incremental changes (additions, deletions, or updates). This allows you to maintain and synchronize a local store of events in the specified calendarView, without having to fetch all the events of that calendar from the server every time.

Note

To view the beta release of this cmdlet, view Get-MgBetaGroupEventInstanceDelta

Get-MgPlaceAsRoom

Get a collection of the specified type of place objects defined in the tenant. For example, you can get all the rooms, all the room lists, or the rooms in a specific room list in the tenant. A place object can be one of the following types: Both room and roomList are derived from the place object. By default, this operation returns 100 places per page. Compared with the findRooms and findRoomLists functions, this operation returns a richer payload for rooms and room lists. See details for how they compare.

Note

To view the beta release of this cmdlet, view Get-MgBetaPlaceAsRoom

Get-MgPlaceAsRoomList

Get the item of type microsoft.graph.place as microsoft.graph.roomList

Note

To view the beta release of this cmdlet, view Get-MgBetaPlaceAsRoomList

Get-MgPlaceAsRoomListRoom

Get rooms from places

Note

To view the beta release of this cmdlet, view Get-MgBetaPlaceAsRoomListRoom

Get-MgPlaceAsRoomListRoomCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaPlaceAsRoomListRoomCount

Get-MgPlaceCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaPlaceCount

Get-MgPlaceCountAsRoom

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaPlaceCountAsRoom

Get-MgPlaceCountAsRoomList

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaPlaceCountAsRoomList

Get-MgUserCalendar

The user's calendars. Read-only. Nullable.

Note

To view the beta release of this cmdlet, view Get-MgBetaUserCalendar

Get-MgUserCalendarCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaUserCalendarCount

Get-MgUserCalendarEvent

The events in the calendar. Navigation property. Read-only.

Note

To view the beta release of this cmdlet, view Get-MgBetaUserCalendarEvent

Get-MgUserCalendarGroup

The user's calendar groups. Read-only. Nullable.

Note

To view the beta release of this cmdlet, view Get-MgBetaUserCalendarGroup

Get-MgUserCalendarGroupCalendar

The calendars in the calendar group. Navigation property. Read-only. Nullable.

Note

To view the beta release of this cmdlet, view Get-MgBetaUserCalendarGroupCalendar

Get-MgUserCalendarGroupCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaUserCalendarGroupCount

Get-MgUserCalendarPermission

Get the specified permissions object of a user or group calendar that has been shared.

Note

To view the beta release of this cmdlet, view Get-MgBetaUserCalendarPermission

Get-MgUserCalendarPermissionCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaUserCalendarPermissionCount

Get-MgUserCalendarView

The calendar view for the calendar. Navigation property. Read-only.

Note

To view the beta release of this cmdlet, view Get-MgBetaUserCalendarView

Get-MgUserDefaultCalendar

The user's primary calendar. Read-only.

Note

To view the beta release of this cmdlet, view Get-MgBetaUserDefaultCalendar

Get-MgUserDefaultCalendarEvent

The events in the calendar. Navigation property. Read-only.

Note

To view the beta release of this cmdlet, view Get-MgBetaUserDefaultCalendarEvent

Get-MgUserEvent

The user's events. Default is to show Events under the Default Calendar. Read-only. Nullable.

Note

To view the beta release of this cmdlet, view Get-MgBetaUserEvent

Get-MgUserEventAttachment

The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.

Note

To view the beta release of this cmdlet, view Get-MgBetaUserEventAttachment

Get-MgUserEventAttachmentCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaUserEventAttachmentCount

Get-MgUserEventCalendar

The calendar that contains the event. Navigation property. Read-only.

Note

To view the beta release of this cmdlet, view Get-MgBetaUserEventCalendar

Get-MgUserEventCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaUserEventCount

Get-MgUserEventDelta

Get a set of event resources that have been added, deleted, or updated in a calendarView (a range of events defined by start and end dates) of the user's primary calendar. Typically, synchronizing events in a calendarView in a local store entails a round of multiple delta function calls. The initial call is a full synchronization, and every subsequent delta call in the same round gets the incremental changes (additions, deletions, or updates). This allows you to maintain and synchronize a local store of events in the specified calendarView, without having to fetch all the events of that calendar from the server every time.

Note

To view the beta release of this cmdlet, view Get-MgBetaUserEventDelta

Get-MgUserEventExtension

The collection of open extensions defined for the event. Nullable.

Note

To view the beta release of this cmdlet, view Get-MgBetaUserEventExtension

Get-MgUserEventExtensionCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaUserEventExtensionCount

Get-MgUserEventInstance

The occurrences of a recurring series, if the event is a series master. This property includes occurrences that are part of the recurrence pattern, and exceptions modified, but doesn't include occurrences canceled from the series. Navigation property. Read-only. Nullable.

Note

To view the beta release of this cmdlet, view Get-MgBetaUserEventInstance

Get-MgUserEventInstanceDelta

Get a set of event resources that have been added, deleted, or updated in a calendarView (a range of events defined by start and end dates) of the user's primary calendar. Typically, synchronizing events in a calendarView in a local store entails a round of multiple delta function calls. The initial call is a full synchronization, and every subsequent delta call in the same round gets the incremental changes (additions, deletions, or updates). This allows you to maintain and synchronize a local store of events in the specified calendarView, without having to fetch all the events of that calendar from the server every time.

Note

To view the beta release of this cmdlet, view Get-MgBetaUserEventInstanceDelta

Invoke-MgAcceptGroupEvent

Accept the specified event in a user calendar.

Note

To view the beta release of this cmdlet, view Invoke-MgBetaAcceptGroupEvent

Invoke-MgAcceptGroupEventTentatively

Tentatively accept the specified event in a user calendar. If the event allows proposals for new times, on responding tentative to the event, an invitee can choose to suggest an alternative time by including the proposedNewTime parameter. For more information on how to propose a time, and how to receive and accept a new time proposal, see Propose new meeting times.

Note

To view the beta release of this cmdlet, view Invoke-MgBetaAcceptGroupEventTentatively

Invoke-MgAcceptUserEvent

Accept the specified event in a user calendar.

Note

To view the beta release of this cmdlet, view Invoke-MgBetaAcceptUserEvent

Invoke-MgAcceptUserEventTentatively

Tentatively accept the specified event in a user calendar. If the event allows proposals for new times, on responding tentative to the event, an invitee can choose to suggest an alternative time by including the proposedNewTime parameter. For more information on how to propose a time, and how to receive and accept a new time proposal, see Propose new meeting times.

Note

To view the beta release of this cmdlet, view Invoke-MgBetaAcceptUserEventTentatively

Invoke-MgCalendarGroupCalendar

Invoke function allowedCalendarSharingRoles

Note

To view the beta release of this cmdlet, view Invoke-MgBetaCalendarGroupCalendar

Invoke-MgCalendarUserCalendarAllowedCalendarSharingRoles

Invoke function allowedCalendarSharingRoles

Note

To view the beta release of this cmdlet, view Invoke-MgBetaCalendarUserCalendarAllowedCalendarSharingRoles

Invoke-MgDeclineGroupEvent

Decline invitation to the specified event in a user calendar. If the event allows proposals for new times, on declining the event, an invitee can choose to suggest an alternative time by including the proposedNewTime parameter. For more information on how to propose a time, and how to receive and accept a new time proposal, see Propose new meeting times.

Note

To view the beta release of this cmdlet, view Invoke-MgBetaDeclineGroupEvent

Invoke-MgDeclineUserEvent

Decline invitation to the specified event in a user calendar. If the event allows proposals for new times, on declining the event, an invitee can choose to suggest an alternative time by including the proposedNewTime parameter. For more information on how to propose a time, and how to receive and accept a new time proposal, see Propose new meeting times.

Note

To view the beta release of this cmdlet, view Invoke-MgBetaDeclineUserEvent

Invoke-MgDismissGroupEventReminder

Dismiss a reminder that has been triggered for an event in a user calendar.

Note

To view the beta release of this cmdlet, view Invoke-MgBetaDismissGroupEventReminder

Invoke-MgDismissUserEventReminder

Dismiss a reminder that has been triggered for an event in a user calendar.

Note

To view the beta release of this cmdlet, view Invoke-MgBetaDismissUserEventReminder

Invoke-MgForwardGroupEvent

This action allows the organizer or attendee of a meeting event to forward themeeting request to a new recipient. If the meeting event is forwarded from an attendee's Microsoft 365 mailbox to another recipient, this actionalso sends a message to notify the organizer of the forwarding, and adds the recipient to the organizer'scopy of the meeting event. This convenience is not available when forwarding from an Outlook.com account.

Note

To view the beta release of this cmdlet, view Invoke-MgBetaForwardGroupEvent

Invoke-MgForwardUserEvent

This action allows the organizer or attendee of a meeting event to forward themeeting request to a new recipient. If the meeting event is forwarded from an attendee's Microsoft 365 mailbox to another recipient, this actionalso sends a message to notify the organizer of the forwarding, and adds the recipient to the organizer'scopy of the meeting event. This convenience is not available when forwarding from an Outlook.com account.

Note

To view the beta release of this cmdlet, view Invoke-MgBetaForwardUserEvent

Invoke-MgSnoozeGroupEventReminder

Postpone a reminder for an event in a user calendar until a new time.

Note

To view the beta release of this cmdlet, view Invoke-MgBetaSnoozeGroupEventReminder

Invoke-MgSnoozeUserEventReminder

Postpone a reminder for an event in a user calendar until a new time.

Note

To view the beta release of this cmdlet, view Invoke-MgBetaSnoozeUserEventReminder

New-MgGroupCalendarEvent

Create new navigation property to events for groups

Note

To view the beta release of this cmdlet, view New-MgBetaGroupCalendarEvent

New-MgGroupCalendarPermission

Create new navigation property to calendarPermissions for groups

Note

To view the beta release of this cmdlet, view New-MgBetaGroupCalendarPermission

New-MgGroupEvent

Use this API to create a new event.

Note

To view the beta release of this cmdlet, view New-MgBetaGroupEvent

New-MgGroupEventAttachment

Create new navigation property to attachments for groups

Note

To view the beta release of this cmdlet, view New-MgBetaGroupEventAttachment

New-MgGroupEventAttachmentUploadSession

Create an upload session that allows an app to iteratively upload ranges of a file, so as to attach the file to the specified Outlook item. The item can be a message or event. Use this approach to attach a file if the file size is between 3 MB and 150 MB. To attach a file that's smaller than 3 MB, do a POST operation on the attachments navigation property of the Outlook item; see how to do this for a message or for an event. As part of the response, this action returns an upload URL that you can use in subsequent sequential PUT queries. Request headers for each PUT operation let you specify the exact range of bytes to be uploaded. This allows transfer to be resumed, in case the network connection is dropped during upload. The following are the steps to attach a file to an Outlook item using an upload session: See attach large files to Outlook messages or events for an example.

Note

To view the beta release of this cmdlet, view New-MgBetaGroupEventAttachmentUploadSession

New-MgGroupEventExtension

Create an open extension (openTypeExtension object) and add custom properties in a new or existing instance of a resource. You can create an open extension in a resource instance and store custom data to it all in the same operation, except for specific resources. The table in the Permissions section lists the resources that support open extensions.

Note

To view the beta release of this cmdlet, view New-MgBetaGroupEventExtension

New-MgPlaceAsRoomListRoom

Create new navigation property to rooms for places

Note

To view the beta release of this cmdlet, view New-MgBetaPlaceAsRoomListRoom

New-MgUserCalendar

Create new navigation property to calendars for users

Note

To view the beta release of this cmdlet, view New-MgBetaUserCalendar

New-MgUserCalendarEvent

Create new navigation property to events for users

Note

To view the beta release of this cmdlet, view New-MgBetaUserCalendarEvent

New-MgUserCalendarGroup

Create new navigation property to calendarGroups for users

Note

To view the beta release of this cmdlet, view New-MgBetaUserCalendarGroup

New-MgUserCalendarGroupCalendar

Create new navigation property to calendars for users

Note

To view the beta release of this cmdlet, view New-MgBetaUserCalendarGroupCalendar

New-MgUserCalendarPermission

Create new navigation property to calendarPermissions for users

Note

To view the beta release of this cmdlet, view New-MgBetaUserCalendarPermission

New-MgUserDefaultCalendarEvent

Create new navigation property to events for users

Note

To view the beta release of this cmdlet, view New-MgBetaUserDefaultCalendarEvent

New-MgUserEvent

Create new navigation property to events for users

Note

To view the beta release of this cmdlet, view New-MgBetaUserEvent

New-MgUserEventAttachment

Create new navigation property to attachments for users

Note

To view the beta release of this cmdlet, view New-MgBetaUserEventAttachment

New-MgUserEventAttachmentUploadSession

Create an upload session that allows an app to iteratively upload ranges of a file, so as to attach the file to the specified Outlook item. The item can be a message or event. Use this approach to attach a file if the file size is between 3 MB and 150 MB. To attach a file that's smaller than 3 MB, do a POST operation on the attachments navigation property of the Outlook item; see how to do this for a message or for an event. As part of the response, this action returns an upload URL that you can use in subsequent sequential PUT queries. Request headers for each PUT operation let you specify the exact range of bytes to be uploaded. This allows transfer to be resumed, in case the network connection is dropped during upload. The following are the steps to attach a file to an Outlook item using an upload session: See attach large files to Outlook messages or events for an example.

Note

To view the beta release of this cmdlet, view New-MgBetaUserEventAttachmentUploadSession

New-MgUserEventExtension

Create new navigation property to extensions for users

Note

To view the beta release of this cmdlet, view New-MgBetaUserEventExtension

Remove-MgGroupCalendarEvent

Delete navigation property events for groups

Note

To view the beta release of this cmdlet, view Remove-MgBetaGroupCalendarEvent

Remove-MgGroupCalendarPermanent

Permanently delete a calendar folder and the events that it contains and remove them from the mailbox. For more information about item retention, see Configure deleted item retention and recoverable items quotas.

Note

To view the beta release of this cmdlet, view Remove-MgBetaGroupCalendarPermanent

Remove-MgGroupCalendarPermission

Delete navigation property calendarPermissions for groups

Note

To view the beta release of this cmdlet, view Remove-MgBetaGroupCalendarPermission

Remove-MgGroupEvent

Delete an event object.

Note

To view the beta release of this cmdlet, view Remove-MgBetaGroupEvent

Remove-MgGroupEventAttachment

Delete navigation property attachments for groups

Note

To view the beta release of this cmdlet, view Remove-MgBetaGroupEventAttachment

Remove-MgGroupEventExtension

Delete navigation property extensions for groups

Note

To view the beta release of this cmdlet, view Remove-MgBetaGroupEventExtension

Remove-MgGroupEventPermanent

Invoke action permanentDelete

Note

To view the beta release of this cmdlet, view Remove-MgBetaGroupEventPermanent

Remove-MgPlace

Delete entity from places

Note

To view the beta release of this cmdlet, view Remove-MgBetaPlace

Remove-MgPlaceAsRoomListRoom

Delete navigation property rooms for places

Note

To view the beta release of this cmdlet, view Remove-MgBetaPlaceAsRoomListRoom

Remove-MgUserCalendarGroup

Delete navigation property calendarGroups for users

Note

To view the beta release of this cmdlet, view Remove-MgBetaUserCalendarGroup

Remove-MgUserCalendarPermanent

Permanently delete a calendar folder and the events that it contains and remove them from the mailbox. For more information about item retention, see Configure deleted item retention and recoverable items quotas.

Note

To view the beta release of this cmdlet, view Remove-MgBetaUserCalendarPermanent

Remove-MgUserCalendarPermission

Delete calendarPermission.

Note

To view the beta release of this cmdlet, view Remove-MgBetaUserCalendarPermission

Remove-MgUserEvent

Delete navigation property events for users

Note

To view the beta release of this cmdlet, view Remove-MgBetaUserEvent

Remove-MgUserEventAttachment

Delete navigation property attachments for users

Note

To view the beta release of this cmdlet, view Remove-MgBetaUserEventAttachment

Remove-MgUserEventExtension

Delete navigation property extensions for users

Note

To view the beta release of this cmdlet, view Remove-MgBetaUserEventExtension

Remove-MgUserEventPermanent

Invoke action permanentDelete

Note

To view the beta release of this cmdlet, view Remove-MgBetaUserEventPermanent

Stop-MgGroupEvent

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-MgBetaGroupEvent

Stop-MgUserEvent

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-MgBetaUserEvent

Update-MgGroupCalendarEvent

Update an event object.

Note

To view the beta release of this cmdlet, view Update-MgBetaGroupCalendarEvent

Update-MgGroupCalendarPermission

Update the navigation property calendarPermissions in groups

Note

To view the beta release of this cmdlet, view Update-MgBetaGroupCalendarPermission

Update-MgGroupEvent

Update the navigation property events in groups

Note

To view the beta release of this cmdlet, view Update-MgBetaGroupEvent

Update-MgGroupEventExtension

Update the navigation property extensions in groups

Note

To view the beta release of this cmdlet, view Update-MgBetaGroupEventExtension

Update-MgPlace

Update the properties of place object, which can be a room or roomList. You can identify the room or roomList by specifying the id or emailAddress property.

Note

To view the beta release of this cmdlet, view Update-MgBetaPlace

Update-MgPlaceAsRoomListRoom

Update the navigation property rooms in places

Note

To view the beta release of this cmdlet, view Update-MgBetaPlaceAsRoomListRoom

Update-MgUserCalendarGroup

Update the navigation property calendarGroups in users

Note

To view the beta release of this cmdlet, view Update-MgBetaUserCalendarGroup

Update-MgUserCalendarPermission

Update the permissions assigned to an existing share recipient or delegate, through the corresponding calendarPermission object for a calendar.

Note

To view the beta release of this cmdlet, view Update-MgBetaUserCalendarPermission

Update-MgUserEvent

Update the navigation property events in users

Note

To view the beta release of this cmdlet, view Update-MgBetaUserEvent

Update-MgUserEventExtension

Update the navigation property extensions in users

Note

To view the beta release of this cmdlet, view Update-MgBetaUserEventExtension