New-PnPUPABulkImportJob

Submit up a new user profile bulk import job.

Syntax

New-PnPUPABulkImportJob
   -Folder <String>
                          -Path <String>
                          -UserProfilePropertyMapping <Hashtable>
                          -IdProperty <String>
                          [-IdType <ImportProfilePropertiesUserIdType>]
                          [-Connection <SPOnlineConnection>]

Description

See https://docs.microsoft.com/en-us/sharepoint/dev/solution-guidance/bulk-user-profile-update-api-for-sharepoint-online for information on the API and how the bulk import process works.

Examples

------------------EXAMPLE 1------------------

@" 
 {
  "value": [
    {
      "IdName": "mikaels@contoso.com",
      "Department": "PnP",
    },
	{
      "IdName": "vesaj@contoso.com",
      "Department": "PnP",
    }    
  ]
}
"@ > profiles.json

New-PnPUPABulkImportJob -Folder "Shared Documents" -Path profiles.json -IdProperty "IdName" -UserProfilePropertyMapping @{"Department"="Department"}

This will submit a new user profile bulk import job to SharePoint Online.

Parameters

-Connection

Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Type:SPOnlineConnection
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Folder

Site or server relative URL of the folder to where you want to store the import job file.

Type:String
Position:0
Accept pipeline input:False
Accept wildcard characters:False
-IdProperty

The name of the identifying property in your file.

Type:String
Position:3
Accept pipeline input:False
Accept wildcard characters:False
-IdType

The type of profile identifier (Email/CloudId/PrincipalName). Defaults to Email.

Type:ImportProfilePropertiesUserIdType
Position:4
Accept pipeline input:False
Accept wildcard characters:False
-Path

The local file path.

Type:String
Position:1
Accept pipeline input:False
Accept wildcard characters:False
-UserProfilePropertyMapping

Specify user profile property mapping between the import file and UPA property names.

Type:Hashtable
Position:2
Accept pipeline input:False
Accept wildcard characters:False