This documentation is archived and is not being maintained.

IIdentityManagementService2::ReadIdentity Method (IdentityDescriptor, MembershipQuery, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope)

Overload that takes a single descriptor.

Read identity for given descriptor. First try IMS store. If it is 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)

TeamFoundationIdentity^ ReadIdentity(
	IdentityDescriptor^ descriptor, 
	MembershipQuery queryMembership, 
	ReadIdentityOptions readOptions, 
	IEnumerable<String^>^ propertyNameFilters, 
	IdentityPropertyScope propertyScope
)

Parameters

descriptor
Type: Microsoft.TeamFoundation.Framework.Client::IdentityDescriptor

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: Microsoft.TeamFoundation.Framework.Client::TeamFoundationIdentity
Identity if found; or else null.

Show: