Troubleshoot Import or Create Script failures

Title

URL Name

Troubleshoot-Import-or-Create-Script-failures

Question

When using the API and the PowerShell script examples to Import or Create a Workspace, I get one of the following errors, how can I resolve these errors?

Nothing happening,
Insufficient Permissions,
app registration is not assigned,
CSV rows are skipped,
could not find available service definition,
service instance already exists
Exception calling Token

Always ensure you are using the latest Modules files from the Resource section and that PowerShell 7 is being used.

Answer

Exception calling "AcquireToken"

Expand here to see cause & resolution

Causes	Resolution
This often occurs when an incorrect tenant or client id has been added	Check your script has the correct client ID and tenant ID, this will be found on your app registration overview page

Nothing appears to happen

Expand here to see cause & resolution

Causes	Resolution
When using the Import example with a CSV file it must have more than 1 workspace to import.	If you are only importing 1 workspace, duplicate the line a second time, it will complete the first and fail the second.

Insufficient permissions

Expand here to see cause & resolution

Causes	Resolution
The App registration created to connect to the API does not have permission to access ProvisionPoint	Add the app registration as a member to the App Manager group in AAD. The group name can be found in ProvisionPoint Workspaces Admin > Settings > App Settings.

"App Registration name" is not assigned to a role for the application ProvisionPoint

Expand here to see cause & resolution

Cause	Resolution
The ProvisionPoint Enterprise Application (Entra) has the 'Assignment Required' set to Yes. This will require any users or Groups that should be able to access the app to be added as a user or Group to the Application by a Global Admin in your tenant or the application Owner. As the API permissions are delegated the API can only be called by a user not an application.	Ensure any users that will make API calls are added as a user or as a member to the enterprise application. Go to Azure Active Directory > Enterprise Applications > ProvisionPoint > Users and Groups Add user/group if not added In your Import Script do not provide a secret o certificate, this will force the Set-Auth function to provide a login prompt

All rows are skipped

Expand here to see cause & resolution

Causes	Resolution
The CSV is missing the serviceInstanceId and ErrorMessage columns There is an error in the ErrorMessage cells	Add the serviceInstanceId and ErrorMessage columns after your other columns in the CSV. Delete any error messages from the ErrorMessage Cells. Save and close the CSV

Could not find an available Service Definition

Expand here to see cause & resolution

Causes	Resolution
The Column header for $ServiceDefinitionFieldName does not match your CSV The actual name of the Service Definition you are importing to is incorrect	Ensure the columns name and the $ServiceDefinitionFieldName in your script match. In the example below, the CSV column named 'SD' should be 'Service Definition' or update the script with SD for ServiceDefinitionFieldName Ensure the name of the Service Definition in the app, matches the name in the CSV file. In the example below, the name is Import Test

Insufficient permissions to create a service instance for a service definition

Expand here to see cause & resolution

Causes	Resolution
The API App registration does not have permission to make requests to this Service Definition.	Check which group has permission to request the Service definition, go to Admin > Service Definitions > Requests tab > scroll down to 'Requestor Settings' and make note of the group. Go to AAD and check which group the AAD API App registration is a member of. Add the Group to the Requestors

Service Instance already exists

Expand here to see cause & resolution

Causes	Resolution
This workspace was already part of the directory: It has previously been imported It was created in ProvisionPoint Workspaces	Check the Job Queue for any errors on import Check the Directory list for this workspace The visibility may be set so you cannot see it in ProvisionPoint Workspaces, ask the owner or the Admin team to check and amend visibility if required.

Import Script successful, but error on Job queue:

If your Import script has run successfully, the item is added to the ProvisionPoint Job queue.

In this case the Imported Site can fail to be created in our app.

Check the Job queue for any errors, below are some common causes for failure.

Unable to Create Planner Plans

If the Service Definition is importing and you have setup a Planner Plan to be created, this can be created as part of the import.

Error:

Info -> CreatePlannerPlans -> Start creating 1 Planner Plans.

Exception (failure) -> Error running process. Message: You do not have the required permissions to access this item.

Causes	Resolution
The account requesting does not have permissions to create the Planner	Check there is a Service Account in Admin > Settings > Service Accounts Check the token is up to date for the service account Check the Service account is an Owner of the Team/Site/Group Go to Entra > Users > Open the Service account record Check the Groups Tab, and ensure the Group is listed