Update-M365Users

SYNOPSIS

Updates users in a Microsoft 365 tenant.

SYNTAX

Help

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

Action

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

DESCRIPTION

Use the Update-M365Users cmdlet to update users in a Microsoft 365 tenant.

See the Notes section for cmdlet requirements.

EXAMPLES

Example 1: Validation only

Update-M365Users -ConfigNode Target -Csv 'users.csv' -ValidateOnly

This example validates all data for the users in the users.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-M365Users -ConfigNode Target -Csv 'users.csv'

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

Example 3: Advanced update with translation

Update-M365Users -ConfigNode Target -Csv 'users.csv' -TranslationCsv 'translations.csv'

This example updates all users from the users.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.

M365ClientId: The client ID of your tenant’s app.
M365ClientSecret: The client secret of your tenant’s app.
M365SharePointDomain: The name of your SharePoint domain. For example, source.
M365Tenant: The ID of your tenant. For example, source.org.

Optional config.psd1 keys