Provisioning via Microsoft PowerShell

💡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. Please note:

  • The script will automatically apply Required App Permissions used by Nimbus.
  • The following modules are used / installed on your machine when running the script:
Module
1 MicrosoftTeams
2 MSAL.PS
3 Microsoft.Graph.Authentication
4 Microsoft.Graph.Applications
5 Microsoft.Graph.Identity.DirectoryManagement
6 Microsoft.Graph.Users
7 Microsoft.Graph.Users.Actions
  • The script is built and tested for PowerShell 5.1 (you can check the version via the "Get-Host" command). Other versions of PowerShell are not supported and may cause problems.
    🔍 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 which do not allow the usage of MD5, then you may encounter an error during the version check.

💡 Tip: The script run is also needed when certain Service Settings change (Service Display Name, Service UPN, and PSTN number). 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: 

Permission

Permission

Type

Granted By Purpose
Application.ReadWrite.All Delegated Tenant Admin Read and write all applications
AppRoleAssignment.ReadWrite.All Delegated Tenant Admin Manage app permission grants and app role assignments
DelegatePermissionGrant.ReadWrite.All Delegated Tenant Admin Manage all delegated permission grants
Domain.Read.All Delegated Tenant Admin Read domains
Organization.Read.All Delegated Tenant Admin Read organization information
Users.ReadWrite.All Delegated Tenant Admin Read and write all users' full profiles
openid Delegated Tenant Admin Sign users in
profile Delegated Tenant Admin View users's basic profile
offline_access Delegated Tenant Admin Maintain access to data you have given it access 

Below is 

An overview of our provisioning script

Provisioning - Step by Step

Script download

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

INC Nimbus Provisioning Script URLs

SCRIPT REGIONS

🤔 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 ". 

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

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

 

Script Details

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

🔍 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 Microsoft Graph, Microsoft Teams and your Nimbus 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 App 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 Phone System license 🔍 Refer to Installation Prerequisites > PSTN licensing for details.
  • Apply an Online Voice Routing Policy from the ones defined and selectable on your tenant. This is only required for Nimbus services which are using a Direct Routing phone number.
  • Add, update or delete PSTN phone number. ☝ 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, UPN, or phone number 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.

💡 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.  
💡 Note that a rerun of this script is necessary for every additional Service and/or within your tenant.

 

Script Execution

  1. Execute the script and wait for the connection to Microsoft Graph, Teams, and Nimbus. 💡 If the script is not up-to-date you will be requested to download the latest version.
  2. When requested to login, provide your tenant admin credentials
Login Request
  1. You may be asked for your admin consent on the first run of the script. 💡When using a Global Admin account you can grant these Permissions for your entire organization, so other administrators do not need to repeat this step.
Permission request dialog
  1. The script will now proceed to grant Required App Permissions to the Nimbus App on your tenant:
  • If this has already been done by a tenant admin in the Nimbus Installation chapter, this is not required again.
  • Potentially missing calling bot permissions (required e.g., for establishing sessions and posting Adaptive Cards to your Teams) will also be regranted automatically.
Permission grant process
  1. ⮑ The Script now checks whether any Nimbus services have been added, changed in the respective Service Settings , or deleted since the last time the script was run. 
    6. All services with pending changes 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. ☝ Please note that PSTN licenses will be applied automatically as long as they are available - first come, first serve base.
  2. Carry on with the next step for further technical details.

PSTN Licenses and Voice Policies

The following steps apply only if your Nimbus service has a PSTN number assigned to it via its Service Settings.

 

PSTN License

Voice Policy

The script allows you to choose how you would like to apply the required Phone System license to a service (Application Instance).

 

 

The script will ask before any Online Voice Routing Policy should be applied to a service (Application Instance).     
🔍 This is only required if your service is using a Direct Routing phone number. If you are using a phone number provided through Calling Plans or Operator Connect, you can skip the voice policy assignment.

 

 

You have the following options:

  • Automatic Assignment - Let the script assign a 'Microsoft Teams Phone Resource Account' license automatically.
    ☝ Ensure that your account has the required permissions to perform this action.
  • Manual Assignment
    ⮑ The script will wait for you to manually assign the license (e.g., via the M365 portal), then performs a check after you have pressed Enter.
  • Skip (no license and phone number will be assigned)

You have the following options:

  • When No is selected, no changes will be applied.
  • When Yes is selected, available Online Voice Routing Policies from your tenant are polled.     
    → You will be requested to confirm the Online Voice Routing Policy name to assign it.     
    🔍 When choosing the policy, please use the full name including “Tag:”
💡 Via the same script functionality you can also remove Phone System licenses from Nimbus services. 💡 The script will only ask for an Online Voice Routing Policy assignment when a phone number is added or changed. If you wish to manually change the policy later on, you can do this via the Grant-CsOnlineVoiceRoutingPolicy command.

Script Conclusion and Rerun

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

Script conclusion and rerun dialog

2.💡 At the end you will be asked if you want to rerun the script:

  1. You want to keep the script instance open until all Service changes are complete, so you don't need to authenticate again.
  2. For each further pending change in the General Service Settings (e.g. in dialog with your Service Team Owners) the PowerShell instance can be run again until you are satisfied with the results.

Verifying changes via Test Call

Please allow for at least 5 minutes after applying Team changes before making the call.

 

To test the call functionality: 

  1. Ensure that team members (service users) are Available for the called team and be set to Active in their Nimbus Dashboard.
  2. Open General Service Settings on the service you want to test.
  3. Click on Test Call → The UPN of the service will now be called via Team Client.
Test call option in the service settings

💡 You can test this with 2 different Microsoft Teams client accounts in separate browser windows to simulate this call on your own as both caller and recipient.

💡 If you have assigned a PSTN license / phone number to the service it is also recommended to test calling it.

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? 

✅ 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 Setup Required License
Direct Routing "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" or "Microsoft Teams Calling Plan pay-as-you-go"+ "Communication Credits" (if these aren't already included as part of your plan)
Operator Connect "Microsoft Teams Phone Resource Account"

☝ 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

☝ 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.

🔍 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).
 

☝ 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:

🔍 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 machine it will try to install the required PowerShell modules if they aren't already available. This may require you to run the script as a local administrator: 
→ Right click on the "Windows PowerShell" item in Windows search and select "Run as administrator". 

 
Issue / Error Analysis/Workaround

Error shown:

"Script cannot be loaded because running scripts is disabled on this system."

This error will occur if your local script execution policy does not allow running signed scripts.
→ Changing execution policy to "RemoteSigned" will help to solve this, please check the Microsoft Documentation for more details.

During Service Name Change: The script may encounter an error when trying to update the display name of a service

→ 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. 

 

Table of Contents