We automated the provisioning steps in a Powershell script for you. It will connect to our environment and get the needed changes applied to your infrastructure.

Please read before you start

The PowerShell script needs to be run by a tenant admin TENANT ADMIN . Please note:

  • The script will automatically apply  Required Permissions used by Nimbus. 
  • The following modules are used / installed on your machine when running the script. The newest versions are retrieved upon script execution.


    		Module
    1MicrosoftTeams
    2MSAL.PS
    3Microsoft.Graph.Authentication
    4Microsoft.Graph.Applications
    5Microsoft.Graph.Identity.DirectoryManagement
    6Microsoft.Graph.Users
    7Microsoft.Graph.Users.Actions

  • We recommend executing the script with PowerShell 5.1 (you can check via "Get-Host" command). Version 7 is causing frequent problems. (info) Also refer to the "Troubleshooting" section on the bottom of this page.
  • The script uses a checksum verification based on the MD5 algorithm - if you have policies like FIPS Compliancy enabled on your computers you may not be allowed to use the MD5 algorithm at all.

(lightbulb) Tip: The script run is also needed when certain Service Settings change (e.g. PSTN numbers & Team Name). Keep the script session window open if you want to test settings. By doing so you don't need to go through all steps again when you need to provision multiple teams.

Microsoft Graph PowerShell Permissions

The Microsoft.Graph.* modules which are used by the Provisioning Script require permissions that need to be granted for the Microsoft Graph PowerShell Enterprise application: 

PermissionPermission TypeGranted ByPurpose
Application.ReadWrite.AllDelegatedTenant AdminRead and write all applications
AppRoleAssignment.ReadWrite.AllDelegatedTenant AdminManage app permission grants and app role assignments
DelegatePermissionGrant.ReadWrite.AllDelegatedTenant AdminManage all delegated permission grants
Domain.Read.AllDelegatedTenant AdminRead domains
Organization.Read.AllDelegatedTenant AdminRead organization information
Users.ReadWrite.AllDelegatedTenant AdminRead and write all users' full profiles
openidDelegatedTenant AdminSign users in
profileDelegatedTenant AdminView users's basic profile
offline_accessDelegatedTenant AdminMaintain access to data you have given it access to

Below is an overview of our provisioning script

Provisionining - Step by Step

Script download

Get the provisioning script via direct link below. Pick the link depending on the chosen location:

Provisioning Script URLs:

Script Regions

(question) Which region do I pick? Pick the correct script according to the (future or already existing) region of your tenant data. Refer to Nimbus Installation > "Service Provisioning ". 

(question) What will this script do? Automate and guide you through the Azure-related setup on your Tenant. Refer to the detail steps below.

(lightbulb) You may have a look inside the script and compare the different scripts we provide, but manual edits are not required.
(lightbulb) When executed the script will check for updates and may request you to download the newest version.
(lightbulb) Once a Nimbus team has already been provisioned y ou can also find a script "download" button located within the User Settings.

Script Details

(tick) TENANT ADMIN To execute the script Tenant Administrator credentials must be provided (→ 'Global administrator' role). 

(info) Refer to the diagram above for an overview. During execution and depending on pending Service Settings changes the script will perform the steps below:

  • Connect to Azure AD and your tenant.
  • Grant the needed consent for the main Nimbus application, this will allow Nimbus to read user and team details in the tenant and record voice messages if the latter is configured for the team. → See: Required Permissions
  • Create, update or delete an Application Instance and grant the required consent to it to be able to set up conversations.
  • Associate or remove PSTN license (License name: 'Microsoft 365 Phone System - Virtual User'). (info) Refer to Installation Prerequisites > PSTN licensing for details.
  • Apply a voice routing policy from the ones defined and selectable on your tenant. 
  • Add, update or delete PSTN phone number. (warning) Note that a PSTN number causes additional license cost by Microsoft. Get in touch with your local O365 integrator.

  • Lastly the script will apply Service Settings - either new or future changes made by you or any service team owners (e.g. a name or UPN change).

    Pending changes on a Service will inform about a necessary Script-rerun

    Done?

    → After execution, the Script reports back to Nimbus. If everything was successful all changes are reflected in the Service Settings.

    (lightbulb) Please allow for a few minutes before making calls to a newly (re)configured Application Instance or PSTN number as it might take a moment for Microsoft Azure services to synchronize all the changes.
     (lightbulb) Note that a rerun of this script is necessary for every additional Service and/or within your tenant. You may want to read →  How to deploy Microsoft Runbook to automate this process.

Script Execution

  1. Execute the Script and provide your tenant admin credentials


  2. The script runs and grants  Required Permissions to the App. 

    (info) If this has already been done by a tenant admin in the Nimbus Installation chapter, this is not required again. 

  3. The Script checks which service teams have been created or changed in the respective Service Settings backend (can be done by each TEAM OWNER ) and pulls them out one by one.
    All services with changes to apply will be shown as either Delete, Create or Update.
    You can then choose one of the two options.
     I -  per Team individually  - you can inspect and confirm each change.
     A - for all Teams - all changes are auto-confirmed. (warning) Please note that PSTN licenses will be applied automatically as long as they are available - first come, first serve base. 
  4. Carry on with the next step for further technical details.

PSTN Licenses and Voice Policies

