Get-LinkedUser

 

Applies to: Exchange Online

This cmdlet is available only in the cloud-based service.

Use the Get-LinkedUser cmdlet to view existing linked user accounts.

For information about the parameter sets in the Syntax section below, see Syntax.

Get-LinkedUser [-Identity <UserIdParameter>] <COMMON PARAMETERS>

Get-LinkedUser [-Anr <String>] <COMMON PARAMETERS>

COMMON PARAMETERS: [-Filter <String>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ResultSize <Unlimited>] [-SortBy <String>]

This example lists all linked users in the organization.

Get-LinkedUser

This example returns a detailed information for the linked for the user laura@contoso.com.

Get-RemoteMailbox -Identity laura@contoso.com | Format-List

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Linked user" entry in the Feature permissions in Exchange Online topic.

 

Parameter Required Type Description

Anr

Optional

System.String

The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are:

  • CommonName (CN)

  • DisplayName

  • FirstName

  • LastName

  • Alias

Filter

Optional

System.String

The Filter parameter uses OPATH filter syntax to filter the results by the specified properties and values. The search criteria uses the syntax {<Property> -<Comparison operator> '<Value>'}.

  • <Property> is a filterable property.

  • -<Comparison Operator> is an OPATH comparison operator. For example -eq for equals and -like for string comparison. For more information about comparison operators, see about_Comparison_Operators.

  • <Value> is the property value. Values that aren't integers need to be enclosed in quotation marks ('Value').

You can chain multiple search criteria together using the logical operators -and and -or. For example, {<Criteria1>) -and <Criteria2>} or {(<Criteria1> -and <Criteria2>) -or <Criteria3>}.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.UserIdParameter

The Identity parameter specifies the linked user that you want to view. You can use any value that uniquely identifies the linked user.

For example:

  • Name

  • Display name

  • Distinguished name (DN)

  • Canonical DN

  • GUID

OrganizationalUnit

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

This parameter is reserved for internal Microsoft use.

ResultSize

Optional

Microsoft.Exchange.Data.Unlimited

The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.

SortBy

Optional

System.String

The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order.

If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto <Property1>,<Property2>... to create a new view that contains all of the properties that you want to see. Wildcards (*) in the property names are supported.

You can sort by the following properties:

  • Name

  • DisplayName

  • City

  • FirstName

  • LastName

  • Office

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

 
Show: