ILargePersonGroupPerson.DeleteWithHttpMessagesAsync 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:

ILargePersonGroupPerson.cs

Delete an existing person from a large person group. All stored person data, and face features in the person entry will be deleted.

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

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

Public Function DeleteWithHttpMessagesAsync (largePersonGroupId As String, personId As Guid, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse)

Parameters

largePersonGroupId

String

Id referencing a particular large person group.

personId

Guid

Id referencing a particular person.

customHeaders

Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<HttpOperationResponse>

Exceptions

APIErrorException

Thrown when the operation returned an invalid status code

ValidationException

Thrown when a required parameter is null