Edit

Grant-CsTenantDialPlan

  • Reference
Module:
MicrosoftTeamsPowerShell
Applies to:
Microsoft Teams

Use the Grant-CsTenantDialPlan cmdlet to assign an existing tenant dial plan to a user, to a group of users, or to set the Global policy instance.

Syntax

Grant-CsTenantDialPlan
     [[-PolicyName] <string>]
     [-Global]
     [-PassThru]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Grant-CsTenantDialPlan
     [-Group] <string>
     [[-PolicyName] <string>]
     [-PassThru]
     [-Rank <int>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Grant-CsTenantDialPlan
     [[-Identity] <string>]
     [[-PolicyName] <string>]
     [-PassThru]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

The Grant-CsTenantDialPlan cmdlet assigns an existing tenant dial plan to a user, a group of users, or sets the Global policy instance. Tenant dial plans provide information that is required for Enterprise Voice users to make telephone calls. Users who do not have a valid tenant dial plan cannot make calls by using Enterprise Voice. A tenant dial plan determines such things as how normalization rules are applied.

You can check whether a user has been granted a per-user tenant dial plan by calling a command in this format: Get-CsUserPolicyAssignment -Identity "<user name>" -PolicyType TenantDialPlan.

Examples

Example 1

Grant-CsTenantDialPlan -PolicyName Vt1tenantDialPlan9 -Identity Ken.Myer@contoso.com

This example grants the Vt1tenantDialPlan9 dial plan to Ken.Meyer@contoso.com.

Example 2

Grant-CsTenantDialPlan -Identity Ken.Myer@contoso.com -PolicyName $Null

In Example 2, any dial plan previously assigned to the user Ken Myer is unassigned from that user; as a result, Ken Myer will be managed by the global dial plan. To unassign a custom tenant dial plan, set the PolicyName to a null value ($Null).

Example 3

Grant-CsTenantDialPlan -Group sales@contoso.com -Rank 10 -PolicyName Vt1tenantDialPlan9

This example grants the Vt1tenantDialPlan9 dial plan to members of the group sales@contoso.com.

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

-Global

Sets the parameters of the Global policy instance to the values in the specified policy instance.

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

-Group

Specifies the group used for the group policy assignment.

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

-Identity

The Identity parameter identifies the user to whom the policy should be assigned.

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

-PassThru

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

-PolicyName

The PolicyName parameter is the name of the tenant dial plan to be assigned.

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

-Rank

The rank of the policy assignment, relative to other group policy assignments for the same policy type.

Type:Int32
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

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.