Exports calendars from a Google Workspace tenant.
Export-GOCalendars
[-ShowPrereqs]
[<CommonParameters>]
Export-GOCalendars
-ConfigNode <String>
[-Target <String>]
[-Format <String>]
[<CommonParameters>]
Use the Export-GOCalendars cmdlet to export calendars
from a Google Workspace tenant.
Note that a calendar is only exported if at least one user has access.
See the Notes section for cmdlet requirements.
Export-GOCalendars -ConfigNode Source -Format Csv >'calendars.csv'
This example exports all calendars from a Google Workspace tenant.
The exported data is formatted as CSV
and saved to the file calendars.csv.
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
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
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
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
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
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 Source or Target node in config.psd1.
GOSharedContactsApi: The API to use to retrieve shared contacts. Valid values are People and Contacts.
Default: People
Required APIs
Admin SDKCloud Resource ManagerContactsGmailGoogle CalendarGoogle DrivePeopleRequired scopes
https://www.googleapis.com/auth/admin.directory.domain.readonlyhttps://www.googleapis.com/auth/admin.directory.group.readonlyhttps://www.googleapis.com/auth/admin.directory.orgunit.readonlyhttps://www.googleapis.com/auth/admin.directory.resource.calendar.readonlyhttps://www.googleapis.com/auth/admin.directory.user.readonlyhttps://www.googleapis.com/auth/calendar.readonlyhttps://www.googleapis.com/auth/cloudplatformprojects.readonlyhttps://www.googleapis.com/auth/contacts.readonlyhttps://www.googleapis.com/auth/directory.readonlyhttps://www.googleapis.com/auth/drive.readonlyhttps://www.googleapis.com/auth/gmail.readonlyhttps://www.googleapis.com/auth/admin.directory.grouphttps://www.googleapis.com/auth/admin.directory.resource.calendarhttps://www.googleapis.com/auth/admin.directory.userhttps://www.googleapis.com/auth/calendarhttps://www.googleapis.com/auth/contactshttps://www.googleapis.com/auth/drivehttps://www.googleapis.com/auth/gmail.settings.sharinghttps://www.googleapis.com/auth/userinfo.email