Edit

Share via


Get-CsEffectiveTenantDialPlan

Use the Get-CsEffectiveTenantDialPlan cmdlet to retrieve an effective tenant dial plan.

Syntax

Default (Default)

Get-CsEffectiveTenantDialPlan
    [-Identity] <UserIdParameter>
    [-OU <OUIdParameter>]
    [-ResultSize <Int32>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Get-CsEffectiveTenantDialPlan cmdlet returns information about the effective tenant dial plan in an organization. The returned effective Tenant Dial Plan contains the EffectiveTenantDialPlanName and the Normalization rules that are effective for the user while using the EnterpriseVoice features. The EffectiveTenantDialPlanName is in the form TenantGUID_GlobalVoiceDialPlan_TenantDialPlan.

Examples

Example 1

Get-CsEffectiveTenantDialPlan -Identity Vt1_User1

This example gets the effective tenant dial plan for the Vt1_User1.

Parameters

-Confirm

Applicable: Microsoft Teams

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Identity

Applicable: Microsoft Teams

The Identity parameter is the unique identifier of the user for whom to retrieve the effective tenant dial plan.

Parameter properties

Type:UserIdParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OU

Applicable: Microsoft Teams

Note: This parameter is not supported in Teams PowerShell Module version 3.0.0 or later.

The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned.

Parameter properties

Type:OUIdParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResultSize

Applicable: Microsoft Teams

Note: This parameter is not supported in Teams PowerShell Module version 3.0.0 or later.

Specifies the number of records returned by the cmdlet. The result size can be set to any whole number between 0 and 2147483647, inclusive. If set to 0, the command will run, but no data will be returned.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Applicable: Microsoft Teams

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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.