Edit

Share via


Remove-CsTenantDialPlan

Use the Remove-CsTenantDialPlan cmdlet to remove a tenant dial plan.

Syntax

Default (Default)

Remove-CsTenantDialPlan
    [-Identity] <string>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Remove-CsTenantDialPlan cmdlet removes an existing tenant dial plan (also known as a location profile). Tenant dial plans provide required information to allow Enterprise Voice users to make telephone calls. The Conferencing Attendant application also uses tenant dial plans for dial-in conferencing. A tenant dial plan determines such things as which normalization rules are applied.

Removing a tenant dial plan also removes any associated normalization rules. If no tenant dial plan is assigned to an organization, the Global dial plan is used.

Examples

Example 1

Remove-CsTenantDialPlan -Identity Vt1TenantDialPlan2

This example removes the Vt1TenantDialPlan2.

Parameters

-Confirm

Applicable: Microsoft Teams

The Confirm parameter prompts you for confirmation before the command is executed.

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 tenant dial plan to remove.

Parameter properties

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

Parameter sets

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

-WhatIf

Applicable: Microsoft Teams

The WhatIf parameter describes what would happen if you executed the command, without actually executing the command.

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.

Notes

The ExternalAccessPrefix and OptimizeDeviceDialing parameters have been removed from New-CsTenantDialPlan and Set-CsTenantDialPlan cmdlet since they are no longer used. External access dialing is now handled implicitly using normalization rules of the dial plans. The Get-CsTenantDialPlan will still show the external access prefix in the form of a normalization rule of the dial plan.