Using Get-MgUserCalendar with New-MgUserCalendarEvent

Efficient calendar management is crucial for keeping teams organized in Microsoft 365. By pairing Get-MgUserCalendar with New-MgUserCalendarEvent, administrators can retrieve a user’s calendar and add events programmatically. This article demonstrates how to use these cmdlets together, providing a practical, simplified example, tips, and solutions to common errors.

The Get-MgUserCalendar cmdlet retrieves details of a user’s calendars, including the default calendar. The New-MgUserCalendarEvent cmdlet creates events in a specified calendar. By combining these cmdlets, you can automate event scheduling workflows, such as adding meetings to a specific calendar.

In this guide, we’ll explore how to use these cmdlets together to retrieve a user’s calendar and add a single event, along with tips, use cases, and troubleshooting advice.

Usage Example: Adding an Event to a User's Calendar


# Step 1: Retrieve the user's default calendar
$userId = "john.doe@domain.com"  # Replace with the user's UPN or ObjectId
$calendar = Get-MgUserCalendar -UserId $userId | Where-Object { $_.name -eq "Calendar" }

if ($calendar -ne $null) {
    Write-Output "Calendar Found: $($calendar.Name)"
    Write-Output "Calendar ID: $($calendar.Id)"
} else {
    Write-Error "Default calendar not found for the user."
    return
}

# Step 2: Create a new event in the retrieved calendar
$eventDetails = @{
    subject = "Team Standup Meeting"
    start = @{
        dateTime = "2024-12-20T09:00:00"
        timeZone = "Pacific Standard Time"
    }
    end = @{
        dateTime = "2024-12-20T09:30:00"
        timeZone = "Pacific Standard Time"
    }
    attendees = @(
        @{
            emailAddress = @{
                address = "jane.doe@domain.com"
            }
            type = "required"
        }
    )
}

New-MgUserCalendarEvent -UserId $userId -CalendarId $calendar.Id -BodyParameter $eventDetails
Write-Output "Event created successfully in the user's default calendar."

Cmdlet Tips

Target the Default Calendar: o Microsoft 365 users often have multiple calendars. Use the calendar name (typically "Calendar" for the default) to ensure the correct one is selected:
```
Get-MgUserCalendar -UserId $userId | Where-Object { $_.name -eq "Calendar" }
```
Verify Time Zones: Use the correct time zone to avoid scheduling errors. Example: "Pacific Standard Time". Refer to the Microsoft Time Zone Index Values for options.
Test Before Deployment: Test the script with a sample account to ensure events are created as expected without impacting end users.
Dynamic Scheduling: Automate the event creation process by populating the start and end times dynamically based on system triggers or user inputs.

Use Cases

Automated Meeting Scheduling: Create team meetings in user calendars programmatically as part of an onboarding or project setup workflow.
Organization-Wide Reminders: Add reminders for compliance deadlines or company events to selected user calendars.
Shared Calendar Management: Retrieve and schedule events in shared calendars for better coordination across teams.

Possible Errors & Solutions

Error Message	Cause	Solution
Calendar Not Found	No calendar matches the name "Calendar"	Verify the calendar name and ensure the user has a default calendar.
Access Denied	Insufficient permissions	Assign Calendars.ReadWrite or Calendars.ReadWrite.Shared permissions.
Invalid DateTime Format	Incorrect date and time format in start or end	Ensure dateTime values follow the ISO 8601 format (e.g., YYYY-MM-DDTHH:mm:ss).
User Not Found	Invalid or non-existent UserId	Verify the user exists and their UPN or ObjectId is correct.

Conclusion

Pairing Get-MgUserCalendar and New-MgUserCalendarEvent simplifies the process of managing user calendars in Microsoft 365. By retrieving a user’s default calendar and adding events programmatically, you can automate scheduling tasks and ensure efficient time management.

With a few simple steps, you can create powerful scripts that streamline workflows and improve collaboration across your organization. Start using these cmdlets today to enhance calendar management in Microsoft 365!