ITeamFoundationIdentityService.ReadIdentities Method (TeamFoundationRequestContext, array<IdentityDescriptor , MembershipQuery, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope)

Reads identities for given descriptors. First try IMS store. If not found, optionally try source like AD. The actual source will be indicated by a property of the identity object itself. Note - performs FASTEST when no membership information is requested.

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

Syntax

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

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

array<TeamFoundationIdentity^>^ ReadIdentities(
    TeamFoundationRequestContext^ requestContext, 
    array<IdentityDescriptor^>^ descriptors, 
    MembershipQuery queryMembership, 
    ReadIdentityOptions readOptions, 
    IEnumerable<String^>^ propertyNameFilters, 
    IdentityPropertyScope propertyScope
)

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

function ReadIdentities(
    requestContext : TeamFoundationRequestContext, 
    descriptors : IdentityDescriptor[], 
    queryMembership : MembershipQuery, 
    readOptions : ReadIdentityOptions, 
    propertyNameFilters : IEnumerable<String>, 
    propertyScope : IdentityPropertyScope
) : TeamFoundationIdentity[]

Parameters

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

  The context for this request.

• descriptors
  Type: array<Microsoft.VisualStudio.Services.Identity.IdentityDescriptor[]

  The descriptors.

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

  None, direct or expanded membership information.

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

  The read options.

• 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.Server.Core.TeamFoundationIdentity[]
Array of identities, corresponding 1 to 1 with input array.

.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

ITeamFoundationIdentityService Interface

ReadIdentities Overload

Microsoft.TeamFoundation.Server.Core Namespace