Public/CallQueue/Get-TeamsCallQueue.ps1
# Module: TeamsFunctions # Function: CallQueue # Author: David Eberhardt # Updated: 01-JAN-2021 # Status: Live function Get-TeamsCallQueue { <# .SYNOPSIS Queries Call Queues and displays friendly Names (UPN or Displayname) .DESCRIPTION Same functionality as Get-CsCallQueue, but display reveals friendly Names, like UserPrincipalName or DisplayName for the following connected Objects OverflowActionTarget, TimeoutActionTarget, Agents, DistributionLists and ApplicationInstances (Resource Accounts) .PARAMETER Name Required for ParameterSet Name. Searches all Call Queues for this name (unique results). If not provided, all Call Queues are queried, returning only the name .PARAMETER SearchString Required for ParameterSet Search. Searches all Call Queues for this string (multiple results possible). .PARAMETER Detailed Optional Switch. Displays all Parameters of the CallQueue This also shows parameters relating to Ids and Diagnostic Parameters. .EXAMPLE Get-TeamsCallQueue Same result as Get-CsCallQueue .EXAMPLE Get-TeamsCallQueue -Name "My CallQueue" Returns an Object for every Call Queue found with the exact Name "My CallQueue" .EXAMPLE Get-TeamsCallQueue -Name "My CallQueue" -Detailed Returns an Object for every Call Queue found with the String "My CallQueue" Displays additional Parameters used for Diagnostics & Shared Voicemail. .EXAMPLE Get-TeamsCallQueue -SearchString "My CallQueue" Returns an Object for every Call Queue matching the String "My CallQueue" Synonymous with Get-CsCallQueue -NameFilter "My CallQueue", but output shown differently. .EXAMPLE Get-TeamsCallQueue -Name "My CallQueue" -SearchString "My CallQueue" Returns an Object for every Call Queue found with the exact Name "My CallQueue" and Returns an Object for every Call Queue matching the String "My CallQueue" .INPUTS System.String .OUTPUTS System.Object .NOTES Without any parameters, Get-TeamsCallQueue will show names only Agents, DistributionLists, Targets and Resource Accounts are displayed with friendly name. Main difference to Get-CsCallQueue (apart from the friendly names) is that the Output view more concise .COMPONENT TeamsCallQueue .FUNCTIONALITY Get-CsCallQueue with friendly names instead of GUID-strings for connected objects .LINK https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/Get-TeamsCallQueue.md .LINK https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/about_TeamsCallQueue.md .LINK https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/ #> [CmdletBinding(SupportsPaging, DefaultParameterSetName = 'Name')] [Alias('Get-TeamsCQ')] [OutputType([System.Object[]])] param( [Parameter(ParameterSetName = 'Name', Position = 0, ValueFromPipeline, ValueFromPipelineByPropertyName, HelpMessage = 'Full Name of the Call Queue')] [AllowNull()] [string[]]$Name, [Parameter(ParameterSetName = 'Search', HelpMessage = 'Partial or full Name of the Call Queue to search')] [Alias('NameFilter')] [string]$SearchString, [Parameter()] [switch]$Detailed ) #param begin { 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' } #Initialising Counters $private:StepsID0, $private:StepsID1 = Get-WriteBetterProgressSteps -Code $($MyInvocation.MyCommand.Definition) -MaxId 1 $private:ActivityID0 = $($MyInvocation.MyCommand.Name) [int] $private:CountID0 = [int] $private:CountID1 = 1 #Initialising splatting Object $GetCsCallQueueParameters = @{ WarningAction = 'SilentlyContinue' ErrorAction = 'Continue' } if ( $PSBoundParameters.ContainsKey('First') ) { $GetCsCallQueueParameters.First = $PSCmdlet.PagingParameters.First } if ( $PSBoundParameters.ContainsKey('Skip') ) { $GetCsCallQueueParameters.Skip = $PSCmdlet.PagingParameters.Skip } if ( $PSBoundParameters.ContainsKey('IncludeTotalCount') ) { $GetCsCallQueueParameters.IncludeTotalCount = $PSCmdlet.PagingParameters.IncludeTotalCount } #Worker Function function GetCallQueues { [CmdletBinding()] [OutputType([System.Object])] param( [Parameter(Position = 0, ValueFromPipeline, ValueFromPipelineByPropertyName, HelpMessage = 'Call Queue object')] [AllowNull()] [object]$Q, [Parameter()] [bool]$Detailed ) #param begin { } process { # Initialising counters for Progress bars [int] $private:CountID0 = 1 $ActivityID0 = "'$($Q.Name)'" # Initialising Arrays [System.Collections.Generic.List[object]]$UserObjects = @() [System.Collections.Generic.List[object]]$DLNames = @() [System.Collections.Generic.List[object]]$AIObjects = @() [System.Collections.Generic.List[object]]$OboObjects = @() [System.Collections.Generic.List[object]]$AuthorizedUserObjects = @() if ( $Detailed ) { [System.Collections.Generic.List[object]]$ChannelUserObjects = @() [System.Collections.Generic.List[object]]$AgentObjects = @() } $StatusID0 = 'Parsing Targets' #region Finding OverflowActionTarget $CurrentOperationID0 = 'OverflowActionTarget' Write-BetterProgress -Id 0 -Activity $ActivityID0 -Status $StatusID0 -CurrentOperation $CurrentOperationID0 -Step ($private:CountID0++) -Of $private:StepsID0 $OAT = $null if ($Q.OverflowActionTarget) { $OAT = Get-TeamsCallableEntity -Identity "$($Q.OverflowActionTarget.Id)" -WarningAction SilentlyContinue } # Output: $OAT #endregion #region Finding TimeoutActionTarget $CurrentOperationID0 = 'TimeoutActionTarget' Write-BetterProgress -Id 0 -Activity $ActivityID0 -Status $StatusID0 -CurrentOperation $CurrentOperationID0 -Step ($private:CountID0++) -Of $private:StepsID0 $TAT = $null if ($Q.TimeoutActionTarget) { $TAT = Get-TeamsCallableEntity -Identity "$($Q.TimeoutActionTarget.Id)" -WarningAction SilentlyContinue } # Output: $TAT #endregion #region Endpoints $StatusID0 = 'Parsing Endpoints' # Channel $CurrentOperationID0 = 'Channel' Write-BetterProgress -Id 0 -Activity $ActivityID0 -Status $StatusID0 -CurrentOperation $CurrentOperationID0 -Step ($private:CountID0++) -Of $private:StepsID0 if ($Q.ChannelId) { $FullChannelId = $Q.DistributionLists.Guid + '\' + $Q.ChannelId $Team, $Channel = $null $Team, $Channel = Get-TeamsTeamAndChannel -String "$FullChannelId" #$Team, $Channel = Get-TeamAndChannel -String "$FullChannelId" $TeamAndChannelName = "$($Team.DisplayName)" + '\' + "$($Channel.DisplayName)" } # Output: $ChannelObject # Distribution Lists $CurrentOperationID0 = 'DistributionLists' Write-BetterProgress -Id 0 -Activity $ActivityID0 -Status $StatusID0 -CurrentOperation $CurrentOperationID0 -Step ($private:CountID0++) -Of $private:StepsID0 foreach ($DL in $Q.DistributionLists) { try { $DLObject = Get-AzureADGroup -ObjectId "$DL" -WarningAction SilentlyContinue if ($DLObject) { [void]$DLNames.Add($DLObject.DisplayName) } } catch { [string]$Message = $_ | Get-ErrorMessageFromErrorString Write-Warning -Message "'$($Q.Name)' - $Operation`: GetUser$($Message.Split(':')[1])" } } # Output: $DLNames # Users $CurrentOperationID0 = 'Users' Write-BetterProgress -Id 0 -Activity $ActivityID0 -Status $StatusID0 -CurrentOperation $CurrentOperationID0 -Step ($private:CountID0++) -Of $private:StepsID0 foreach ($User in $Q.Users) { try { $UserObject = Get-AzureADUser -ObjectId "$($User.Guid)" -WarningAction SilentlyContinue -ErrorAction Stop | Select-Object UserPrincipalName, DisplayName, JobTitle, CompanyName, Country, UsageLocation, PreferredLanguage [void]$UserObjects.Add($UserObject) } catch { [string]$Message = $_ | Get-ErrorMessageFromErrorString Write-Warning -Message "'$($Q.Name)' - $Operation`: GetUser$($Message.Split(':')[1])" } } # Output: $UserObjects.UserPrincipalName if ( $Detailed ) { $StatusID0 = 'Switch Detailed' # Parsing Channel Users when the detailed Switch is used $CurrentOperationID0 = 'Channel Users' Write-BetterProgress -Id 0 -Activity $ActivityID0 -Status $StatusID0 -CurrentOperation $CurrentOperationID0 -Step ($private:CountID0++) -Of $private:StepsID0 foreach ($User in $Q.ChannelUserObjectId) { try { $ChannelUserObject = Get-AzureADUser -ObjectId "$($User.Guid)" -WarningAction SilentlyContinue -ErrorAction Stop | Select-Object UserPrincipalName, DisplayName, JobTitle, CompanyName, Country, UsageLocation, PreferredLanguage [void]$ChannelUserObjects.Add($ChannelUserObject) } catch { [string]$Message = $_ | Get-ErrorMessageFromErrorString Write-Warning -Message "'$($Q.Name)' - $Operation`: GetUser$($Message.Split(':')[1])" } } # Output: $UserObjects.UserPrincipalName # Parsing Agents only when the detailed Switch is used $CurrentOperationID0 = 'Agents' Write-BetterProgress -Id 0 -Activity $ActivityID0 -Status $StatusID0 -CurrentOperation $CurrentOperationID0 -Step ($private:CountID0++) -Of $private:StepsID0 foreach ($Agent in $Q.Agents) { try { $AgentObject = Get-AzureADUser -ObjectId "$($Agent.ObjectId)" -WarningAction SilentlyContinue -ErrorAction Stop | Select-Object UserPrincipalName, DisplayName, JobTitle, CompanyName, Country, UsageLocation, PreferredLanguage [void]$AgentObjects.Add($AgentObject) } catch { [string]$Message = $_ | Get-ErrorMessageFromErrorString Write-Warning -Message "'$($Q.Name)' - $Operation`: GetUser$($Message.Split(':')[1])" } } # Output: $AgentObjects.UserPrincipalName } # Authorized Users $CurrentOperationID0 = 'Authorized Users' Write-BetterProgress -Id 0 -Activity $ActivityID0 -Status $StatusID0 -CurrentOperation $CurrentOperationID0 -Step ($private:CountID0++) -Of $private:StepsID0 foreach ($User in $Q.AuthorizedUsers) { $UserObject = $null try { $UserObject = Get-AzureADUser -ObjectId "$($User.Guid)" -WarningAction SilentlyContinue -ErrorAction Stop | Select-Object UserPrincipalName, DisplayName, JobTitle, CompanyName, Country, UsageLocation, PreferredLanguage [void]$AuthorizedUserObjects.Add($UserObject) } catch { [string]$Message = $_ | Get-ErrorMessageFromErrorString Write-Warning -Message "'$($Q.Name)' - $Operation`: GetUser$($Message.Split(':')[1])" } } #endregion $StatusID0 = 'Parsing Resource Accounts' #region Application Instance UPNs $CurrentOperationID0 = 'Resource Accounts (Associated)' Write-BetterProgress -Id 0 -Activity $ActivityID0 -Status $StatusID0 -CurrentOperation $CurrentOperationID0 -Step ($private:CountID0++) -Of $private:StepsID0 foreach ($AI in $Q.ApplicationInstances) { $AIObject = $null $AIObject = Get-CsOnlineApplicationInstance | Where-Object { $_.ObjectId -eq $AI } | Select-Object UserPrincipalName, DisplayName, PhoneNumber if ($null -ne $AIObject) { [void]$AIObjects.Add($AIObject) } } # Output: $AIObjects.UserPrincipalName #endregion #region Application Instance UPNs $CurrentOperationID0 = 'Resource Accounts (CallerId)' Write-BetterProgress -Id 0 -Activity $ActivityID0 -Status $StatusID0 -CurrentOperation $CurrentOperationID0 -Step ($private:CountID0++) -Of $private:StepsID0 foreach ($OboRA in $Q.OboResourceAccountIds) { $OboObject = $null $OboObject = Get-CsOnlineApplicationInstance | Where-Object { $_.ObjectId -eq $OboRA } | Select-Object UserPrincipalName, DisplayName, PhoneNumber if ($null -ne $OboObject) { [void]$OboObjects.Add($OboObject) } } # Output: $OboObjects.UserPrincipalName #endregion #region Creating Output Object # Building custom Object with Friendly Names $StatusID0 = 'Output' $CurrentOperationID0 = 'Constructing Output Object' Write-BetterProgress -Id 0 -Activity $ActivityID0 -Status $StatusID0 -CurrentOperation $CurrentOperationID0 -Step ($private:CountID0++) -Of $private:StepsID0 $QueueObject = $null $QueueObject = [PSCustomObject][ordered]@{ PSTypeName = 'PowerShell.TeamsFunctsions.CallQueue' Identity = $Q.Identity Name = $Q.Name LanguageId = $Q.LanguageId UseDefaultMusicOnHold = $Q.UseDefaultMusicOnHold WelcomeMusicAudioFileName = $Q.WelcomeMusicFileName WelcomeTextToSpeechPrompt = $Q.WelcomeTextToSpeechPrompt MusicOnHoldAudioFileName = $Q.MusicOnHoldFileName RoutingMethod = $Q.RoutingMethod PresenceBasedRouting = $Q.PresenceBasedRouting AgentAlertTime = $Q.AgentAlertTime AllowOptOut = $Q.AllowOptOut ConferenceMode = $Q.ConferenceMode OverflowThreshold = $Q.OverflowThreshold OverflowAction = $Q.OverflowAction OverflowActionTarget = $OAT.Entity OverflowActionTargetType = $OAT.Type } if ( $Detailed -or $OverflowActionTargetType -eq 'SharedVoiceMail') { # Displays SharedVoiceMail Parameters only if OverflowActionTargetType is set to SharedVoicemail $QueueObject | Add-Member -MemberType NoteProperty -Name OverflowSharedVoicemailAudioFilePrompt -Value $Q.OverflowSharedVoicemailAudioFilePrompt $QueueObject | Add-Member -MemberType NoteProperty -Name OverflowSharedVoicemailAudioFilePromptFileName -Value $Q.OverflowSharedVoicemailAudioFilePromptFileName $QueueObject | Add-Member -MemberType NoteProperty -Name OverflowSharedVoicemailTextToSpeechPrompt -Value $Q.OverflowSharedVoicemailTextToSpeechPrompt $QueueObject | Add-Member -MemberType NoteProperty -Name EnableOverflowSharedVoicemailTranscription -Value $Q.EnableOverflowSharedVoicemailTranscription } # Adding Timeout Parameters $QueueObject | Add-Member -MemberType NoteProperty -Name TimeoutThreshold -Value $Q.TimeoutThreshold $QueueObject | Add-Member -MemberType NoteProperty -Name TimeoutAction -Value $Q.TimeoutAction $QueueObject | Add-Member -MemberType NoteProperty -Name TimeoutActionTarget -Value $TAT.Entity $QueueObject | Add-Member -MemberType NoteProperty -Name TimeoutActionTargetType -Value $TAT.Type if ( $Detailed -or $TimeoutActionTargetType -eq 'SharedVoiceMail') { # Displays SharedVoiceMail Parameters only if TimeoutActionTargetType is set to SharedVoicemail $QueueObject | Add-Member -MemberType NoteProperty -Name TimeoutSharedVoicemailAudioFilePrompt -Value $Q.TimeoutSharedVoicemailAudioFilePrompt $QueueObject | Add-Member -MemberType NoteProperty -Name TimeoutSharedVoicemailAudioFilePromptFileName -Value $Q.TimeoutSharedVoicemailAudioFilePromptFileName $QueueObject | Add-Member -MemberType NoteProperty -Name TimeoutSharedVoicemailTextToSpeechPrompt -Value $Q.TimeoutSharedVoicemailTextToSpeechPrompt $QueueObject | Add-Member -MemberType NoteProperty -Name EnableTimeoutSharedVoicemailTranscription -Value $Q.EnableTimeoutSharedVoicemailTranscription } # Adding Agent Information $QueueObject | Add-Member -MemberType NoteProperty -Name TeamAndChannel -Value $TeamAndChannelName if ( $Detailed ) { $QueueObject | Add-Member -MemberType NoteProperty -Name Users -Value $($UserObjects.UserPrincipalName -join ', ') $QueueObject | Add-Member -MemberType NoteProperty -Name DistributionLists -Value $($DLNames -join ', ') } else { $QueueObject | Add-Member -MemberType NoteProperty -Name Users -Value $UserObjects.UserPrincipalName $QueueObject | Add-Member -MemberType NoteProperty -Name DistributionLists -Value $DLNames } $QueueObject | Add-Member -MemberType NoteProperty -Name DistributionListsLastExpanded -Value $Q.DistributionListsLastExpanded $QueueObject | Add-Member -MemberType NoteProperty -Name AgentsInSyncWithDistributionLists -Value $Q.AgentsInSyncWithDistributionLists $QueueObject | Add-Member -MemberType NoteProperty -Name AgentsCapped -Value $Q.AgentsCapped if ( $Detailed ) { # Displays Agents $QueueObject | Add-Member -MemberType NoteProperty -Name Agents -Value $($AgentObjects.UserPrincipalName -join ', ') $QueueObject | Add-Member -MemberType NoteProperty -Name ChannelUsers -Value $($ChannelUserObjects.UserPrincipalName -join ', ') # Displays all except reserved Parameters (Microsoft Internal) $QueueObject | Add-Member -MemberType NoteProperty -Name MusicOnHoldAudioFileId -Value $Q.MusicOnHoldAudioFileId $QueueObject | Add-Member -MemberType NoteProperty -Name WelcomeMusicAudioFileId -Value $Q.WelcomeMusicAudioFileId $QueueObject | Add-Member -MemberType NoteProperty -Name MusicOnHoldFileDownloadUri -Value $Q.MusicOnHoldFileDownloadUri $QueueObject | Add-Member -MemberType NoteProperty -Name WelcomeMusicFileDownloadUri -Value $Q.WelcomeMusicFileDownloadUri $QueueObject | Add-Member -MemberType NoteProperty -Name Description -Value $Q.Description } if ( $Detailed ) { $QueueObject | Add-Member -MemberType NoteProperty -Name ResourceAccountsAssociated -Value $($AIObjects.Userprincipalname -join ', ') $QueueObject | Add-Member -MemberType NoteProperty -Name ResourceAccountsForCallerId -Value $($OboObjects.Userprincipalname -join ', ') } else { $QueueObject | Add-Member -MemberType NoteProperty -Name ResourceAccountsAssociated -Value $AIObjects.Userprincipalname $QueueObject | Add-Member -MemberType NoteProperty -Name ResourceAccountsForCallerId -Value $OboObjects.Userprincipalname } $QueueObject | Add-Member -MemberType NoteProperty -Name AuthorizedUsers -Value $AuthorizedUserObjects.Userprincipalname #endregion # Output Write-Progress -Id 0 -Activity $ActivityID0 -Completed Write-Output $QueueObject } end { } } } #begin process { Write-Verbose -Message "[PROCESS] $($MyInvocation.MyCommand)" [int] $private:CountID0 = [int] $private:CountID1 = 1 $StatusID0 = 'Information Gathering' #region Data gathering $CurrentOperationID0 = 'Querying Call Queues' Write-BetterProgress -Id 0 -Activity $ActivityID0 -Status $StatusID0 -CurrentOperation $CurrentOperationID0 -Step ($private:CountID0++) -Of $private:StepsID0 # Capturing no input if (-not $PSBoundParameters.ContainsKey('Name') -and -not $PSBoundParameters.ContainsKey('SearchString')) { Write-Information 'INFO: No Parameters - Listing names only. To query individual items, please provide Parameter Name or SearchString' Get-CsCallQueue @GetCsCallQueueParameters | Select-Object Name return } else { $Queues = @() switch ($PSCmdlet.ParameterSetName) { 'Name' { # Lookup Write-Verbose -Message "Parameter 'Name' - Querying unique result for each provided Name" foreach ($DN in $Name) { if ( $DN -match $script:TFMatchGuid ) { #Identity or ObjectId Write-Verbose -Message "[PROCESS] $($MyInvocation.MyCommand) - ID - '$DN'" $QueuesById = Get-CsCallQueue -Identity "$DN" @GetCsCallQueueParameters $Queues += $QueuesById } else { #Name Write-Verbose -Message "[PROCESS] $($MyInvocation.MyCommand) - Name - '$DN'" $QueuesByName = Get-CsCallQueue -NameFilter "$DN" @GetCsCallQueueParameters $QueuesByName = $QueuesByName | Where-Object Name -EQ "$DN" $Queues += $QueuesByName } } } 'Search' { # Search Write-Verbose -Message "[PROCESS] $($MyInvocation.MyCommand) - SearchString - '$SearchString'" $QueuesByString = Get-CsCallQueue -NameFilter "$SearchString" @GetCsCallQueueParameters $Queues += $QueuesByString } } # Parsing found Objects Write-Verbose -Message "[PROCESS] Processing found Queues: $($Queues.Count)" foreach ($Q in $Queues) { Write-Output (GetCallQueues -Q $Q -Detailed ($PSBoundParameters.ContainsKey('Detailed')) @Args) } } #endregion } #process end { Write-Verbose -Message "[END ] $($MyInvocation.MyCommand)" if ($PSCmdlet.PagingParameters.IncludeTotalCount) { [double]$Accuracy = 1.0 $PSCmdlet.PagingParameters.NewTotalCount($Queues, $Accuracy) } } #end } #Get-TeamsCallQueue |