New-CsGroupPickupUserOrbit

Reference

Module:: SkypeForBusiness

Applies to:: Skype for Business Server 2015, Skype for Business Server 2019

Use the New-CsGroupPickupUserOrbit cmdlet to assign and enable a group pickup orbit number for an Enterprise Voice user.

Syntax

New-CsGroupPickupUserOrbit
   [-User] <String>
   -Orbit <String>
   [-Confirm]
   [-Force]
   [-WhatIf]
   [<CommonParameters>]

Description

The same orbit can be assigned to multiple users. This cmdlet will throw an exception if the user is already assigned a group pickup orbit number, or if the specified orbit does not exist or is of the wrong type.

Examples

-------------------------- Example 1 --------------------------

New-CsGroupPickupUserOrbit -User sip:KenMyers@Contoso.com -Orbit "*100"

This example adds a user specified by the SIP address to the *100 orbit.

-------------------------- Example 2 --------------------------

New-CsGroupPickupUserOrbit "Ken Myers" -Orbit 2103

This example adds a user specified by display name to the 2103 orbit. 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.

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

-Orbit

Specifies the group pickup orbit number to be assigned to the user. The number must be within an orbit pickup range that was created with a type of GroupPickup. For more information on creating call park orbits, see New-CsCallParkOrbit.

Values for the Orbit parameter must match the regular expression ([*|#]?[1-9]\d{0,7})|([1-9]\d{0,8}).

Type:	String
Position:	Named
Default value:	None
Required:	True
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 assigned. 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

This cmdlet returns an instance of the Microsoft.Rtc.Management.Voice.Helpers.GroupPickup.DisplayGroupPickupUserOrbit object.