LargeFaceListOperations.ListFacesWithHttpMessagesAsync 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:

LargeFaceListOperations.cs

List all faces in a large face list, and retrieve face information (including userData and persistedFaceIds of registered faces of the face).

public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace>>> ListFacesWithHttpMessagesAsync (string largeFaceListId, string start = default, int? top = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ListFacesWithHttpMessagesAsync : string * string * Nullable<int> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace>>>
override this.ListFacesWithHttpMessagesAsync : string * string * Nullable<int> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace>>>

Public Function ListFacesWithHttpMessagesAsync (largeFaceListId As String, Optional start As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of IList(Of PersistedFace)))

Parameters

largeFaceListId

String

Id referencing a particular large face list.

start

String

Starting face id to return (used to list a range of faces).

top

Nullable<Int32>

Number of faces to return starting with the face id indicated by the 'start' parameter.

customHeaders

Dictionary<String,List<String>>

Headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<HttpOperationResponse<IList<PersistedFace>>>

Implements

ListFacesWithHttpMessagesAsync(String, String, Nullable<Int32>, Dictionary<String,List<String>>, CancellationToken)

Exceptions

APIErrorException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

Thrown when a required parameter is null

ArgumentNullException

Thrown when a required parameter is null