FaceListOperations.DeleteFaceWithHttpMessagesAsync 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:

FaceListOperations.cs

Delete an existing face from a face list (given by a persistedFaceId and a faceListId). Persisted image related to the face will also be deleted.

public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse> DeleteFaceWithHttpMessagesAsync (string faceListId, Guid persistedFaceId, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteFaceWithHttpMessagesAsync : string * Guid * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse>
override this.DeleteFaceWithHttpMessagesAsync : string * Guid * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse>

Public Function DeleteFaceWithHttpMessagesAsync (faceListId As String, persistedFaceId As Guid, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse)

Parameters

faceListId

String

Id referencing a particular face list.

persistedFaceId

Guid

Id referencing a particular persistedFaceId of an existing face.

customHeaders

Dictionary<String,List<String>>

Headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<HttpOperationResponse>

Implements

DeleteFaceWithHttpMessagesAsync(String, Guid, Dictionary<String,List<String>>, CancellationToken)

Exceptions

APIErrorException

Thrown when the operation returned an invalid status code

ValidationException

Thrown when a required parameter is null

ArgumentNullException

Thrown when a required parameter is null