Get-CsOnlineDirectoryUser

 

Topic Last Modified: 2015-07-27

Use the Get-CsOnlineDirectoryUser cmdlet to retrieve a user from the Business Voice Directory.

Get-CsOnlineDirectoryUser -Identity <UserIdParameter> [-DomainController <Fqdn>] [-Force <SwitchParameter>] [-Tenant <Guid>]

This example retrieves the Business Voice Directory information by specifying the user's SMTP address.

Get-CsOnlineDirectoryUser -Identity Ken.Myer@adatum.biz

Following is an example of the Get-CsOnlineDirectoryUser cmdlet's console output.

PS C:\Windows\system32> Get-CsOnlineDirectoryUser -Identity Ken.Myer@adatum.biz


RunspaceId : 1374aa93-75c4-4679-b765-6efc22f97563
Name       : bfc316ab-761c-412e-bc61-82e463d9eec1
Id         : bfc316ab-761c-412e-bc61-82e463d9eec1
SipDomain  : adatum.biz
DataCenter : BN1
TenantId   : 7a205197-8e59-487d-b9fa-3fc1b108f1e5
Number     :
Pin        :

 

Parameter Required Type Description

Identity

Required

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

  • GUID

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

DomainController

Optional

Microsoft.Rtc.Management.Deploy.Fqdn

Specifies the domain controller that's used by the cmdlet to read or write the specified data. Valid inputs for this parameter are either the fully qualified domain name (FQDN) or the computer name.

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.

Tenant

Optional

System.Guid

Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308". You can find your tenant ID by running this command: Get-CsTenant | Select-Object DisplayName, TenantID

The cmdlet returns an instance of a Deserialized.Microsoft.Rtc.Management.Hosted.Bvd.Types.LacUser object.

 
Show: