Commands › Microsoft Teams
Test-CsEffectiveTenantDialPlan
Test a tenant dial plan.
Quick start script
# Test-CsEffectiveTenantDialPlan — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-MicrosoftTeams -CertificateThumbprint $thumb -ApplicationId $appId -TenantId $tenantId
# 2. Run and inspect
Test-CsEffectiveTenantDialPlan | Format-List
# 3. Export for evidence / drift tracking
Test-CsEffectiveTenantDialPlan | Export-Clixml .\CsEffectiveTenantDialPlan-$(Get-Date -Format yyyyMMdd).xmlSyntax — 2 parameter sets
Identity
Test-CsEffectiveTenantDialPlan [-DialedNumber <PhoneNumber>] [-CallerNumber <PhoneNumber>] [-Identity <UserIdParameter>] [-TenantScopeOnly]
[-Force] [-WhatIf] [-Confirm] [<CommonParameters>]EffectiveTDPName
Test-CsEffectiveTenantDialPlan -DialedNumber <PhoneNumber> [-CallerNumber <PhoneNumber>] [-EffectiveTenantDialPlanName <String>]
[-TenantScopeOnly] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]Parameters (8)
| Parameter | Type | Required | What it controls |
|---|---|---|---|
| -Confirm | SwitchParameter | The Confirm switch causes the command to pause processing, and requires confirmation to proceed. | |
| -DialedNumber | PhoneNumber | The DialedNumber parameter is the phone number to be normalized with the effective tenant dial plan. | |
| -CallerNumber | PhoneNumber | The CallerNumber parameter is the phone number assigned to the user, used to identify which effective tenant dial plan to use. | |
| -EffectiveTenantDialPlanName | String | The EffectiveTenantDialPlanName parameter is the effective tenant dial plan name in the form of TenantId_TenantDialPlan_GlobalVoiceDialPlan. | |
| -Force | SwitchParameter | The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for... | |
| -Identity | UserIdParameter | Indicates the identity of the user account to be tested against. The user's SIP address, the user's user principal name (UPN) or the user's display name can be specified. | |
| -TenantScopeOnly | SwitchParameter | Runs the test only against Tenant-level dial plans (does not take into account Service Level Dial Plans). | |
| -WhatIf | SwitchParameter | The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. |
Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.