TeamFoundationIdentityService.ReadIdentities Method (TeamFoundationRequestContext, array<Guid , MembershipQuery, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope)

Read identities by Team Foundation Id.

Note - performs FASTEST when no membership information is requested.

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

Syntax

'Declaration
Public Function ReadIdentities ( _
    requestContext As TeamFoundationRequestContext, _
    teamFoundationIds As Guid(), _
    queryMembership As MembershipQuery, _
    readOptions As ReadIdentityOptions, _
    propertyNameFilters As IEnumerable(Of String), _
    propertyScope As IdentityPropertyScope _
) As TeamFoundationIdentity()

public TeamFoundationIdentity[] ReadIdentities(
    TeamFoundationRequestContext requestContext,
    Guid[] teamFoundationIds,
    MembershipQuery queryMembership,
    ReadIdentityOptions readOptions,
    IEnumerable<string> propertyNameFilters,
    IdentityPropertyScope propertyScope
)

public:
virtual array<TeamFoundationIdentity^>^ ReadIdentities(
    TeamFoundationRequestContext^ requestContext, 
    array<Guid>^ teamFoundationIds, 
    MembershipQuery queryMembership, 
    ReadIdentityOptions readOptions, 
    IEnumerable<String^>^ propertyNameFilters, 
    IdentityPropertyScope propertyScope
) sealed

abstract ReadIdentities : 
        requestContext:TeamFoundationRequestContext * 
        teamFoundationIds:Guid[] * 
        queryMembership:MembershipQuery * 
        readOptions:ReadIdentityOptions * 
        propertyNameFilters:IEnumerable<string> * 
        propertyScope:IdentityPropertyScope -> TeamFoundationIdentity[] 
override ReadIdentities : 
        requestContext:TeamFoundationRequestContext * 
        teamFoundationIds:Guid[] * 
        queryMembership:MembershipQuery * 
        readOptions:ReadIdentityOptions * 
        propertyNameFilters:IEnumerable<string> * 
        propertyScope:IdentityPropertyScope -> TeamFoundationIdentity[] 

public final function ReadIdentities(
    requestContext : TeamFoundationRequestContext, 
    teamFoundationIds : Guid[], 
    queryMembership : MembershipQuery, 
    readOptions : ReadIdentityOptions, 
    propertyNameFilters : IEnumerable<String>, 
    propertyScope : IdentityPropertyScope
) : TeamFoundationIdentity[]

Parameters

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

• teamFoundationIds
  Type: array<System.Guid[]

  Ids

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

  None, direct or expanded membership information.

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

  readOptions

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

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

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

Return Value

Type: array<Microsoft.TeamFoundation.Framework.Server.TeamFoundationIdentity[]
Array of identities, corresponding 1-to-1 with input array.

Implements

ITeamFoundationIdentityService.ReadIdentities(TeamFoundationRequestContext, array<Guid[], MembershipQuery, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope)

.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

TeamFoundationIdentityService Class

ReadIdentities Overload

Microsoft.TeamFoundation.Framework.Server Namespace