Get-PnPUPABulkImportStatus
SYNOPSIS
Required Permissions
- SharePoint: Access to the SharePoint Tenant Administration site
Get user profile bulk import status.
SYNTAX
Get-PnPUPABulkImportStatus [-JobId <Guid>] [-IncludeErrorDetails] [-Connection <PnPConnection>]
DESCRIPTION
Retrieve information about the status of submitted user profile bulk upload jobs.
Possible statuses are defined in the ImportProfilePropertiesJobState enumeration:
- Unknown
- Submitted
- Processing
- Queued
- Succeeded
- Error
EXAMPLES
EXAMPLE 1
Get-PnPUPABulkImportStatus
This will list the status of all submitted user profile bulk import jobs.
EXAMPLE 2
Get-PnPUPABulkImportStatus -IncludeErrorDetails
This will list the status of all submitted user profile bulk import jobs, and if it contains an error it will include the error log messages if present.
EXAMPLE 3
Get-PnPUPABulkImportStatus -JobId <guid>
This will list the status for the specified import job.
EXAMPLE 4
Get-PnPUPABulkImportStatus -JobId <guid> -IncludeErrorDetails
This will list the status for the specified import job, and if it contains an error it will include the error log messages if present.
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: PnPConnection
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IncludeErrorDetails
Include error log details
Type: SwitchParameter
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-JobId
The instance id of the job
Type: Guid
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False