Public/UserManagement/VoiceConfig/New-TeamsUserVoiceConfig.ps1
# Module: TeamsFunctions # Function: VoiceConfig # Author: David Eberhardt # Updated: 01-JUN-2021 # Status: RC # Add CallingLineIdentity and maybe other policies? function New-TeamsUserVoiceConfig { <# .SYNOPSIS Enables a User to consume Voice services in Teams (Pstn breakout) .DESCRIPTION Enables a User for Direct Routing, Microsoft Callings or for use in Call Queues (EvOnly) User requires a Phone System License in any case. Requires all necessary parameters. Calls Set-TeamsUserVoiceConfig after validating parameters. .PARAMETER UserPrincipalName Required. UserPrincipalName (UPN) of the User to change the configuration for .PARAMETER DirectRouting Optional (Default Parameter Set). Limits the Scope to enable an Object for DirectRouting .PARAMETER CallingPlans Required for CallingPlans. Limits the Scope to enable an Object for CallingPlans .PARAMETER PhoneNumber Required. Phone Number in E.164 format to be assigned to the User. For proper configuration a PhoneNumber is required. Without it, the User will not be able to make or receive calls. This script does not enforce all Parameters and is intended to validate and configure one or all Parameters. For enforced ParameterSet please call New-TeamsUserVoiceConfig (NOTE: This script does currently not yet exist) For DirectRouting, will populate the LineUri For CallingPlans, will populate the TelephoneNumber (must be present in the Tenant) .PARAMETER OnlineVoiceRoutingPolicy Required. Required for DirectRouting. Assigns an Online Voice Routing Policy to the User .PARAMETER TenantDialPlan Optional. Optional for DirectRouting. Assigns a Tenant Dial Plan to the User .PARAMETER CallingPlanLicense Optional. Optional for CallingPlans. Assigns a Calling Plan License to the User. Must be one of the set: InternationalCallingPlan DomesticCallingPlan DomesticCallingPlan120 CommunicationCredits DomesticCallingPlan120b .PARAMETER Force By default, this script only applies changed elements. Force overwrites configuration regardless of current status. Additionally Suppresses confirmation inputs except when $Confirm is explicitly specified .PARAMETER WriteErrorLog If Errors are encountered, writes log to C:\Temp .EXAMPLE New-TeamsUserVoiceConfig -UserPrincipalName John@domain.com -CallingPlans -PhoneNumber "+15551234567" -CallingPlanLicense DomesticCallingPlan Provisions John@domain.com for Calling Plans with the Calling Plan License and Phone Number provided .EXAMPLE New-TeamsUserVoiceConfig -UserPrincipalName John@domain.com -CallingPlans -PhoneNumber "+15551234567" -WriteErrorLog Provisions John@domain.com for Calling Plans with the Phone Number provided (requires Calling Plan License to be assigned already) If Errors are encountered, they are written to C:\Temp as well as on screen .EXAMPLE New-TeamsUserVoiceConfig -UserPrincipalName John@domain.com -DirectRouting -PhoneNumber "+15551234567" -OnlineVoiceRoutingPolicy "O_VP_AMER" Provisions John@domain.com for DirectRouting with the Online Voice Routing Policy and Phone Number provided .EXAMPLE New-TeamsUserVoiceConfig -UserPrincipalName John@domain.com -PhoneNumber "+15551234567" -OnlineVoiceRoutingPolicy "O_VP_AMER" -TenantDialPlan "DP-US" Provisions John@domain.com for DirectRouting with the Online Voice Routing Policy, Tenant Dial Plan and Phone Number provided .EXAMPLE New-TeamsUserVoiceConfig -UserPrincipalName John@domain.com -PhoneNumber "+15551234567" -OnlineVoiceRoutingPolicy "O_VP_AMER" Provisions John@domain.com for DirectRouting with the Online Voice Routing Policy and Phone Number provided. .INPUTS System.String .OUTPUTS System.Object - Default Behaviour System.File - With Switch WriteErrorLog .NOTES ParameterSet 'DirectRouting' will provision a User to use DirectRouting. Enables User for Enterprise Voice, assigns a Number and an Online Voice Routing Policy and optionally also a Tenant Dial Plan. This is the default. ParameterSet 'CallingPlans' will provision a User to use Microsoft CallingPlans. Enables User for Enterprise Voice and assigns a Microsoft Number (must be found in the Tenant!) Optionally can also assign a Calling Plan license prior. This script cannot apply PhoneNumbers for OperatorConnect yet This script accepts pipeline input as Value (UserPrincipalName) or as Object (UPN, OVP, TDP, PhoneNumber) This enables bulk provisioning This script calls Set-TeamsUserVoiceConfig and passes on all parameters. All work is done by the Set-Cmdlet It differs only in that all Parameters are required and that an Object is always returned. .COMPONENT VoiceConfiguration .FUNCTIONALITY Applying Voice Configuration parameters to a User .LINK https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/New-TeamsUserVoiceConfig.md .LINK https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/about_VoiceConfiguration.md .LINK https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/ #> [CmdletBinding(SupportsShouldProcess, DefaultParameterSetName = 'DirectRouting', ConfirmImpact = 'Medium')] [Alias('New-TeamsUVC')] [OutputType([System.Object])] param( [Parameter(Mandatory, Position = 0, ValueFromPipelineByPropertyName, ValueFromPipeline, HelpMessage = 'UserPrincipalName of the User')] [Alias('Identity')] [string]$UserPrincipalName, [Parameter(ParameterSetName = 'DirectRouting', HelpMessage = 'Enables an Object for Direct Routing')] [switch]$DirectRouting, [Parameter(Mandatory, ParameterSetName = 'DirectRouting', ValueFromPipelineByPropertyName, HelpMessage = 'Name of the Online Voice Routing Policy')] [Alias('OVP')] [ValidateScript( { if ($_ -in $(&$global:TfAcSbVoiceRoutingPolicy)) { return $true } else { throw [System.Management.Automation.ValidationMetadataException] 'Value must be a valid Policy in the Tenant. Use Intellisense for options' } })] [ArgumentCompleter({ &$global:TfAcSbVoiceRoutingPolicy })] [string]$OnlineVoiceRoutingPolicy, [Parameter(ValueFromPipelineByPropertyName, HelpMessage = 'Name of the Tenant Dial Plan')] [Alias('TDP')] [ValidateScript( { if ($_ -in $(&$global:TfAcSbTenantDialPlan)) { return $true } else { throw [System.Management.Automation.ValidationMetadataException] 'Value must be a valid Dial Plan in the Tenant. Use Intellisense for options' } })] [ArgumentCompleter({ &$global:TfAcSbTenantDialPlan })] [string]$TenantDialPlan, [Parameter(Mandatory, ValueFromPipelineByPropertyName, HelpMessage = 'E.164 Number to assign to the Object')] [AllowNull()] [AllowEmptyString()] [Alias('Number', 'LineURI')] [string]$PhoneNumber, [Parameter(Mandatory, ParameterSetName = 'CallingPlans', HelpMessage = 'Enables an Object for Microsoft Calling Plans')] [switch]$CallingPlan, [Parameter(ParameterSetName = 'CallingPlans', HelpMessage = 'Calling Plan License to assign to the Object')] [ValidateScript( { if ($_ -in $(&$global:TfAcSbCallingPlanLicense)) { return $true } else { throw [System.Management.Automation.ValidationMetadataException] 'Value must be a valid Calling Plan. Use Intellisense for options or Get-AzureAdLicense (ParameterName)' } })] [ArgumentCompleter({ &$global:TfAcSbCallingPlanLicense })] [string[]]$CallingPlanLicense, [Parameter(HelpMessage = 'Suppresses confirmation prompt unless -Confirm is used explicitly')] [switch]$Force, [Parameter(HelpMessage = 'Writes a Log File to C:\Temp')] [switch]$WriteErrorLog ) #param begin { #break Show-FunctionStatus -Level Live Write-Verbose -Message "[BEGIN ] $($MyInvocation.MyCommand)" # Asserting AzureAD Connection if ( -not $script:TFPSSA) { $script:TFPSSA = Assert-AzureADConnection; if ( -not $script:TFPSSA ) { break } } # Asserting MicrosoftTeams Connection if ( -not (Assert-MicrosoftTeamsConnection) ) { break } # Setting Preference Variables according to Upstream settings if (-not $PSBoundParameters.ContainsKey('Verbose')) { $VerbosePreference = $PSCmdlet.SessionState.PSVariable.GetValue('VerbosePreference') } if (-not $PSBoundParameters.ContainsKey('Confirm')) { $ConfirmPreference = $PSCmdlet.SessionState.PSVariable.GetValue('ConfirmPreference') } if (-not $PSBoundParameters.ContainsKey('WhatIf')) { $WhatIfPreference = $PSCmdlet.SessionState.PSVariable.GetValue('WhatIfPreference') } if (-not $PSBoundParameters.ContainsKey('Debug')) { $DebugPreference = $PSCmdlet.SessionState.PSVariable.GetValue('DebugPreference') } else { $DebugPreference = 'Continue' } if ( $PSBoundParameters.ContainsKey('InformationAction')) { $InformationPreference = $PSCmdlet.SessionState.PSVariable.GetValue('InformationAction') } else { $InformationPreference = 'Continue' } } #begin process { Write-Verbose -Message "[PROCESS] $($MyInvocation.MyCommand)" Write-Verbose -Message "[PROCESS] Processing '$UserPrincipalName'" if ($Force -or $PSCmdlet.ShouldProcess("$UserPrincipalName", 'Set-TeamsUserVoiceConfig')) { Set-TeamsUserVoiceConfig @PSBoundParameters -PassThru } } #process end { Write-Verbose -Message "[END ] $($MyInvocation.MyCommand)" } #end } #Set-TeamsUserVoiceConfig |