Share via


IFaceListOperations.GetWithHttpMessagesAsync Method

Definition

Retrieve a face list’s faceListId, name, userData, recognitionModel and faces in the face list.

public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.FaceList>> GetWithHttpMessagesAsync (string faceListId, bool? returnRecognitionModel = False, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetWithHttpMessagesAsync : string * Nullable<bool> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.FaceList>>
Public Function GetWithHttpMessagesAsync (faceListId As String, Optional returnRecognitionModel As Nullable(Of Boolean) = False, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of FaceList))

Parameters

faceListId
String

Id referencing a particular face list.

returnRecognitionModel
Nullable<Boolean>

A value indicating whether the operation should return 'recognitionModel' in response.

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Exceptions

Thrown when the operation returned an invalid status code

Thrown when unable to deserialize the response

Thrown when a required parameter is null

Applies to