Get-CsOnlineVoiceUser

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

Syntax

Get-CsOnlineVoiceUser
   [-CivicAddressId <XdsCivicAddressId>]
   [-DomainController <Fqdn>]
   [-EnterpriseVoiceStatus <MultiValuedProperty>]
   [-ExpandLocation]
   [-First <Unlimited>]
   [-Force]
   [-GetFromAAD]
   [-GetPendingUsers]
   [-Identity <UserIdParameter>]
   [-LocationId <LocationID>]
   [-NumberAssigned]
   [-NumberNotAssigned]
   [-PSTNConnectivity <MultiValuedProperty>]
   [-SearchQuery <String>]
   [-Skip <Unlimited>]
   [-Tenant <Guid>]
   [<CommonParameters>]

Description

Note: This cmdlet will be deprecated. You should start using the replacement cmdlets described here as soon as possible.

The following table lists the parameters to Get-CsOnlineVoiceUser and the alternative method of getting the same data using a combination of Get-CsOnlineUser, Get-CsPhoneNumberAssignment, Get-CsOnlineLisLocation, and Get-CsOnlineLisCivicAddress.

Parameter Description Alternative
No parameters Get information for all users Get-CsOnlineUser -Filter {(FeatureTypes -contains 'PhoneSystem') -and (AccountEnabled -eq $True)} -AccountType User
CivicAddressId Find phone number information where the assigned phone number is associated with the CivicAddressId Get-CsPhoneNumberAssignment -CivicAddressId <CivicAddressId>
EnterpriseVoiceStatus Find enabled users based on EnterpriseVoiceEnabled Get-CsOnlineUser -Filter {(EnterpriseVoiceEnabled -eq $True) -and (FeatureTypes -contains 'PhoneSystem') -and (AccountEnabled -eq $True)} -AccountType User or Get-CsOnlineUser -Filter {(EnterpriseVoiceEnabled -eq $False) -and (FeatureTypes -contains 'PhoneSystem') -and (AccountEnabled -eq $True)} -AccountType User
ExpandLocation Show information about the LocationId Get-CsOnlineLisLocation -LocationId <LocationId>
Identity Get information for a user Get-CsOnlineUser -Identity <Identity>
LocationId Find phone number information where the assigned phone number is associated with the LocationId Get-CsPhoneNumberAssignment -LocationId <LocationId>
NumberAssigned Find enabled users with a phone number assigned Get-CsOnlineUser -Filter {(LineUri -ne $Null) -and (FeatureTypes -contains 'PhoneSystem') -and (AccountEnabled -eq $True)} -AccountType User
NumberNotAssigned Find users without a phone number assigned Get-CsOnlineUser -Filter {(LineUri -eq $Null) -and (FeatureTypes -contains 'PhoneSystem') -and (AccountEnabled -eq $True)} -AccountType User
PSTNConnectivity Find enabled users with PhoneSystem (OnPremises) or CallingPlan (Online) Online: Get-CsOnlineUser -Filter {(FeatureTypes -contains 'CallingPlan') -and (AccountEnabled -eq $True)} -AccountType User OnPremises: Get-CsOnlineUser -Filter {-not (FeatureTypes -contains 'CallingPlan') -and (FeatureTypes -contains 'PhoneSystem') -and (AccountEnabled -eq $True)} -AccountType User

The following table lists the output fields from Get-CsOnlineVoiceUser and the alternative method of getting the same information using a combination of Get-CsOnlineUser, Get-CsPhoneNumberAssignment, and Get-CsOnlineLisLocation.

Output field Alternative
Name DisplayName in the output from Get-CsOnlineUser
Id Identity in the output from Get-CsOnlineUser
SipDomain Extract SipDomain from the SipAddress in the output from Get-CsOnlineUser
DataCenter Extract DataCenter from RegistrarPool in the output from Get-CsOnlineUser
TenantId TenantId in the output from Get-CsOnlineUser
PstnConnectivity FeatureTypes in the output from Get-CsOnlineUser. If FeatureTypes contains CallingPlan, PstnConnectivity is Online. If FeatureTypes contains PhoneSystem and does not contain CallingPlan, PstnConnectivity is OnPremises
UsageLocation UsageLocation in the output from Get-CsOnlineUser
EnterpriseVoiceEnabled EnterpriseVoiceEnabled in the output from Get-CsOnlineUser
Number LineUri in the output from Get-CsOnlineUser. You can get same phone number format by doing LineUri.Replace('tel:+','')
Location Use LocationId in the output from Get-CsPhoneNumberAssignment -AssignedPstnTargetId <Identity> as the input to Get-CsOnlineLisLocation -LocationId

In Teams PowerShell Module version 3.0 and later, the following improvements have been introduced for organizations using Teams:

  • This cmdlet now accurately returns users who are voice-enabled (the older cmdlet in version 2.6.0 and earlier returned users without MCOEV* plans assigned).
  • The result size is not limited to 100 users anymore (the older cmdlet in version 2.6.0 and earlier limited the result size to 100).

In Teams PowerShell Module version 2.6.2 and later, the following attributes are deprecated for organizations with Teams users using the ExpandLocation parameter:

  • Force
  • NumberOfResultsToSkip
  • CorrelationId
  • Verb
  • ResultSize
  • LicenceState

In Teams PowerShell Module version 2.6.2 and later, the following input parameters are deprecated for organizations with Teams users due to low or zero usage:

  • DomainController
  • Force
  • GetFromAAD
  • GetPendingUsers
  • SearchQuery
  • Skip
  • Tenant
  • Common Parameters

Examples

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

PS C:\> Get-CsOnlineVoiceUser -Identity Ken.Myer@contoso.com

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

Parameters

-CivicAddressId

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

Type:XdsCivicAddressId
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online

-DomainController

This parameter is reserved for internal Microsoft use.

Type:Fqdn
Aliases:DC
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online

-EnterpriseVoiceStatus

Possible values are:

  • All
  • Enabled
  • Disabled
Type:MultiValuedProperty
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online

-ExpandLocation

Displays the location parameter with its value.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online

-First

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

Type:Unlimited
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online

-Force

This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage.

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.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online

-GetFromAAD

This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage.

Use this switch to get the users from Azure Active Directory.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online

-GetPendingUsers

This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage.

Use this switch to get only the users in pending state.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online

-Identity

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

Example: jphillips@contoso.com

Example: sip:jphillips@contoso.com

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

Type:UserIdParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online

-LocationId

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

Type:LocationID
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online

-NumberAssigned

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

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online

-NumberNotAssigned

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

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online

-PSTNConnectivity

Possible values are:

  • All
  • Online
  • OnPremises
Type:MultiValuedProperty
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online

-SearchQuery

This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage.

The SearchQuery parameter specifies a search string or a query formatted using Keyword Query Language (KQL). For more details about KQL, see Keyword Query Language syntax reference (https://go.microsoft.com/fwlink/p/?linkid=269603).

If this parameter is empty, all users are returned.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online

-Skip

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.

Type:Unlimited
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online

-Tenant

This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage.

This parameter is reserved for internal Microsoft use.

Type:Guid
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online

Inputs

None

Outputs

Deserialized.Microsoft.Rtc.Management.Hosted.Bvd.Types.LacUser