Test-CsEffectiveTenantDialPlan

Reference

Module:: MicrosoftTeamsPowerShell

Applies to:: Microsoft Teams

Use the Test-CsEffectiveTenantDialPlan cmdlet to test a tenant dial plan.

Syntax

Test-CsEffectiveTenantDialPlan
    [-DialedNumber <PhoneNumber>]
    [-Identity <UserIdParameter>]
    [-TenantScopeOnly]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Test-CsEffectiveTenantDialPlan
    -DialedNumber <PhoneNumber>
    [-EffectiveTenantDialPlanName <String>]
    [-TenantScopeOnly]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Test-CsEffectiveTenantDialPlan cmdlet normalizes the dialed number by applying the normalization rules from the effective tenant dial plan that is returned for the specified user.

Examples

-------------------------- Example 1 --------------------------

Get-CsEffectiveTenantDialPlan -Identity adelev | Test-CsEffectiveTenantDialPlan -DialedNumber 14258828080

This example gets the Identity of a dial plan that is associated with the identity of a user, and applies the retrieved tenant dial plan to normalize the dialed number.

-------------------------- Example 2 --------------------------

Test-CsEffectiveTenantDialPlan -DialedNumber 14258828080 -Identity [email protected]

This example tests the given dialed number against a specific identity.

Parameters

-Confirm

The Confirm switch causes the command to pause processing, and requires confirmation to proceed.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-DialedNumber

The DialedNumber parameter is the phone number to be normalized with the effective tenant dial plan.

Type:	PhoneNumber
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-EffectiveTenantDialPlanName

The EffectiveTenantDialPlanName parameter is the effective tenant dial plan name in the form of TenantId_TenantDialPlan_GlobalVoiceDialPlan.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-Force

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 administrative input if required.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-Identity

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.

Type:	UserIdParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-TenantScopeOnly

Runs the test only against Tenant-level dial plans (does not take into account Service Level Dial Plans).

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-WhatIf

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.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

Share via