Logo

Documentation home for Transend tools

Update-GOResources

SYNOPSIS

Updates resources in a Google Workspace tenant.

SYNTAX

Help

Update-GOResources
  [-ShowPrereqs]
  [<CommonParameters>]

Action

Update-GOResources
  -ConfigNode <String>
  -Csv <String>
  [-TranslationCsv <String>]
  [-IgnoreErrors]
  [-SkipValidation]
  [-ValidateOnly]
  [<CommonParameters>]

DESCRIPTION

Use the Update-GOResources cmdlet to update resources in a Google Workspace tenant.

See the Notes section for cmdlet requirements.

EXAMPLES

Example 1: Validation only

Update-GOResources -ConfigNode Target -Csv 'resources.csv' -ValidateOnly

This example validates all data for the resources in the resources.csv file but does not perform the operation. This is a recommended first step so any warnings can be addressed first.

Example 2: Basic update

Update-GOResources -ConfigNode Target -Csv 'resources.csv'

This example updates all resources from the resources.csv file.

Example 3: Advanced update with translation

Update-GOResources -ConfigNode Target -Csv 'resources.csv' -TranslationCsv 'translations.csv'

This example updates all resources from the resources.csv file. Data is translated according to the mappings provided in the translations.csv file.

PARAMETERS

-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

-Csv

The path to a CSV file containing objects to update. See the Notes section for the required format.

Type: String
Parameter Sets: Action
Aliases:

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

-IgnoreErrors

Validation errors stop execution prior to the update by default. Use -IgnoreErrors to proceed with error records omitted.

Note that global errors are not impacted by this option.

Type: SwitchParameter
Parameter Sets: Action
Aliases:

Required: False
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

-SkipValidation

Skips the property validation stage of the update. Data supplied via the -Csv parameter will be used as-is, which may lead to runtime errors.

Type: SwitchParameter
Parameter Sets: Action
Aliases:

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

-TranslationCsv

The path to the CSV file containing translation mappings. The file must use SourceName;TargetName as the field identifiers.

Type: String
Parameter Sets: Action
Aliases:

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

-ValidateOnly

Validation and update are both performed by default. Use -ValidateOnly to perform the validation but skip the update.

It is recommended to run a -ValidateOnly pass first to identify potential issues prior to updating data. Note that records with validation errors will fail to update unless -IgnoreErrors is used, but records with validation warnings proceed without the data triggering the warning. A -ValidateOnly pass allows you to inspect these warnings before data is written and make any necessary changes.

Type: SwitchParameter
Parameter Sets: Action
Aliases:

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.Void

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 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 SDK
  • Cloud Resource Manager
  • Contacts
  • Gmail
  • Google Calendar
  • Google Drive
  • People

Required scopes

  • https://www.googleapis.com/auth/admin.directory.domain.readonly
  • https://www.googleapis.com/auth/admin.directory.group.readonly
  • https://www.googleapis.com/auth/admin.directory.orgunit.readonly
  • https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly
  • https://www.googleapis.com/auth/admin.directory.user.readonly
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.googleapis.com/auth/cloudplatformprojects.readonly
  • https://www.googleapis.com/auth/contacts.readonly
  • https://www.googleapis.com/auth/directory.readonly
  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/admin.directory.group
  • https://www.googleapis.com/auth/admin.directory.resource.calendar
  • https://www.googleapis.com/auth/admin.directory.user
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/contacts
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/gmail.settings.sharing
  • https://www.googleapis.com/auth/userinfo.email

Required CSV format

Property Required Multi-value Notes
InScope True False Allowed values: Yes, True, No and False.
Identity True False Allowed values: ID, email address or display name.
CalendarActAsDelegatesToAdd False True  
CalendarEditorDelegatesToAdd False True  
CalendarReviewerDelegatesToAdd False True  
CalendarAvailabilityDelegatesToAdd False True  
  • CSV fields should be separated by semicolons. For example, InScope;Identity....

  • Multi-value fields should be separated by commas. For example, value1,value2....

General configuration options