Set-CsTenantDialPlan
Use the Set-CsTenantDialPlan cmdlet to modify an existing tenant dial plan.
Syntax
Set-CsTenantDialPlan
[-Tenant <Guid>]
[-Description <String>]
[-NormalizationRules <List>]
[-ExternalAccessPrefix <String>]
[-SimpleName <String>]
[-OptimizeDeviceDialing <Boolean>]
[[-Identity] <XdsIdentity>]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-CsTenantDialPlan
[-Tenant <Guid>]
[-Description <String>]
[-NormalizationRules <List>]
[-ExternalAccessPrefix <String>]
[-SimpleName <String>]
[-OptimizeDeviceDialing <Boolean>]
[-Instance <PSObject>]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Set-CsTenantDialPlan cmdlet modifies an existing tenant dial plan.
Tenant dial plans provide required information to let Enterprise Voice users 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 and whether a prefix must be dialed for external calls.
Although normalization rules of a tenant dial plan can be added by using this cmdlet, it is recommended that you use the New-CsVoiceNormalizationRule cmdlet instead.
Examples
-------------------------- Example 1 --------------------------
Set-CsTenantDialPlan -ExternalAccessPrefix "123" -Identity vt1tenantDialPlan9This example updates the vt1tenantDialPlan9 tenant dial plan to use an external access prefix of 123.
-------------------------- Example 2 --------------------------
$nr2 = Get-CsVoiceNormalizationRule -Identity "US/US Long Distance"
Set-CsTenantDialPlan -ExternalAccessPrefix "123" -Identity vt1tenantDialPlan9 -NormalizationRules @{Add=$nr2}This example updates the vt1tenantDialPlan9 tenant dial plan to have an external access prefix of 123 and use the US/US Long Distance normalization rules.
-------------------------- Example 3 --------------------------
$DP = Get-CsTenantDialPlan -Identity Global
$NR = $DP.NormalizationRules | Where Name -eq "RedmondFourDigit")
$NR.Name = "RedmondRule"
Set-CsTenantDialPlan -Identity Global -NormalizationRules $DP.NormalizationRulesThis example changes the name of an normalization rule.
Keep in mind that changing the name also changes the name portion of the Identity.
The Set-CsVoiceNormalizationRule cmdlet doesn't have a Name parameter, so in order to change the name, we first call the Get-CsTenantDialPlan cmdlet to retrieve the Dial Plan with the Identity Global and assign the returned object to the variable $DP. Then we filter the NormalizationRules Object for the rule RedmondFourDigit and assign the returned object to the variable $NR.
We then assign the string RedmondRule to the Name property of the object.
Finally, we pass the variable back to the NormalizationRules parameter of the Set-CsTenantDialPlan cmdlet to make the change permanent.
-------------------------- Example 4 --------------------------
$DP = Get-CsTenantDialPlan -Identity Global
$NR = $DP.NormalizationRules | Where Name -eq "RedmondFourDigit")
$DP.NormalizationRules.Remove($NR)
Set-CsTenantDialPlan -Identity Global -NormalizationRules $DP.NormalizationRulesThis example removes a normalization rule.
We utilize the same functionality as for Example 3 to manipulate the Normalization Rule Object and update it with the Set-CsTenantDialPlan cmdlet.
We first call the Get-CsTenantDialPlan cmdlet to retrieve the Dial Plan with the Identity Global and assign the returned object to the variable $DP. Then we filter the NormalizationRules Object for the rule RedmondFourDigit and assign it to the variable $NR. Next, we remove this Object with the Remove Method from $DP.NormalizationRules.
Finally, we pass the variable back to the NormalizationRules parameter of the Set-CsTenantDialPlan cmdlet to make the change permanent.
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 |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Skype for Business Online |
-Description
The Description parameter describes the tenant dial plan - what it's for, what type of user it applies to or any other information that helps to identify the purpose of the tenant dial plan. Maximum characters is 1040.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Skype for Business Online |
-ExternalAccessPrefix
The ExternalAccessPrefix parameter is a number (or set of numbers) that designates the call as external to the organization. (For example, to tenant-dial an outside line, first dial 9). This prefix is ignored by the normalization rules, although these rules will be applied to the rest of the number. The OptimizeDeviceDialing parameter must be set to True for this value to take effect.
The value of this parameter must be no longer than 4 characters long and can contain only digits, "#" or a "*".
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Skype for Business Online |
-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 |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Skype for Business Online |
-Identity
The Identity parameter is a unique identifier that designates the name of the tenant dial plan to modify.
| Type: | XdsIdentity |
| Position: | 2 |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Skype for Business Online |
-Instance
The Instance parameter allows you to pass a reference to an object to the cmdlet, rather than set individual parameter values.
You can retrieve this object reference by calling the Get-CsTenantDialPlan cmdlet.
| Type: | PSObject |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Skype for Business Online |
-NormalizationRules
The NormalizationRules parameter is a list of normalization rules that are applied to this dial plan. Although this list and these rules can be created directly by using this cmdlet, we recommend that you create the normalization rules by the New-CsVoiceNormalizationRule cmdlet, which creates the rule and assigns it to the specified tenant dial plan.
The number of normalization rules cannot exceed 50 per TenantDialPlan.
| Type: | List |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Skype for Business Online |
-OptimizeDeviceDialing
Use this parameter to determine the effect of ExternalAccessPrefix parameter. If set to True, the ExternalAccessPrefix parameter takes effect.
| Type: | Boolean |
| Position: | Named |
| Default value: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Skype for Business Online |
-SimpleName
The SimpleName parameter is a display name for the tenant dial plan. This name must be unique among all tenant dial plans.
This string can be up to 49 characters long. Valid characters are alphabetic or numeric characters, hyphen (-), dot (.) and parentheses (()).
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Skype for Business Online |
-Tenant
Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account.
For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308".
You can find your tenant ID by running this command: Get-CsTenant | Select-Object DisplayName, TenantID
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Skype for Business Online |
-WhatIf
The WhatIf parameter describes what would happen if you executed the command, without actually executing the command.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Skype for Business Online |
Feedback
Submit and view feedback for