TeamFoundationIdentityService.ReadIdentities Method (TeamFoundationRequestContext, IdentitySearchFactor, array<String , MembershipQuery, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope)
Read identities. First try IMS store, and then optionally source like AD. The actual source will be indicated by a property of the identity object itself.
Namespace: Microsoft.TeamFoundation.Framework.Server
Assembly: Microsoft.TeamFoundation.Framework.Server (in Microsoft.TeamFoundation.Framework.Server.dll)
Syntax
'Declaration
Public Function ReadIdentities ( _
requestContext As TeamFoundationRequestContext, _
searchFactor As IdentitySearchFactor, _
factorValues As String(), _
queryMembership As MembershipQuery, _
readOptions As ReadIdentityOptions, _
propertyNameFilters As IEnumerable(Of String), _
propertyScope As IdentityPropertyScope _
) As TeamFoundationIdentity()()
public TeamFoundationIdentity[][] ReadIdentities(
TeamFoundationRequestContext requestContext,
IdentitySearchFactor searchFactor,
string[] factorValues,
MembershipQuery queryMembership,
ReadIdentityOptions readOptions,
IEnumerable<string> propertyNameFilters,
IdentityPropertyScope propertyScope
)
public:
virtual array<array<TeamFoundationIdentity^>^>^ ReadIdentities(
TeamFoundationRequestContext^ requestContext,
IdentitySearchFactor searchFactor,
array<String^>^ factorValues,
MembershipQuery queryMembership,
ReadIdentityOptions readOptions,
IEnumerable<String^>^ propertyNameFilters,
IdentityPropertyScope propertyScope
) sealed
abstract ReadIdentities :
requestContext:TeamFoundationRequestContext *
searchFactor:IdentitySearchFactor *
factorValues:string[] *
queryMembership:MembershipQuery *
readOptions:ReadIdentityOptions *
propertyNameFilters:IEnumerable<string> *
propertyScope:IdentityPropertyScope -> TeamFoundationIdentity[][]
override ReadIdentities :
requestContext:TeamFoundationRequestContext *
searchFactor:IdentitySearchFactor *
factorValues:string[] *
queryMembership:MembershipQuery *
readOptions:ReadIdentityOptions *
propertyNameFilters:IEnumerable<string> *
propertyScope:IdentityPropertyScope -> TeamFoundationIdentity[][]
public final function ReadIdentities(
requestContext : TeamFoundationRequestContext,
searchFactor : IdentitySearchFactor,
factorValues : String[],
queryMembership : MembershipQuery,
readOptions : ReadIdentityOptions,
propertyNameFilters : IEnumerable<String>,
propertyScope : IdentityPropertyScope
) : TeamFoundationIdentity[][]
Parameters
- requestContext
Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationRequestContext
searchFactor
Type: Microsoft.TeamFoundation.Framework.Common.IdentitySearchFactorHow identities are specified.
factorValues
Type: array<System.String[]factorValues (by account name, etc.).
queryMembership
Type: Microsoft.TeamFoundation.Framework.Common.MembershipQueryNone, direct or expanded membership information.
readOptions
Type: Microsoft.TeamFoundation.Framework.Common.ReadIdentityOptionsreadOptions
propertyNameFilters
Type: System.Collections.Generic.IEnumerable<String>Only required when read options includes extended properties, refer Property Service API. Can be null otherwise.
propertyScope
Type: Microsoft.TeamFoundation.Framework.Common.IdentityPropertyScopeIndicates if extended properties should be read from local scope global scope, or both.
Return Value
Type: array<array<Microsoft.TeamFoundation.Framework.Server.TeamFoundationIdentity[][]
Arrays of identities. Each inner array matches corresponding search value.
Implements
.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.