Remove-CsGroupPickupUserOrbit
Use the Remove-CsGroupPickupUserOrbit cmdlet to remove the associated group pickup orbit number for an Enterprise Voice user.
This effectively disables the user for group call pickup.
Syntax
Default (Default)
Remove-CsGroupPickupUserOrbit
[-User] <String>
[-Confirm]
[-Force]
[-WhatIf]
[<CommonParameters>]
Description
This cmdlet will throw an exception if the user does not have an assigned group pickup orbit number.
Examples
Example 1
Remove-CsGroupPickupUserOrbit sip:ken.myer@contoso.com
This example removes the group pickup orbit number and disables group pickup for a user specified by the SIP address. User is a positional parameter. The first parameter after the cmdlet is assumed to be the User parameter value.
Parameters
-Confirm
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
Prompts you for confirmation before executing the command.
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 |
-Force
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
Suppresses the display of any non-fatal error messages and completes the cmdlet operation.
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 |
-User
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
Specifies the user whose group pickup orbit number will be removed. Because User is a positional parameter, the -User syntax is not required. The first parameter after the cmdlet is assumed to be the User parameter value.
Users can be specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). You can also reference a user account by using the user's Active Directory distinguished name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | DisplayName, SipAddress, Identity |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-WhatIf
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
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.
Inputs
System.String
This cmdlet supports pipelined input from the Get-CsUser cmdlet.