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, and 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.
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 Phone System license. Details can be found in the Teams Direct Routing - 01 - Planning and Prerequisites article. |
Tip |
---|
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. |
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 DisplayNameDispl*, UserPri*, SipAddressSipA*, Enabled, InterpretedUserTypeInter*, TeamsUpgradeTeamsUpgradeE*, EnterpriseVoiceEnabledEnterprise*, OnlineVoiceRoutingPolicyOnlineVoiceR*, TeamsVoiceRouteTeamsCall*, TeamsCallingPolicyTenantD*, VoicePolicyVoiceP*, 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 DisplayNameDispl*, UserPri*, SipAddressSipA*, Enabled, InterpretedUserTypeInter*, TeamsUpgradeTeamsUpgradeE*, EnterpriseVoiceEnabledEnterprise*, OnlineVoiceRoutingPolicyOnlineVoiceR*, TeamsVoiceRouteTeamsCall*, TeamsCallingPolicyTenantD*, VoicePolicyVoiceP*, 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 - For Teams Direct Routing to work, this should show PureOnlineSfBUser or DirSyncTeamsUsershow DirSyncSfBUser, PureOnlineSfBUser, DirSyncTeamsUser, or PureOnlineTeamsUser.
- TeamsUpgradeEffectiveMode - For Teams Direct Routing to work, this should show TeamsOnly.
- OnlineVoiceRoutingPolicy - When a user is configured for Teams Direct Routing, this should be set to an EIP-TDR-VRP 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 Teams 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 dial plan. If it's blank, the user has not been assigned a Phone System license.
- HostedVoicemail - Indicates whether the user has enabled their voicemail. By default, all users can enable/disable their voicemail from within the Teams app.
- 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 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 "*EIP*" } |
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 "*EIP*" } |
Provision a User for Direct Routing
Info |
---|
Microsoft requires that all phone numbers be in the E.164 format. This means the following:
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
# Enter the name of the EIP voice routing policy here $VrPolicyName = "EIP-TDR-VRP-AllCalls-East" # Enter the name of the EIP tenant dial plan $TdpPolicyName = "EIP-TDR-TenantDialPlan" # Enter the user's user principal name $UPN = "user@domain.com" # Enter the user's telephone number $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 |
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 (east or west)
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
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 PowerShell code on lines 8, 9, & 12.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Get-CsOnlineVoiceRoutingPolicy | Where { $_.Identity -like "*EIP*" } Get-CsTenantDialPlan | Where { $_.Identity -like "*EIP*" } |
Also define the path to your CSV file on line 5.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[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 = "EIP-TDR-VRP-AllCalls-East" $VrPolicyNameWest = "EIP-TDR-VRP-AllCalls-West" # Enter the name of your tenant dial plan here $TdpPolicyName = "EIP-TDR-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 TDR." } Catch { Write-Host "Failed to enable user for TDR. 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 Teams 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 |