Logo

Documentation home for Transend tools

  • Enable-M365ApplicationImpersonation
  • Export-M365CalendarEvents

    • Home

    Export-M365CalendarEvents

    SYNOPSIS

    Exports calendar events from a Microsoft 365 mailbox and calendar.

    SYNTAX

    Help (Default)

    Export-M365CalendarEvents [-ShowPrereqs] [<CommonParameters>]

    Action

    Export-M365CalendarEvents -ConfigNode <String> -MailboxIdentity <String> -CalendarIdentity <String>
 [-Target <String>] [-Format <String>] [<CommonParameters>]

    DESCRIPTION

    Use the Export-M365CalendarEvents cmdlet to export events from a Microsoft 365 mailbox and calendar.

    See the Notes section for cmdlet requirements.

    EXAMPLES

    Example 1

    Export-M365CalendarEvents -ConfigNode Source -MailboxIdentity 'user@example.org' -CalendarIdentity 'Calendar' -Format Csv >'calendar_events.csv'

    This example exports all calendar events from a Microsoft 365 mailbox and calendar. The exported data is formatted as CSV and saved to the file calendar_events.csv.

    PARAMETERS

    -CalendarIdentity

    The name of the calendar from which events will be exported.

    Type: String
Parameter Sets: Action
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    -ConfigNode

    The config.psd1 configuration node to use.

    Type: String
Parameter Sets: Action
Aliases:
Accepted values: Source, Target

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    -Format

    The output type for exported data.

    Note that extended properties cannot be serialized into CSV format. When using -Format Csv, extended properties will display as System.Collections.Hashtable in the output.

    Type: String
Parameter Sets: Action
Aliases:
Accepted values: Csv, Json, Objects

Required: False
Position: Named
Default value: Objects
Accept pipeline input: False
Accept wildcard characters: False

    -MailboxIdentity

    The name of the mailbox from which events will be exported.

    Type: String
Parameter Sets: Action
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    -ShowPrereqs

    Prints the cmdlet prerequisites.

    Type: SwitchParameter
Parameter Sets: Help
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    -Target

    Specifies a mapping target for the exported data. Exported data mapped for a supported target is directly consumable by a corresponding import cmdlet.

    To export unmapped data, use -Target None.

    Type: String
Parameter Sets: Action
Aliases:
Accepted values: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    CommonParameters

    This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

    INPUTS

    None

    OUTPUTS

    System.Object[]

    NOTES

    Required PowerShell modules

    • ExchangeOnlineManagement

    Required config.psd1 configurations

    • M365ClientId
    • M365ClientSecret
    • M365SharePointDomain
    • M365Tenant

    Optional config.psd1 configurations

    • M365CloudEnvironment

    Required APIs

    • Microsoft Graph

    Required scopes

    • Directory.Read.All (Application)
    • Calendars.Read (Application)

    TMCTools configuration options