(tick) The following steps apply only if your Service Settings have changed  (e.g. PSTN enabled

PSTN License

The script also allows you to choose the PSTN license type (Phone System or Virtual Phone System) to assign to a service (Application Instance). 

You have the following options:

  • Automatically Virtual Phone System
  • Automatically Phone System
  • Manual Assignment
    → Allows you to manually assign the license, then performs a check when you confirm.
  • Skip (no PSTN will be assigned)

(lightbulb) Via the same script functionality you can also remove PSTN licenses from Nimbus services.

Voice Policy

The script will ask before any voice routing policy should be applied to a service (Application Instance):

You have the following options:

  • When No is selected, no changes will be applied.
  • When Yes is selected, voice routing policies from your tenant are polled.
    → You will be requested to confirm voice routing policy name to assign it.

(lightbulb) Via the same script functionality you can remove voice policies from Nimbus services.

Script Conclusion and Rerun

  1. When everything runs as expected you will see green DONE indicator and the script finishes.

  2. At the end you will be asked if you want to re-run the script. Keep the Script instance open until all Service changes are complete so you don't need to authenticate again.

     (lightbulb) For each further pending change in the Service Settings > "Service Details " the Powershell instance can be run again until you are satisfied with the results.

Verifying changes via Test Call

(tick) Allow for at least 5 minutes after applying Team changes to the before making the call. 

  1. To test the functionality, team members should be available for the called team and be set "Active" in their Dashboard
  2. Open the Service Settings of the team you want to test with and click on " Test Call ".

     (lightbulb) You can test this with 2 different Microsoft Teams client accounts separate browser windows to simulate this call on your own.
    (lightbulb) In case of a PSTN Number it's also recommended trying to directly call the service with a cell phone.

PSTN Limitations


Transfer to PSTN limitation

Out-of-the-box, Nimbus and affiliated addons can only perform PSTN transfers according to Microsoft's licensing and constraints.

Which PSTN license do I need to acquire?

(tick) As a tenant administrator you need to acquire the following licenses and assign them to the application instance of the respective Nimbus SOURCE service (team) that will act as PSTN transferor:

Your SetupRequired License
Direct Routing"Microsoft Teams" (App license, available as part of the Microsoft 365 E1 / E3 / E5 and other packages)
+ "Microsoft Teams Phone Resource Account"
Calling Plan"Microsoft Teams Phone Resource Account"
+ "Microsoft Teams Domestic Calling Plan" or "Microsoft Teams Domestic and International Calling Plan"
+ "Communication Credits" (if these aren't already included as part of your plan)
Operator Connect
"Microsoft Teams Phone Resource Account"


(warning) As of 2023 "Microsoft Teams Phone Standard" licences are no longer supported by Microsoft. Previously those licenses were viable for Nimbus. → Regardless if you are using Direct Routing, Calling Plans, Operator Connect - the "Microsoft Teams Phone Resource Account" license is now always required. 

(warning) Please note that Luware staff cannot make recommendations on which license plan is best suited for your needs. Depending on your scenario, additional Teams App licenses may be required. Exact details are to be discussed with your Microsoft contacts.

(info) Also see: https://learn.microsoft.com/en-us/microsoftteams/teams-add-on-licensing/virtual-user


How does PSTN licensing affect Service and Call Transfers?

Assuming that Service A has a PSTN license assigned - but further Services don't - the following scenario may unfold:

  • Scenario A - Service A workflow is configured to transfer the caller to Service B. The license of Service A is used, the PSTN transfer occurs. The PSTN license is re-used throughout further transfers to Services C..D...x.
  • Scenario B - Service B is called directly instead. Now the workflow of Service B attempts a redirect to either service A or transfer to C. The PSTN transfer fails due to a missing license on Service B.

Learnings

  • For one first-level-response Service: If you handle first-response calls always via the same Service you need a PSTN license for that particular first-level Service.
  • For multiple first-level-response Services: If you handle first-response calls always via multiple Services you need a PSTN license for all those first-level Services .
  • Nimbus will attempt to use the PSTN license of the first service that responded to a call, regardless of how many further internal service transfers are performed thereafter.
  • If no PSTN license is found on a service that requires it for a transfer, the transfer task will be considered as failed and be treated as such by the system (e.g. workflow exit announcement, reporting "transfer failed" outcome).

(warning) Note that handling and tracking of running cost for PSTN licenses is outside of Luware support scope.
If you require assistance in extending and/or configuring your Nimbus services for PSTN our support will gladly assist you:

Luware Support
Websitehttps://luware.com/support/
Helpdeskhttps://helpdesk.luware.cloud 
Service Statushttps://status.luware.cloud/

(info) Refer to the external reference: Microsoft Teams PSTN connectivity options and Microsoft Teams add-on licenses.

Troubleshooting & Known Issues

First-time script execution

When the script is run for the first time on a given PC it will try to install all the required modules and libraries. The script might need to be run as Administrator for it:
→ Right click on the "Windows PowerShell" item in Windows search and select "Run as administrator". 

IssueAnalysis / Workaround

When assigning PSTN Number: App instance is created, licence (V) is assigned, but phone number assignment fails - MSFT returns the error that the user is not found.

Replication issue on the Microsoft backend, takes some time before Teams realizes that the newly created Resource Account / Application Instance can now be assigned a phone number after the license was applied.

→ We recommend to retry running the script after 5-10 min. Repeat the procedure if necessary until successful. Currently there is no Luware workaround possible. We will update or remove this limitation once resolved.

During Service Name Change: The name is actually changed on MSFT side, but it returns us the error below, the script treats it as failure and doesn't update Nimbus DB back

→ Change the Display Name of the User Object via Microsoft 365 or Azure AD. This information will be synchronized with Microsoft Teams. This process can take a few days until the changes are visible in the Microsoft Teams Client. 

Error during Script execution - "File cannot be loaded"

If the script launch fails with error "File cannot be loaded because the execution of scripts is disabled on this system. " it means that execution policy on a given PC does not allow scripts execution.
→ Changing execution policy to "RemoteSigned" will help to solve this, please check the Microsoft Documentation  for more details.