Grant-CsCallingLineIdentity
Use the Grant-CsCallingLineIdentity cmdlet to apply a Caller ID policy to a user account, to a group of users, or to set the tenant Global instance.
Syntax
GrantToTenant (Default)
Grant-CsCallingLineIdentity
[[-PolicyName] <string>]
[-Global]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
GrantToGroup
Grant-CsCallingLineIdentity
[-Group] <string>
[[-PolicyName] <string>]
[-PassThru]
[-Rank <int>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Identity
Grant-CsCallingLineIdentity
[[-Identity] <string>]
[[-PolicyName] <string>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
You can either assign a Caller ID policy to a specific user, to a group of users, or you can set the Global policy instance.
Examples
Example 1
PS C:\> Grant-CsCallingLineIdentity -Identity Ken.Myer@contoso.com -PolicyName CallerIDRedmond
This example assigns the Caller ID policy with the Identity CallerIDRedmond to the user Ken.Myer@contoso.com
Example 2
Grant-CsCallingLineIdentity -PolicyName CallerIDSeattle -Global
This example copies the Caller ID policy CallerIDSeattle to the Global policy instance.
Example 3
Grant-CsCallingLineIdentity -Group sales@contoso.com -PolicyName CallerIDSeattle -Rank 10
This example assigns the Caller ID policy with the Identity CallerIDSeattle to the members of the group sales@contoso.com.
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 |
-Global
Applicable: Microsoft Teams
Sets the parameters of the Global policy instance to the values in the specified policy instance.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(GrantToTenant)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Group
Applicable: Microsoft Teams
Specifies the group used for the group policy assignment.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GrantToGroup
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
Applicable: Microsoft Teams
The Identity of the user to whom the policy is being assigned. User Identities can be specified using the user's SIP address, the user's user principal name (UPN), or the user's ObjectId/Identity.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(Identity)
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PassThru
Applicable: Microsoft Teams
Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsCallingLineIdentity cmdlet does not pass objects through the pipeline.
Parameter properties
| Type: | SwitchParameter |
| 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 |
-PolicyName
Applicable: Microsoft Teams
The name (Identity) of the Caller ID policy to be assigned. To remove an existing user level policy assignment, specify PolicyName as $null.
Parameter properties
| Type: | String |
| 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 |
-Rank
Applicable: Microsoft Teams
The rank of the policy assignment, relative to other group policy assignments for the same policy type.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GrantToGroup
| 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.
Notes
The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or later.