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)

Syntax

'Declaration
Function ReadIdentities ( _
    searchFactor As IdentitySearchFactor, _
    searchFactorValues As String(), _
    queryMembership As MembershipQuery, _
    readOptions As ReadIdentityOptions, _
    propertyNameFilters As IEnumerable(Of String), _
    propertyScope As IdentityPropertyScope _
) As TeamFoundationIdentity()()

TeamFoundationIdentity[][] ReadIdentities(
    IdentitySearchFactor searchFactor,
    string[] searchFactorValues,
    MembershipQuery queryMembership,
    ReadIdentityOptions readOptions,
    IEnumerable<string> propertyNameFilters,
    IdentityPropertyScope propertyScope
)

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

abstract ReadIdentities : 
        searchFactor:IdentitySearchFactor * 
        searchFactorValues:string[] * 
        queryMembership:MembershipQuery * 
        readOptions:ReadIdentityOptions * 
        propertyNameFilters:IEnumerable<string> * 
        propertyScope:IdentityPropertyScope -> TeamFoundationIdentity[][] 

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

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.

.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