LargePersonGroupPersonExtensions.ListAsync(ILargePersonGroupPerson, String, String, Nullable<Int32>, CancellationToken) Method

Definition

List all persons in a large person group, and retrieve person information (including personId, name, userData and persistedFaceIds of registered faces of the person).

public static System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.Face.Models.Person>> ListAsync (this Microsoft.Azure.CognitiveServices.Vision.Face.ILargePersonGroupPerson operations, string largePersonGroupId, string start = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);
static member ListAsync : Microsoft.Azure.CognitiveServices.Vision.Face.ILargePersonGroupPerson * string * string * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.Face.Models.Person>>
<Extension()>
Public Function ListAsync (operations As ILargePersonGroupPerson, largePersonGroupId As String, Optional start As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IList(Of Person))

Parameters

operations
ILargePersonGroupPerson

The operations group for this extension method.

largePersonGroupId
String

Id referencing a particular large person group.

start
String

Starting person id to return (used to list a range of persons).

top
Nullable<Int32>

Number of persons to return starting with the person id indicated by the 'start' parameter.

cancellationToken
CancellationToken

The cancellation token.

Returns

Task<IList<Person>>

Applies to