IdentityManagementWebService.ReadIdentitiesByDescriptor Method

Read identities for given descriptors. First try IMS store. If not found, optionally try source like AD (the actual source will be indicated by a property of the identity object itself).

Note - performs FASTEST when no membership information is requested.

Namespace:  Microsoft.TeamFoundation.Framework.Server.WebServices
Assembly:  Microsoft.TeamFoundation.Framework.Server (in Microsoft.TeamFoundation.Framework.Server.dll)

Syntax

'Declaration
<WebMethodAttribute> _
Public Function ReadIdentitiesByDescriptor ( _
    descriptors As IdentityDescriptor(), _
    queryMembership As Integer, _
    options As Integer, _
    features As Integer, _
    propertyNameFilters As String(), _
    propertyScope As Integer _
) As TeamFoundationIdentity()

[WebMethodAttribute]
public TeamFoundationIdentity[] ReadIdentitiesByDescriptor(
    IdentityDescriptor[] descriptors,
    int queryMembership,
    int options,
    int features,
    string[] propertyNameFilters,
    int propertyScope
)

[WebMethodAttribute]
public:
array<TeamFoundationIdentity^>^ ReadIdentitiesByDescriptor(
    array<IdentityDescriptor^>^ descriptors, 
    int queryMembership, 
    int options, 
    int features, 
    array<String^>^ propertyNameFilters, 
    int propertyScope
)

[<WebMethodAttribute>]
member ReadIdentitiesByDescriptor : 
        descriptors:IdentityDescriptor[] * 
        queryMembership:int * 
        options:int * 
        features:int * 
        propertyNameFilters:string[] * 
        propertyScope:int -> TeamFoundationIdentity[] 

public function ReadIdentitiesByDescriptor(
    descriptors : IdentityDescriptor[], 
    queryMembership : int, 
    options : int, 
    features : int, 
    propertyNameFilters : String[], 
    propertyScope : int
) : TeamFoundationIdentity[]

Parameters

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

  descriptors

• queryMembership
  Type: System.Int32

  none, direct or expanded membership information

• options
  Type: System.Int32

  options

• features
  Type: System.Int32

• propertyNameFilters
  Type: array<System.String[]

• propertyScope
  Type: System.Int32

Return Value

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

IdentityManagementWebService Class

Microsoft.TeamFoundation.Framework.Server.WebServices Namespace