PersonGroupPersonExtensions.ListAsync Method

Definition

Namespace:

Microsoft.Azure.CognitiveServices.Vision.Face

Assembly:

Microsoft.Azure.CognitiveServices.Vision.Face.dll

Package:

Microsoft.Azure.CognitiveServices.Vision.Face v2.8.0-preview.3

Source:

PersonGroupPersonExtensions.cs

List all persons in a 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.IPersonGroupPerson operations, string personGroupId, string start = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);

static member ListAsync : Microsoft.Azure.CognitiveServices.Vision.Face.IPersonGroupPerson * 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 IPersonGroupPerson, personGroupId 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

IPersonGroupPerson

The operations group for this extension method.

personGroupId

String

Id referencing a particular 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>>