TeamFoundationIdentityService.ReadIdentity Method (TeamFoundationRequestContext, IdentitySearchFactor, String, MembershipQuery, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope)

Article
11/19/2013

Overload that takes a single search factor and returns match following this order.

1. When there is no match, null.

2. When there is a single match, that identity regardless of whether the identity is active.

3. When there is a single active identity match, that identity.

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

Syntax

'Declaration
Public Function ReadIdentity ( _
    requestContext As TeamFoundationRequestContext, _
    searchFactor As IdentitySearchFactor, _
    factorValue As String, _
    queryMembership As MembershipQuery, _
    readOptions As ReadIdentityOptions, _
    propertyNameFilters As IEnumerable(Of String), _
    propertyScope As IdentityPropertyScope _
) As TeamFoundationIdentity

public TeamFoundationIdentity ReadIdentity(
    TeamFoundationRequestContext requestContext,
    IdentitySearchFactor searchFactor,
    string factorValue,
    MembershipQuery queryMembership,
    ReadIdentityOptions readOptions,
    IEnumerable<string> propertyNameFilters,
    IdentityPropertyScope propertyScope
)

public:
virtual TeamFoundationIdentity^ ReadIdentity(
    TeamFoundationRequestContext^ requestContext, 
    IdentitySearchFactor searchFactor, 
    String^ factorValue, 
    MembershipQuery queryMembership, 
    ReadIdentityOptions readOptions, 
    IEnumerable<String^>^ propertyNameFilters, 
    IdentityPropertyScope propertyScope
) sealed

abstract ReadIdentity : 
        requestContext:TeamFoundationRequestContext * 
        searchFactor:IdentitySearchFactor * 
        factorValue:string * 
        queryMembership:MembershipQuery * 
        readOptions:ReadIdentityOptions * 
        propertyNameFilters:IEnumerable<string> * 
        propertyScope:IdentityPropertyScope -> TeamFoundationIdentity  
override ReadIdentity : 
        requestContext:TeamFoundationRequestContext * 
        searchFactor:IdentitySearchFactor * 
        factorValue:string * 
        queryMembership:MembershipQuery * 
        readOptions:ReadIdentityOptions * 
        propertyNameFilters:IEnumerable<string> * 
        propertyScope:IdentityPropertyScope -> TeamFoundationIdentity

public final function ReadIdentity(
    requestContext : TeamFoundationRequestContext, 
    searchFactor : IdentitySearchFactor, 
    factorValue : String, 
    queryMembership : MembershipQuery, 
    readOptions : ReadIdentityOptions, 
    propertyNameFilters : IEnumerable<String>, 
    propertyScope : IdentityPropertyScope
) : TeamFoundationIdentity

Parameters

requestContext
Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationRequestContext

searchFactor
Type: Microsoft.TeamFoundation.Framework.Common.IdentitySearchFactor

factorValue
Type: System.String

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

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

propertyNameFilters
Type: System.Collections.Generic.IEnumerable<String>

Only required when read options includes extended properties, refer Property Service API. Can be null otherwise.

propertyScope
Type: Microsoft.TeamFoundation.Framework.Common.IdentityPropertyScope

Return Value

Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationIdentity
Returns TeamFoundationIdentity.

Implements

ITeamFoundationIdentityService.ReadIdentity(TeamFoundationRequestContext, IdentitySearchFactor, String, MembershipQuery, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope)

Exceptions

Exception	Condition
MultipleIdentitiesFoundException	Thrown when there are multiple matches, unless exactly one identity is active.

.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.