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
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
Prompts you for confirmation before executing the command.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Skype for Business Server 2015, Skype for Business Server 2019 |
-Force
Suppresses the display of any non-fatal error messages and completes the cmdlet operation.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Skype for Business Server 2015, Skype for Business Server 2019 |
-User
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.
Type: | String |
Aliases: | DisplayName, SipAddress, Identity |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | Skype for Business Server 2015, Skype for Business Server 2019 |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Skype for Business Server 2015, Skype for Business Server 2019 |
Inputs
This cmdlet supports pipelined input from the Get-CsUser cmdlet.
Outputs
None.