Public/Support/VoiceConfig/Get-TeamsTDP.ps1
|
# Module: TeamsFunctions # Function: VoiceConfig # Author: David Eberhardt # Updated: 01-JAN-2021 # Status: Live function Get-TeamsTDP { <# .SYNOPSIS Lists all Tenant Dial Plans by Name .DESCRIPTION To quickly find Tenant Dial Plans to assign, an Alias-Function to Get-CsTenantDialPlan .PARAMETER Identity If provided, acts as an Alias to Get-CsTenantDialPlan, listing one Dial Plan If not provided, lists Identities of all Tenant Dial Plans (except "Global") .EXAMPLE Get-TeamsTDP Returns the Object for all Tenant Dial Plans (except "Global") Behaviour like: Get-CsTenantDialPlan, showing only a few Parameters (no Normalization Rules) .EXAMPLE Get-TeamsTDP -Identity DP-HUN Lists Tenant Dial Plan DP-HUN as Get-CsTenantDialPlan does. .EXAMPLE Get-TeamsTDP -Identity DP-HUN* Lists all Tenant Dials that contain the strign "*DP-HUN*" in the Name. .INPUTS None System.String .OUTPUTS System.Object .NOTES This script is indulging the lazy admin. It behaves like Get-CsTenantDialPlan with a twist: If used without Parameter, a reduced set of Parameters are shown for better visibility: Without parameters, it executes the following string: Get-CsTenantDialPlan | Where-Object Identity -NE "Global" | Select-Object Identity, SimpleName, OptimizeDeviceDialing, Description .COMPONENT SupportingFunction VoiceConfiguration .FUNCTIONALITY Queries Tenant Dial Plans from the Tenant .LINK https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/Get-TeamsTDP.md .LINK https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/about_VoiceConfiguration.md .LINK https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/about_Supporting_Functions.md .LINK https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/ #> [CmdletBinding()] param ( [Parameter(Position = 0, ValueFromPipeline, ValueFromPipelineByPropertyName, ParameterSetName = 'Identity', HelpMessage = 'Name of the Tenant Dial Plan')] [ArgumentCompleter({ &$global:TfAcSbTenantDialPlan })] [string]$Identity ) begin { Show-FunctionStatus -Level Live Write-Verbose -Message "[BEGIN ] $($MyInvocation.MyCommand)" Write-Verbose -Mess"Need help? Online: $global:TeamsFunctionsHelpURLBase$($MyInvocation.MyCommand)`.md" # Asserting MicrosoftTeams Connection if ( -not (Assert-MicrosoftTeamsConnection) ) { break } } #begin process { Write-Verbose -Message "[PROCESS] $($MyInvocation.MyCommand)" if ($PSBoundParameters.ContainsKey('Identity')) { Write-Verbose -Message "Finding Tenant Dial Plans with Identity '$Identity'" if ($Identity -match [regex]::Escape('*')) { $Filtered = Get-CsTenantDialPlan -WarningAction SilentlyContinue -Filter "*$Identity*" -ErrorAction $ErrorActionPreference } else { $Filtered = Get-CsTenantDialPlan -WarningAction SilentlyContinue -Identity "Tag:$Identity" -ErrorAction $ErrorActionPreference } } else { Write-Verbose -Message 'Finding Tenant Dial Plan Names' $Filtered = Get-CsTenantDialPlan -ErrorAction $ErrorActionPreference | Where-Object Identity -NE 'Global' } if ( $Filtered.Count -gt 3) { $Filtered = $Filtered | Select-Object Identity, SimpleName, OptimizeDeviceDialing, Description } return $Filtered | Sort-Object Identity } #process end { Write-Verbose -Message "[END ] $($MyInvocation.MyCommand)" } #end } #Get-TeamsTDP |