Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Div | ||||
---|---|---|---|---|
| ||||
In This Article
|
Overview
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 Microsoft Teams services using PowerShell. If needed, review the Teams Direct Routing - 01 - Planning and Prerequisites article for details.
Warning |
---|
IMPORTANT Make sure your user accounts have been licensed before running these commands. They should have a license that includes MS Teams, and the Teams Phone System add-on license. Details can be found in the Teams Direct Routing - 01 - Planning and Prerequisites article. Additionally, you should never remove a Teams Phone System add-on license from a Teams user configured for direct routing until you have removed the direct routing configuration. Removing the Teams Phone System add-on license will not remove the user's direct routing configuration. The phone number assigned to the user will remain associated with the user account, and it the phone number cannot be assigned to another user until it is cleared, or you delete the user account from your environment. If you need to clear the phone number from an unlicensed user account, you will need to re-assign a Teams Phone System add-on license, and properly remove (deprovision) the user's direct routing configuration. |
Tip |
---|
TIP If you are switching a user from a Microsoft calling plan to Teams direct routing, remove the phone number from the user, and then remove the calling plan license. Make sure you keep the Teams Phone System add-on license assigned. |
Check the User's Status
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.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
# 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:
- Enabled - Indicates whether the user is enabled for MS Teams or Skype for Business Online. If enabled is showing False, then the user account is either disabled (sign-in is blocked), or it doesn't have a license that includes MS Teams or Skype for Business Online.
- EnterpriseVoiceEnabled - Indicates whether the user has been enabled for Enterprise Voice. Enterprise voice has to be enabled for Teams Direct Routing to work.
- OnPremLineURI - Specifies the Evolve IP provisioned phone number assigned to the user. The phone number must be specified using the E.164 format and be prefixed with "tel:".
- LineURI - Shows the Evolve IP provisioned phone number assigned to the user based on the value of the OnPremLineURI parameter. If this parameter has a phone number, and OnPremLineURI is blank, the user has been assigned a phone number from Microsoft.
- InterpretedUserType - This can help with troubleshooting users that are not working as expected. Unfortunately, there's a lot of "UserTypes", and Microsoft does not have them documented. People in the Teams community have tried creating some documentation of their own, and doing a google search for InterpretedUserType will turn up some results, which may help. If not, you'll need to open a support case with Microsoft.
- TeamsUpgradeEffectiveMode - For Teams direct routing to work, this should show TeamsOnly.
- OnlineVoiceRoutingPolicy - If this is blank, the user is not assigned a voice routing policy. When a user is configured for Teams direct routing, this should be set to an Evolve IP voice routing policy. To view a list of voice routing policies in your tenant use the Get-CsOnlineVoiceRoutingPolicy command.
- TenantDialPlan - If this is blank, the user is assigned to the Global tenant dial plan. To view a list of dial plans in your tenant use the Get-CsTenantDialPlan command.
- TeamsCallingPolicy - If this is blank, the user is assigned to the Global calling policy. To view a list of calling policies use the Get-CsTeamsCallingPolicy command.
- TeamsCallParkPolicy - If this is blank, the user is assigned to the Global call park policy. To view a list of call park policies use the Get-CsTeamsCallParkPolicy command.
- VoicePolicy - When enabled for Direct Routing, this should show HybridVoice. If it shows BusinessVoice, the user has been assigned a Microsoft calling plan. If it's blank, the user has not been assigned a Teams Phone System licenseadd-on license.
- HostedVoicemail - Enables a user's voice mail calls to be routed to a hosted version of Microsoft Exchange Server. It also enables Skype for Business users to directly place a call to another user's voice mail. It is recommended to enable this for all Teams users.
- HostedVoicemailPolicy - If this shows BusinessVoice, the user's voicemail is hosted by Microsoft. At this time Evolve IP does not plan to host voice mailboxes. So, BusinessVoice should be the value you see.
- OnlineDialinConferencingPolicy - If this shows ServiceAllowed, the user is enabled for Microsoft's Audio Conferencing. If this is blank, the user is not enabled for Audio Conferencing.
- OnlineDialOutPolicy - This policy defines the dial out restrictions from an audio conference. A table of the different policies and their restrictions can be found in this Microsoft article.
Provision a Single Teams User
- Get-CsOnlineVoiceRoutingPolicy
- Grant-CsTeamsUpgradePolicy
- Grant-CsOnlineVoiceRoutingPolicy
- Grant-CsTenantDialPlan
- Get-CsOnlineUser
- Set-CsUser
Get the name of the EIP Voice Routing Policy, which has to be entered into the below block of PowerShell code.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
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.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Get-CsTenantDialPlan | Where { $_.Identity -like "*Evolve*" } |
Provision a User for Direct Routing
Info |
---|
NOTE Microsoft requires that all phone numbers be in the E.164 format. This means the following:
|
Warning |
---|
IMPORTANT In the below PowerShell code, be sure to change the relevant data on lines 2, 5, 8, & 11 to match your configuration and specific user. |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
# Enter the name of the Evolve IP voice routing policy $VrPolicyName = "EvolveIP-USEast" # 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" ### Begin User Provisioning ### # This will check if the user's coexistence mode is set to TeamsOnly for Direct # Routing. If it is not set to TeamsOnly, 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 -OnPremLineUri $Phone -EnterpriseVoiceEnabled $true -HostedVoiceMail $true Grant-CsOnlineVoiceRoutingPolicy -Identity $UPN -PolicyName $VrPolicyName Grant-CsTenantDialPlan -Identity $UPN -PolicyName $TdpPolicyName ### End User Provisioning ### |
Provision from a CSV File
- Get-CsOnlineVoiceRoutingPolicy
- Grant-CsTeamsUpgradePolicy
- Grant-CsOnlineVoiceRoutingPolicy
- Get-CsOnlineUser
- Set-CsUser
- Import-Csv
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)
- Location - Determines which location a user will be assigned
Here's an example for the US region:
DisplayName | UserUPN | PhoneNumber | Location |
---|---|---|---|
George Kastanza | jkastanza@seinfeild.com | 16105551234 | east |
Elaine Benes | ebenes@seinfeild.com | 16105551235 | west |
Here's an example for the EU region:
DisplayName | UserUPN | PhoneNumber | Location |
---|---|---|---|
Cosmo Kramer | ckramer@seinfeild.com | 31884281234 | NNpeer01 |
Newman | newman@seinfeild.com | 31884221234 | NNpeer02 |
Provision Users from a CSV File
Tip |
---|
TIP 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 US or EU PowerShell code on lines 8, 9, & 12.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Get-CsOnlineVoiceRoutingPolicy | Where { $_.Identity -like "*Evolve*" } Get-CsTenantDialPlan | Where { $_.Identity -like "*Evolve*" } |
Next, use these blocks of code, depending on your region, with the output from the previous query on lines 8, 9, & 12. Also define the path to your CSV file on line 5.
Expand | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
spacer |
Expand | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
spacer |