Get-MgUserEvent: How to Retrieve User Calendar Events with Graph PowerShell

The Get-MgUserEvent cmdlet is a powerful tool in Microsoft Graph PowerShell that allows administrators to access and manage calendar events for users in Microsoft 365. In this article, we'll explore the syntax, usage examples, tips, use cases, possible errors, and solutions related to this cmdlet.

Cmdlet Syntax

Get-MgUserEvent -UserId <String> [-EventId <String>]

• -UserId: UPN or User Id of the user whose calendar events you wish to query.
• -EventId: Event Id of the calendar event you wish to view in detail.

Usage Examples

Querying All Events for a User

$userId = "user@example.com"
$events = Get-MgUserEvent -UserId $userId
$events | ForEach-Object {
[PSCustomObject]@{
    Subject = $_.Subject
    Start   = $_.Start.DateTime
    End     = $_.End.DateTime
    Id      = $_.Id
}
} | Select-Object Subject, Start, End, Id

This command lists all events in a user's default calendar. Replace "user@example.com" with the actual User UPN.

Querying a Specific Event

$userId = "samadmin@7xh7fj.onmicrosoft.com"
$eventId = "event-id"
$event = Get-MgUserEvent -UserId $userId -EventId $eventId
$eventDetails = [PSCustomObject]@{
    Subject    = $event.Subject
    Start      = $event.Start.DateTime
    End        = $event.End.DateTime
    Location   = $event.Location.DisplayName
    Attendees  = ($event.Attendees | ForEach-Object { $_.EmailAddress.Address }) -join " "
}
$eventDetails | Format-List

This command retrieves details of a specific event using its ID. Replace "event-id" with the actual event ID.

Filtering Events by Subject

You can filter calendar events based on their subject using the -Filter parameter. This is particularly useful when you're looking for events with specific keywords in their titles.

$userId = "user@example.com"
$subjectKeyword = "Project Update"
$filteredEvents = Get-MgUserEvent -UserId $userId -Filter "contains(subject, '$subjectKeyword')"
$filteredEvents | ForEach-Object {
    [PSCustomObject]@{
        Subject = $_.Subject
        Start   = $_.Start.DateTime
        End     = $_.End.DateTime
        Id      = $_.Id
    }
} | Format-Table Subject, Start, End, Id

Retrieve Events Organized by a Specific User

Connect-MgGraph -Scopes "Calendars.Read"
$UserId = "user@domain.com"
$OrganizerEmail = "manager@domain.com"
Get-MgUserEvent -UserId $UserId -All |
Where-Object {
    $_.Organizer.EmailAddress.Address -eq $OrganizerEmail
} |
Select-Object `
    Subject,
    @{Name="Organizer";Expression={$_.Organizer.EmailAddress.Address}},
    @{Name="StartTime";Expression={$_.Start.DateTime}},
    @{Name="EndTime";Expression={$_.End.DateTime}},
    Id

                    

What this script does

This script retrieves calendar events from a user’s calendar and filters only the meetings organized by a specific person.

Why this example is useful

This is useful when reviewing meetings scheduled by a manager, project lead, external consultant, or service account. It can help with calendar audits, meeting cleanup, and troubleshooting recurring meeting ownership issues.

Cmdlet Tips

• Permissions: Ensure you have the necessary permissions to access user calendar events. For delegated access, Calendars.Read or Calendars.ReadWrite permissions are required. For application access, appropriate application permissions must be granted.
• Filtering: The -Filter parameter allows you to refine your queries. For instance, you can filter events by start time, end time, or subject keywords. This is useful for retrieving specific events without processing unnecessary data.
• Expand Properties: Use the -ExpandProperty parameter to retrieve additional properties that are not returned by default. This is helpful when you need more detailed information about the events.

Use Cases

• Event Management: Administrators can utilize this cmdlet to manage and audit user calendar events, ensuring compliance with organizational policies
• Automation: Automate tasks such as sending reminders for upcoming events, generating event reports, or syncing events with other systems
• Troubleshooting: Identify and resolve issues related to user calendar events, such as missing or duplicate entries.

Possible Errors & Solutions

Frequently Asked Questions

1. What is Get-MgUserEvent used for?

Get-MgUserEvent is a Microsoft Graph PowerShell cmdlet used to retrieve events from a user’s calendar, including event details like subject, attendees, and location.

2. How can I retrieve all calendar events for a user?

Use the following command to fetch all calendar events:

Get-MgUserEvent -UserId "<UserPrincipalName>" -All

3. How can I filter events by a specific date range?

Get-MgUserEvent -UserId "<UserPrincipalName>" -Filter "start/dateTime ge '2023-11-01T00:00:00Z' and end/dateTime le '2023-11-30T23:59:59Z'"

4. Can I export calendar events to a CSV file?

Yes, use this script to export event details like subject, attendees, and start time:

$Events = Get-MgUserEvent -UserId "<UserPrincipalName>" -All
$Events | Select-Object Subject, Start, End, Attendees | Export-Csv -Path "C:\Path\To\CalendarEvents.csv" -NoTypeInformation
                    

5. What permissions are required to retrieve calendar events using Get-MgUserEvent?

You need the Calendars.Read or Calendars.ReadWrite permission in Microsoft Graph PowerShell. Ensure appropriate permissions are granted in Azure AD.

6. Can I filter calendar events by organizer using Get-MgUserEvent?

Yes. Retrieve the events and filter the Organizer.EmailAddress.Address property.

Get-MgUserEvent -UserId "user@domain.com" -All |
Where-Object { $_.Organizer.EmailAddress.Address -eq "manager@domain.com" }
                        

7. What is the difference between Get-MgUserEvent and Get-MgUserCalendarEvent?

Get-MgUserEvent retrieves events from the user’s default calendar event collection. Get-MgUserCalendarEvent is useful when you want to retrieve events from a specific calendar by providing the CalendarId.

Use Get-MgUserEvent for default calendar event queries and Get-MgUserCalendarEvent when working with multiple calendars.

Conclusion

The Get-MgUserEvent cmdlet is an essential tool for managing and automating calendar events in Microsoft 365. By understanding its syntax, usage, and potential errors, administrators can effectively leverage this cmdlet to enhance their productivity and streamline event management processes.

Related Articles: