In This Article |
This article covers provisioning a single user for Teams Direct Routing, and also using a CSV file to provision multiple users at the same time.
Regardless of which method you use to provision your users, first connect to your Skype for Business Online services using PowerShell. You do not need to connect to the Teams, Azure AD, or MSOL services. If needed, review the Teams Direct Routing - 01 - Planning and Prerequisites article for details.
IMPORTANT: Make sure your user accounts have been licensed before running these commands. They should have a license that includes MS Teams, and the Phone System license. Details can be found in the Teams Direct Routing - 01 - Planning and Prerequisites article. |
If you are switching a user from a Microsoft dial plan to Teams direct routing, remove the phone number from the user, and then remove the dial plan license. Make sure you keep the Phone System license assigned. |
The below commands can be used to view the voice properties of one or more users. This can be useful for checking the status of a user before and after configuring them for Direct Routing.
# Review a list of the user's properties related to Direct Routing Get-CsOnlineUser user@domain.com | FL Displ*, UserPri*, SipA*, Enabled, Inter*, TeamsUpgradeE*, Enterprise*, OnlineVoiceR*, TeamsCall*, TenantD*, VoiceP*, HostedVoicemail*, OnlineDial*, OnPremLineURI, LineURI # Review all of the user's properties Get-CsOnlineUser user@domain.com | FL * # Export a list of all voice users and their properties to a CSV file $CsvFilePath = "C:\Path\to\file.csv" Get-CsOnlineUser -ResultSize Unlimited | Select Displ*, UserPri*, SipA*, Enabled, Inter*, TeamsUpgradeE*, Enterprise*, OnlineVoiceR*, TeamsCall*, TenantD*, VoiceP*, HostedVoicemail*, OnlineDial*, OnPremLineURI, LineURI | Export-Csv $CsvFilePath -nti |
Here's a description of the more important properties outputted with the above commands:
Get the name of the EIP Voice Routing Policy, which has to be entered into the below block of PowerShell code.
Get-CsOnlineVoiceRoutingPolicy | Where { $_.Identity -like "*Evolve*" } |
Get the name of the EIP Tenant Dial Plan, which has to be entered in the below block of PowerShell code.
Get-CsTenantDialPlan | Where { $_.Identity -like "*Evolve*" } |
Provision a User for Direct Routing
Microsoft requires that all phone numbers be in the E.164 format. This means the following:
|
# Enter the name of the Evolve IP voice routing policy $VrPolicyName = "EvolveIP-East" # Enter the name of the Evolve IP tenant dial plan $TdpPolicyName = "EvolveIP-TenantDialPlan" # Enter the user's user principal name $UPN = "user@domain.com" # Enter the user's telephone number (no spaces, dashes, or parentheses) $Phone = "tel:+16105551234" # This will check if the user's coexistence mode is set to TeamsOnly for Direct Routing. If not, it will be set. If ((Get-CsOnlineUser $UPN).TeamsUpgradeEffectiveMode -ne "TeamsOnly") { Grant-CsTeamsUpgradePolicy -Identity $UPN -PolicyName UpgradeToTeams } # This will configure the user's account for direct routing and add the account to the voice routing policy & tenant dial plan Set-CsUser -Identity $UPN -EnterpriseVoiceEnabled $true -OnPremLineUri $Phone Grant-CsOnlineVoiceRoutingPolicy -Identity $UPN -PolicyName $VrPolicyName Grant-CsTenantDialPlan -Identity $UPN -PolicyName $TdpPolicyName |
CSV File Requirements
Create or use an existing CSV file that contains the following required fields:
DisplayName - User account display Name
UserUPN - User account's User Principal Name (Office 365 sign in address)
PhoneNumber - Assigned phone number including the country code (no special characters or spaces)
Here's an example:
DisplayName | UserUPN | PhoneNumber | Location |
---|---|---|---|
George Kastanza | jkastanza@seinfeild.com | 16105551234 | east |
Elaine Benes | ebenes@seinfeild.com | 16105551235 | west |
Provision Users from a CSV File
Paste the below PowerShell code into an editor like the PowerShell ISE or VSCode, and run it from there. |
First, get the name of your Voice Routing Policies and Tenant Dial Plan, which has to be entered into the below block of PowerShell code on lines 8, 9, & 12.
Get-CsOnlineVoiceRoutingPolicy | Where { $_.Identity -like "*Evolve*" } Get-CsTenantDialPlan | Where { $_.Identity -like "*Evolve*" } |
Also define the path to your CSV file on line 5.
[CmdletBinding()] Param () # Path to the CSV file $UserData = Import-Csv "C:\Path\to\file.csv" # Enter the name of your voice routing policies here $VrPolicyNameEast = "EvolveIP-East" $VrPolicyNameWest = "EvolveIP-West" # Enter the name of your tenant dial plan here $TdpPolicyName = "EvolveIP-TenantDialPlan" # The following will loop through each entry in the CSV file and output the provisioning status to the console ForEach ($User in $UserData) { Write-Host "`nPROVISIONING: $($User.DisplayName) ($($User.UserUPN))" # This will check the user's location and associate it with the correct routing policy If ($User.Location.trim() -eq "east") { $Vrp = $VrPolicyNameEast } ElseIf ($User.Location.trim() -eq "west") { $Vrp = $VrPolicyNameWest } Else { Write-Host "No location defined. Continuing to next user." -ForegroundColor Yellow; Continue } # This will define the user's direct routing properties $CsUserProp = @{ Identity = $User.UserUpn EnterpriseVoiceEnabled = $True OnPremLineUri = "tel:+$($User.PhoneNumber)" } # This will check if the user's coexistence mode is set to TeamsOnly. If not, it will be set. If ((Get-CsOnlineUser $CsUserProp.Identity).TeamsUpgradeEffectiveMode -ne "TeamsOnly") { Try { Grant-CsTeamsUpgradePolicy -Identity $CsUserProp.Identity -PolicyName UpgradeToTeams -ErrorAction Stop Write-Host "User set to TeamsOnly coexistence mode." } Catch { Write-Host "Failed to set user to TeamsOnly coexistence mode. Continuing to next user." -ForegroundColor Yellow; Continue } } # This will configure the user's account for direct routing & add the account to your voice routing policy Try { Set-CsUser @CsUserProp -ErrorAction Stop Write-Host "User enabled for direct routing." } Catch { Write-Host "Failed to enable user for direct routing. Continuing to next user." -ForegroundColor Yellow; Continue } Try { Grant-CsOnlineVoiceRoutingPolicy -Identity $User.UserUPN -PolicyName $Vrp -ErrorAction Stop Write-Host "User assigned a VRP: $($Vrp)" Write-Host "User successfully provisioned for direct routing" -ForegroundColor Green } Catch { Write-Host "Failed to assign the VRP: $($Vrp)" -ForegroundColor Yellow } Try { Grant-CsTenantDialPlan -Identity $User.UserUPN -PolicyName $TdpPolicyName -ErrorAction Stop Write-Host "User assigned a Tenant Dial Plan: $($TdpPolicyName)" } Catch { Write-Host "Failed to assign a Tenant Dial Plan: $($TdpPolicyName)" -ForegroundColor Yellow } } # End ForEach |