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

Read identities for given descriptors. First try information management system (IMS) store. If not found, optionally try a source like Active Directory.

Note that 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 ReadIdentities ( _
    descriptors As IdentityDescriptor(), _
    queryMembership As MembershipQuery, _
    readOptions As ReadIdentityOptions, _
    propertyNameFilters As IEnumerable(Of String), _
    propertyScope As IdentityPropertyScope _
) As TeamFoundationIdentity()

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

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

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

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

Parameters

• descriptors
  Type: array<Microsoft.TeamFoundation.Framework.Client.IdentityDescriptor[]

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

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

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

Return Value

Type: array<Microsoft.TeamFoundation.Framework.Client.TeamFoundationIdentity[]
Array of identities, corresponding 1 to 1 with input descriptor 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

IIdentityManagementService2 Interface

ReadIdentities Overload

Microsoft.TeamFoundation.Framework.Client Namespace