Skip to main content
Import-TenantUserMappings

Create new user mappings from a tenant-wide user mappings Excel file with PowerShell

Updated over 2 months ago

Command

Import-TenantUserMappings

Description

The command to create a -MappingSettings object from a file exported with Export-TenantUserMappings.

The -MappingSettings object can be used with most copy commands.

Examples

Import mappings from XLSX file

# Import user mapping settings from an Excel file
$mappingSettings = Import-TenantUserMappings -Path "C:\MyMappings\MyUserMappingsFileName.xlsx"

# Display the imported mapping settings
$mappingSettings

Syntax

Import-TenantUserMappings -Path <String> [-MappingSettings <MappingSettings>] 

Parameters

-MappingSettings <MappingSettings>

Specifies the mapping settings.

Required?

False

Default value

None

Accept pipeline input?

True (ByValue; ByPropertyName)

Accept wildcard characters?

False

Parameter set name

(All)

Aliases

None

-Path <String>

Specifies the path previously exported from ShareGate (see Export Tenant User Mappings).

Required?

True

Default value

None

Accept pipeline input?

False

Accept wildcard characters?

False

Parameter set name

(All)

Aliases

PSPath

Did this answer your question?