This documentation is archived and is not being maintained.

IIdentityManagementService2::ReadIdentities Method (IdentitySearchFactor, array<String>, MembershipQuery, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope)

Read identities based on search factor. First read from IMS store, and then optionally read from a source like Active Directory.

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

array<array<TeamFoundationIdentity^>^>^ ReadIdentities(
	IdentitySearchFactor searchFactor, 
	array<String^>^ searchFactorValues, 
	MembershipQuery queryMembership, 
	ReadIdentityOptions readOptions, 
	IEnumerable<String^>^ propertyNameFilters, 
	IdentityPropertyScope propertyScope
)

Parameters

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

How search is specified by account name, and so on.

searchFactorValues
Type: array<System::String>

Actual search strings, such as account names, and so on.

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<array<Microsoft.TeamFoundation.Framework.Client::TeamFoundationIdentity>>
Arrays of identities. Inner array corresponds 1 to 1 with search factor values.

Show: