Public/ResourceAccount/LineIdentity/Get-TeamsResourceAccountLineIdentity.ps1
|
# Module: Orbit # Function: ResourceAccount Calling Line Identity # Author: David Eberhardt # Updated: 09-AUG-2021 # Status: Live function Get-TeamsResourceAccountLineIdentity { <# .SYNOPSIS Queries Calling Line Identity Objects for Resource Accounts .DESCRIPTION Get-CsCallingLineIdentity with resolving Resource Account Ids to Names and displaying the underlying Phone Number .PARAMETER Identity Required - Parameter set ID. Identifies the CsCallingLineIdentity by name. Default Parameter Set. If not specified, lists all of the type Resource .PARAMETER UserPrincipalName Required - Parameter set RA. Identifies the CsCallingLineIdentity created for a specific Resource Account .PARAMETER Filter Required. Searches for CsCallingLineIdentity by name .PARAMETER All Optional Switch. If not provided, will only display CsCallingLineIdentity Objects of the type Resource. .EXAMPLE Get-TeamsResourceAccountLineIdentity -Identity 'My Calling Line Identity' Queries a Line Identity with the Name 'My Calling Line Identity'. - Default .EXAMPLE Get-TeamsResourceAccountLineIdentity -UserPrincipalName ResourceAccount@domain.com Queries a Line Identity for the Resource Account provided and displays this Object .EXAMPLE Get-TeamsResourceAccountLineIdentity -Filter '*Calling*' Queries all Line Identities with 'Calling' in the Name. .INPUTS System.String .OUTPUTS System.Object .NOTES The Calling Line Identity is created with New-TeamsResourceAccountLineIdentity (or with New-CsCallingLineIdentity). This CmdLet queries these objects and (provided the CallingIDSubstitute is 'Resource') resolves Resource Account ID to the Display Name and displays the Resource Accounts Phone Number. https://docs.microsoft.com/en-us/powershell/module/skype/Get-cscallinglineidentity?view=skype-ps .COMPONENT TeamsResourceAccount TeamsCallingLineIdentity .FUNCTIONALITY Queries a Line identity a Resource Accounts and displays its assigned Phone Number .LINK https://github.com/DEberhardt/Orbit/tree/main/docs/Orbit.Teams/Get-TeamsResourceAccountLineIdentity.md .LINK https://github.com/DEberhardt/Orbit/tree/main/docs/about/about_Orbit.Teams.md .LINK https://github.com/DEberhardt/Orbit/tree/main/docs/ #> [CmdletBinding(DefaultParameterSetName = 'Id', ConfirmImpact = 'Low')] [Alias('Get-TeamsRAIdentity', 'Get-TeamsRACLI')] [OutputType([PSCustomObject])] param ( [Parameter(Mandatory, ValueFromPipelineByPropertyName, ParameterSetName = 'RA', HelpMessage = 'UPN of the Object to create.')] [Alias('ResourceAccount')] [ValidateScript( { If ($script:OrbitRegexUPN.isMatch($_) -or $script:OrbitRegexGuid.isMatch($_)) { $True } else { throw [System.Management.Automation.ValidationMetadataException] 'Value must be a valid UPN or ObjectId' } })] [string[]]$UserPrincipalName, [Parameter(ValueFromPipelineByPropertyName, ParameterSetName = 'Id', HelpMessage = 'Identity of the Calling Line Identity')] [AllowNull()] [string[]]$Identity, [Parameter(Mandatory, ValueFromPipelineByPropertyName, ParameterSetName = 'Filter', HelpMessage = 'Filter String for the Calling Line Identity')] [string]$Filter, [Parameter(HelpMessage = 'Will select all Caller Line Identities, not only Resource Account ones.')] [switch]$All ) begin { Show-OrbitFunctionStatus -Level Live Write-Verbose -Message "[BEGIN ] $($MyInvocation.MyCommand)" # Asserting MicrosoftTeams Connection if ( -not (Assert-MicrosoftTeamsConnection) ) { throw 'Connection to Microsoft Teams not established. Please validate connection' } # Setting Preference Variables according to Upstream settings if (-not $PSBoundParameters['Verbose']) { $VerbosePreference = $PSCmdlet.SessionState.PSVariable.GetValue('VerbosePreference') } if (-not $PSBoundParameters['Confirm']) { $ConfirmPreference = $PSCmdlet.SessionState.PSVariable.GetValue('ConfirmPreference') } if (-not $PSBoundParameters['WhatIf']) { $WhatIfPreference = $PSCmdlet.SessionState.PSVariable.GetValue('WhatIfPreference') } $DebugPreference = if (-not $PSBoundParameters['Debug']) { $PSCmdlet.SessionState.PSVariable.GetValue('DebugPreference') } else { 'Continue' } $InformationPreference = if ( $PSBoundParameters['InformationAction']) { $PSCmdlet.SessionState.PSVariable.GetValue('InformationAction') } else { 'Continue' } } #begin process { Write-Verbose -Message "[PROCESS] $($MyInvocation.MyCommand)" #region Input query and validation [System.Collections.Generic.List[object]]$CallingLineIdentities = @() switch ($PSCmdlet.ParameterSetName) { 'RA' { [System.Collections.Generic.List[object]]$ResourceAccounts = @() foreach ($UPN in $UserPrincipalName) { Write-Verbose -Message "Querying Resource Account with UserPrincipalName '$UPN'" try { $RA = Get-CsOnlineApplicationInstance -Identity "$UPN" -ErrorAction Stop -WarningAction SilentlyContinue [void]$ResourceAccounts.Add($RA) } catch { Write-Information "INFO: Resource Account '$UPN' - Not found!" } } foreach ($RA in $ResourceAccounts) { Write-Verbose -Message "Querying Calling Line Identities for Resource Account '$($RA.UserPrincipalName)'" try { $CLI = Get-CsCallingLineIdentity | Where-Object ResourceAccount -EQ $RA.ObjectId -ErrorAction Stop -WarningAction SilentlyContinue [void]$CallingLineIdentities.Add($CLI) } catch { Write-Information "INFO: Calling Line Identity '$($CLI.Identity)' - Not found!" continue } } } 'Id' { [System.Collections.Generic.List[object]]$CallingLineIdentities = @() if ($null -eq $Identity) { Write-Verbose -Message 'Querying Calling Line Identities (all)' $CLI = Get-CsCallingLineIdentity -WarningAction SilentlyContinue } else { foreach ($Id in $Identity) { Write-Verbose -Message "Querying Calling Line Identities for provided ID '$Id'" try { $CLI = Get-CsCallingLineIdentity -Identity "$Id" -WarningAction SilentlyContinue } catch { Write-Information "INFO: Calling Line Identity '$($CLI.Identity)' - Not found!" continue } } } foreach ($C in $CLI) { if ($C.CallingIDSubstitute -ne 'Resource' -and -not $All) { Write-Warning -Message "Calling Line Identity '$($C.Identity)' is not of Type 'Resource' - omiting object" continue } else { Write-Verbose -Message "Calling Line Identity '$($C.Identity)' is of Type 'Resource' - adding to list" [void]$CallingLineIdentities.Add($C) } } } 'Filter' { Write-Verbose -Message "Querying Calling Line Identities for provided FilterString '$Filter'" try { $FilteredCLIs = Get-CsCallingLineIdentity -Filter "$Filter" -WarningAction SilentlyContinue [System.Collections.Generic.List[object]]$CallingLineIdentities = @() foreach ($CLI in $FilteredCLIs) { if ($CLI.CallingIDSubstitute -ne 'Resource' -and -not $All) { Write-Warning -Message "CallingLineIdentity '$($CLI.Identity)' is not of Type 'Resource' - omiting object" continue } else { Write-Verbose -Message "CallingLineIdentity '$($CLI.Identity)' is of Type 'Resource' - adding to list" [void]$CallingLineIdentities.Add($CLI) } } } catch { Write-Information "INFO: Calling Line Identity '$Filter' - Not found!" return } } } #endregion # Processing found objects foreach ($CLI in $CallingLineIdentities) { Write-Verbose -Message "[PROCESS] $($MyInvocation.MyCommand) - Processing CLI: '$($CLI.Identity)'" try { if (-not $CLI.ResourceAccount) { if ( $All ) { Write-Warning -Message "CLI Object '$($CLI.Identity)' is not of type Resource." } else { throw "CLI Object '$($CLI.Identity)' does not have a Resource Account assigned!" } } else { $ResourceAccount = Get-TeamsResourceAccount $CLI.ResourceAccount -ErrorAction Stop # Validating Resource Account Settings # Check for Line URI - only allow if PhoneNumber is set! if ( -not $ResourceAccount.PhoneNumber ) { Write-Warning -Message "CLI Object '$($CLI.Identity)' Resource Account '$($ResourceAccount.UserPrincipalName)' does not have a Phone Number assigned." } # Check for OVP - if not set, write warning if ( -not $ResourceAccount.OnlineVoiceRoutingPolicy ) { Write-Warning -Message "CLI Object '$($CLI.Identity)' Resource Account '$($ResourceAccount.UserPrincipalName)' does not have an OnlineVoiceRoutingPolicy assigned." } if ( -not $ResourceAccount.AssociatedTo ) { Write-Warning -Message "CLI Object '$($CLI.Identity)' Resource Account '$($ResourceAccount.UserPrincipalName)' is currently not associated with a Call Queue or Auto Attendant!" } } } catch { Write-Error -Message "Error querying Resource Account: $_" } # creating new PS Object (synchronous with Get and Set) $CLIObject = [PSCustomObject][ordered]@{ PSTypeName = 'PowerShell.TeamsFunctsions.ResourceAccount.CallingLineIdentity' Identity = $CLI.Identity Description = $CLI.Description CallingIDSubstitute = $CLI.CallingIDSubstitute EnableUserOverride = $CLI.EnableUserOverride BlockIncomingPstnCallerID = $CLI.BlockIncomingPstnCallerID CompanyName = $CLI.CompanyName ResourceAccountDisplayName = $ResourceAccount.DisplayName ResourceAccount = $ResourceAccount.UserPrincipalName PhoneNumberType = $ResourceAccount.PhoneNumberType PhoneNumber = $ResourceAccount.PhoneNumber OnlineVoiceRoutingPolicy = $ResourceAccount.OnlineVoiceRoutingPolicy } Write-Output $CLIObject } } #process end { Write-Verbose -Message "[END ] $($MyInvocation.MyCommand)" } #end } #Get-TeamsResourceAccountLineIdentity |