Public/Functions/VoiceConfig/Enable-TeamsUserForEnterpriseVoice.ps1
|
# Module: TeamsFunctions # Function: Teams User Voice Configuration # Author: David Eberhardt # Updated: 01-DEC-2020 # Status: PreLive #TODO Add Stack - Write direct output when called directly, otherwise verbose function Enable-TeamsUserForEnterpriseVoice { <# .SYNOPSIS Enables a User for Enterprise Voice .DESCRIPTION Enables a User for Enterprise Voice and verifies its status .PARAMETER Identity UserPrincipalName of the User to be enabled. .PARAMETER Force Suppresses confirmation prompt unless -Confirm is used explicitly .EXAMPLE Enable-TeamsUserForEnterpriseVoice John@domain.com Enables John for Enterprise Voice .NOTES Simple helper function to enable and verify a User is enabled for Enterprise Voice #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'Medium')] [Alias('Enable-Ev')] [OutputType([Boolean])] param( [Parameter(Mandatory, Position = 0)] [Alias('UserPrincipalName')] [string]$Identity, [Parameter(HelpMessage = "Suppresses confirmation prompt unless -Confirm is used explicitly")] [switch]$Force ) #param begin { Show-FunctionStatus -Level PreLive Write-Verbose -Message "[BEGIN ] $($MyInvocation.MyCommand)" # Asserting SkypeOnline Connection if (-not (Assert-SkypeOnlineConnection)) { break } } #begin process { #TODO Check whether Get-TeamsUserVoiceConfig can be used here (performance!) or Get-TeamsUserLicense to #TODO Error on not-licensed! $UserObject = Get-CsOnlineUser $Identity -WarningAction SilentlyContinue $IsEVenabled = $UserObject.EnterpriseVoiceEnabled if ($IsEVenabled) { Write-Verbose -Message "User '$Identity' Enterprise Voice Status: User is already enabled!" -Verbose return $true } else { Write-Verbose -Message "User '$Identity' Enterprise Voice Status: Not enabled, trying to enable" -Verbose try { if ($Force -or $PSCmdlet.ShouldProcess("$Identity", "Enabling User for EnterpriseVoice")) { $null = Set-CsUser $Identity -EnterpriseVoiceEnabled $TRUE -ErrorAction STOP $i = 0 $iMax = 20 $Status = "Enable User For Enterprise Voice" $Operation = "Waiting for Get-CsOnlineUser to return a Result" Write-Verbose -Message "$Status - $Operation" while ( -not $(Get-CsOnlineUser $Identity -WarningAction SilentlyContinue).EnterpriseVoiceEnabled) { if ($i -gt $iMax) { Write-Error -Message "User was not enabled for Enterprise Voice in the last $iMax Seconds" -Category LimitsExceeded -RecommendedAction "Please verify Object has been enabled (EnterpriseVoiceEnabled); Continue with Set-TeamsAutoAttendant" return } Write-Progress -Id 0 -Activity "Azure Active Directory is writing to the User Object. Please wait" ` -Status $Status -SecondsRemaining $($iMax - $i) -CurrentOperation $Operation -PercentComplete (($i * 100) / $iMax) Start-Sleep -Milliseconds 1000 $i++ } # re-query $EVenabled = $(Get-CsOnlineUser $Identity).EnterpriseVoiceEnabled Write-Verbose -Message "User '$Identity' Enterprise Voice Status: $EVenabled" if ($EVenabled) { Write-Verbose -Message "User '$Identity' Enterprise Voice Status: SUCCESS" -Verbose return $true } else { Write-Verbose -Message "User '$Identity' Enterprise Voice Status: FAILED" -Verbose return $false } } } catch { Write-Verbose -Message "User '$Identity' Enterprise Voice Status: ERROR" -Verbose Write-Error -Message "$($_.Exception.Message)" return $false } } } #process end { Write-Verbose -Message "[END ] $($MyInvocation.MyCommand)" } #end } #Enable-TeamsUserForEnterpriseVoice |