Export-GOCalendarEvents

SYNOPSIS

Exports calendar events from a Google Workspace mailbox and calendar.

SYNTAX

Help

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

Action

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

DESCRIPTION

Use the Export-GOCalendarEvents cmdlet to export events from a Google Workspace mailbox and calendar.

See the Notes section for cmdlet requirements.

EXAMPLES

Example 1: Export raw data

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

This example exports all calendar events from the user@example.org calendar in the user@example.org mailbox. 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. Note that the user’s primary calendar can be selected by name or the special keyword primary.

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 that contains the calendar.

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 config.psd1 keys

These configuration keys are scoped to the Source or Target node in config.psd1.

GOAdmin: The ID of your tenant’s administrator.
GOServiceAccountKey: The path to your service account’s JSON key file.
GOTenant: The ID of your tenant. For example, source.org.

Optional config.psd1 keys

These configuration keys are scoped to the General node in config.psd1.

ExpandEvents: Determines whether repeating events are represented by a single API object or expanded into multiple API objects.

Default: $false