Edit

Share via


Get-CsGroupPickupUserOrbit

Use the Get-CsGroupPickupUserOrbit cmdlet to get the group pickup orbit number for an Enterprise Voice user.

Syntax

Default (Default)

Get-CsGroupPickupUserOrbit
    [-User] <String>
    [-Force]
    [<CommonParameters>]

Examples

Example 1

Get-CsGroupPickupUserOrbit -User sip:ken.myer@contoso.com

The following example gets the group pickup orbit number of a user specified by SIP address.

Example 2

Get-CsGroupPickupUserOrbit "Ken Myer"

The following example gets the group pickup orbit number by using the display name. User is a positional parameter. The first parameter after the cmdlet is assumed to be the User parameter value.

Example 3

Get-CsUser "Ken Myer" | Get-CsGroupPickupUserOrbit

The following example gets the group pickup orbit numbers by piping the output of Get-CsUser to the Get-CsGroupPickupUserOrbit.

Parameters

-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 retrieved. 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

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

Get-CsUser

Outputs

Microsoft.Rtc.Management.Voice.Helpers.GroupPickup.DisplayGroupPickupUserOrbit