IIdentityManagementService.ReadIdentity Method (IdentityDescriptor, MembershipQuery, ReadIdentityOptions)

Overload that takes a single descriptor.

Read identity for given descriptor. First try IMS store. If not found, optionally try source like AD.

Note - performance will be fastest when no membership information is requested.

Namespace:  Microsoft.TeamFoundation.Framework.Client
Assembly:  Microsoft.TeamFoundation.Client (in Microsoft.TeamFoundation.Client.dll)

Syntax

'Declaration
Function ReadIdentity ( _
    descriptor As IdentityDescriptor, _
    queryMembership As MembershipQuery, _
    readOptions As ReadIdentityOptions _
) As TeamFoundationIdentity

TeamFoundationIdentity ReadIdentity(
    IdentityDescriptor descriptor,
    MembershipQuery queryMembership,
    ReadIdentityOptions readOptions
)

TeamFoundationIdentity^ ReadIdentity(
    IdentityDescriptor^ descriptor, 
    MembershipQuery queryMembership, 
    ReadIdentityOptions readOptions
)

abstract ReadIdentity : 
        descriptor:IdentityDescriptor * 
        queryMembership:MembershipQuery * 
        readOptions:ReadIdentityOptions -> TeamFoundationIdentity

function ReadIdentity(
    descriptor : IdentityDescriptor, 
    queryMembership : MembershipQuery, 
    readOptions : ReadIdentityOptions
) : TeamFoundationIdentity

Parameters

• descriptor
  Type: Microsoft.TeamFoundation.Framework.Client.IdentityDescriptor

  identity type + identifier

• queryMembership
  Type: Microsoft.TeamFoundation.Framework.Common.MembershipQuery

  none, direct or expanded membership information

• readOptions
  Type: Microsoft.TeamFoundation.Framework.Common.ReadIdentityOptions

  read options, such as reading from source

Return Value

Type: Microsoft.TeamFoundation.Framework.Client.TeamFoundationIdentity
identity if found, else null

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

IIdentityManagementService Interface

ReadIdentity Overload

Microsoft.TeamFoundation.Framework.Client Namespace