PersonGroupPerson.UpdateFaceWithHttpMessagesAsync 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:

PersonGroupPerson.cs

Update a person persisted face's userData field.

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

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

Public Function UpdateFaceWithHttpMessagesAsync (personGroupId As String, personId As Guid, persistedFaceId As Guid, Optional userData As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse)

Parameters

personGroupId

String

Id referencing a particular person group.

personId

Guid

Id referencing a particular person.

persistedFaceId

Guid

Id referencing a particular persistedFaceId of an existing face.

userData

String

User-provided data attached to the face. The size limit is 1KB.

customHeaders

Dictionary<String,List<String>>

Headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<HttpOperationResponse>

Implements

UpdateFaceWithHttpMessagesAsync(String, Guid, Guid, String, 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