SnapshotOperationsExtensions.UpdateAsync Method

Definition

Update the information of a snapshot. Only the source subscription who took the snapshot can update the snapshot.

public static System.Threading.Tasks.Task UpdateAsync (this Microsoft.Azure.CognitiveServices.Vision.Face.ISnapshotOperations operations, Guid snapshotId, System.Collections.Generic.IList<Guid> applyScope = default, string userData = default, System.Threading.CancellationToken cancellationToken = default);
static member UpdateAsync : Microsoft.Azure.CognitiveServices.Vision.Face.ISnapshotOperations * Guid * System.Collections.Generic.IList<Guid> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
<Extension()>
Public Function UpdateAsync (operations As ISnapshotOperations, snapshotId As Guid, Optional applyScope As IList(Of Guid) = Nothing, Optional userData As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

operations
ISnapshotOperations

The operations group for this extension method.

snapshotId
Guid

Id referencing a particular snapshot.

applyScope
IList<Guid>

Array of the target Face subscription ids for the snapshot, specified by the user who created the snapshot when calling Snapshot - Take. For each snapshot, only subscriptions included in the applyScope of Snapshot - Take can apply it.

userData
String

User specified data about the snapshot for any purpose. Length should not exceed 16KB.

cancellationToken
CancellationToken

The cancellation token.

Returns

Applies to