Get-CsOnlineVoiceUser

 

Topic Last Modified: 2016-04-15

Use the Get-CsOnlineVoiceUser cmdlet to retrieve a voice user's telephone number and location.

Get-CsOnlineVoiceUser [-CivicAddressId <Guid>] [-DomainController <Fqdn>] [-EnterpriseVoiceStatus <All | Enabled | Disabled>] [-ExpandLocation <SwitchParameter>] [-First <Int32>] [-Force <SwitchParameter>] [-GetFromAAD <SwitchParameter>] [-GetPendingUsers <SwitchParameter>] [-Identity <UserIdParameter>] [-LocationId <Guid>] [-NumberAssigned <SwitchParameter>] [-NumberNotAssigned <SwitchParameter>] [-PSTNConnectivity <All | Online | OnPremises>] [-SearchQuery <String>] [-Skip <Int32>] [-Tenant <Guid>]

This example uses the User Principal Name (UPN) to retrieve the location and phone number information.

Get-CsOnlineVoiceUser -Identity Ken.Myer@contoso.com

 

Parameter Required Type Description

CivicAddressId

Optional

System.Guid

Specifies the identity of the civic address that is assigned to the target users.

DomainController

Optional

Microsoft.Rtc.Management.Deploy.Fqdn

This parameter is reserved for internal Microsoft use.

EnterpriseVoiceStatus

Optional

Microsoft.Rtc.Management.Hosted.Bvd.InputEnterpriseVoiceStatus

PARAMVALUE: All | Enabled | Disabled

ExpandLocation

Optional

System.Management.Automation.SwitchParameter

PARAMVALUE: SwitchParameter

First

Optional

System.Int32

Specifies the number of users to return. The default is 100.

Force

Optional

System.Management.Automation.SwitchParameter

The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required.

GetFromAAD

Optional

System.Management.Automation.SwitchParameter

PARAMVALUE: SwitchParameter

GetPendingUsers

Optional

System.Management.Automation.SwitchParameter

PARAMVALUE: SwitchParameter

Identity

Optional

Microsoft.Rtc.Management.AD.UserIdParameter

Specifies the identity of the target user. Acceptable values include:

  • User Principal Name (UPN)

    Example: jphillips@contoso.com

  • SIPAddress

    Example: sip:jphillips@contoso.com

  • ObjectID, or GUID

    Example: 98403f08-577c-46dd-851a-f0460a13b03d

LocationId

Optional

System.Guid

Specifies the location identity of the location whose users will be returned. You can find location identifiers by using the Get-CsOnlineLisLocation cmdlet.

NumberAssigned

Optional

System.Management.Automation.SwitchParameter

If specified, the query will return users who have a phone number assigned.

NumberNotAssigned

Optional

System.Management.Automation.SwitchParameter

If specified, the query will return users who do not have a phone number assigned.

PSTNConnectivity

Optional

Microsoft.Rtc.Management.Hosted.Bvd.InputPSTNConnectivity

PARAMVALUE: All | Online | OnPremises

SearchQuery

Optional

System.String

PARAMVALUE: String

Skip

Optional

System.Int32

Specifies the number of users to skip. If you used the First parameter to return the first 50 users and wanted to get another 50, you could use -Skip 50 to avoid returning the first 50 you've already reviewed. The default is 0.

Tenant

Optional

System.Guid

This parameter is reserved for internal Microsoft use.

The cmdlet returns instances of the Deserialized.Microsoft.Rtc.Management.Hosted.Bvd.Types.LacUser object.

 
Show: