/
SnapshotOperations.yml
722 lines (649 loc) · 26 KB
/
SnapshotOperations.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
### YamlMime:TSType
name: SnapshotOperations
uid: '@azure/cognitiveservices-face.SnapshotOperations'
package: '@azure/cognitiveservices-face'
summary: Class representing a SnapshotOperations.
fullName: SnapshotOperations
remarks: ''
isDeprecated: false
type: class
constructors:
- name: SnapshotOperations(FaceClientContext)
uid: '@azure/cognitiveservices-face.SnapshotOperations.constructor'
package: '@azure/cognitiveservices-face'
summary: Create a SnapshotOperations.
remarks: ''
isDeprecated: false
syntax:
content: 'new SnapshotOperations(client: FaceClientContext)'
parameters:
- id: client
type: <xref uid="@azure/cognitiveservices-face.FaceClientContext" />
description: Reference to the service client.
methods:
- name: apply(string, string, ServiceCallback<void>)
uid: '@azure/cognitiveservices-face.SnapshotOperations.apply_1'
package: '@azure/cognitiveservices-face'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function apply(snapshotId: string, objectId: string, callback:
ServiceCallback<void>)
parameters:
- id: snapshotId
type: string
description: Id referencing a particular snapshot.
- id: objectId
type: string
description: User specified target object id to be created from the snapshot.
- id: callback
type: <xref uid="@azure/ms-rest-js.ServiceCallback" /><void>
description: The callback
- name: apply(string, string, SnapshotApplyOptionalParams)
uid: '@azure/cognitiveservices-face.SnapshotOperations.apply'
package: '@azure/cognitiveservices-face'
summary: >-
Submit an operation to apply a snapshot to current subscription. For each
snapshot, only
subscriptions included in the applyScope of Snapshot - Take can apply
it.<br />
The snapshot interfaces are for users to backup and restore their face
data from one face
subscription to another, inside same region or across regions. The
workflow contains two phases,
user first calls Snapshot - Take to create a copy of the source object and
store it as a
snapshot, then calls Snapshot - Apply to paste the snapshot to target
subscription. The
snapshots are stored in a centralized location (per Azure instance), so
that they can be applied
cross accounts and regions.<br />
Applying snapshot is an asynchronous operation. An operation id can be
obtained from the
"Operation-Location" field in response header, to be used in
OperationStatus - Get for tracking
the progress of applying the snapshot. The target object id will be
included in the
"resourceLocation" field in OperationStatus - Get response when the
operation status is
"succeeded".<br />
Snapshot applying time depends on the number of person and face entries in
the snapshot object.
It could be in seconds, or up to 1 hour for 1,000,000 persons with
multiple faces.<br />
Snapshots will be automatically expired and cleaned in 48 hours after it
is created by Snapshot
- Take. So the target subscription is required to apply the snapshot in 48
hours since its
creation.<br />
Applying a snapshot will not block any other operations against the target
object, however it is
not recommended because the correctness cannot be guaranteed during
snapshot applying. After
snapshot applying is completed, all operations towards the target object
can work as normal.
Snapshot also includes the training results of the source object, which
means target
subscription the snapshot applied to does not need re-train the target
object before calling
Identify/FindSimilar.<br />
One snapshot can be applied multiple times in parallel, while currently
only CreateNew apply
mode is supported, which means the apply operation will fail if target
subscription already
contains an object of same type and using the same objectId. Users can
specify the "objectId" in
request body to avoid such conflicts.<br />
* Free-tier subscription quota: 100 apply operations per month.
* S0-tier subscription quota: 100 apply operations per day.
remarks: ''
isDeprecated: false
syntax:
content: >-
function apply(snapshotId: string, objectId: string, options?:
SnapshotApplyOptionalParams): Promise<SnapshotApplyResponse>
parameters:
- id: snapshotId
type: string
description: Id referencing a particular snapshot.
- id: objectId
type: string
description: User specified target object id to be created from the snapshot.
- id: options
type: >-
<xref
uid="@azure/cognitiveservices-face.FaceModels.SnapshotApplyOptionalParams"
/>
description: The optional parameters
return:
description: Promise<Models.SnapshotApplyResponse>
type: >-
Promise<<xref
uid="@azure/cognitiveservices-face.FaceModels.SnapshotApplyResponse"
/>>
- name: apply(string, string, SnapshotApplyOptionalParams, ServiceCallback<void>)
uid: '@azure/cognitiveservices-face.SnapshotOperations.apply_2'
package: '@azure/cognitiveservices-face'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function apply(snapshotId: string, objectId: string, options:
SnapshotApplyOptionalParams, callback: ServiceCallback<void>)
parameters:
- id: snapshotId
type: string
description: Id referencing a particular snapshot.
- id: objectId
type: string
description: User specified target object id to be created from the snapshot.
- id: options
type: >-
<xref
uid="@azure/cognitiveservices-face.FaceModels.SnapshotApplyOptionalParams"
/>
description: The optional parameters
- id: callback
type: <xref uid="@azure/ms-rest-js.ServiceCallback" /><void>
description: The callback
- name: deleteMethod(string, RequestOptionsBase)
uid: '@azure/cognitiveservices-face.SnapshotOperations.deleteMethod'
package: '@azure/cognitiveservices-face'
summary: >-
Delete an existing snapshot according to the snapshotId. All object data
and information in the
snapshot will also be deleted. Only the source subscription who took the
snapshot can delete the
snapshot. If the user does not delete a snapshot with this API, the
snapshot will still be
automatically deleted in 48 hours after creation.
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteMethod(snapshotId: string, options?: RequestOptionsBase):
Promise<RestResponse>
parameters:
- id: snapshotId
type: string
description: Id referencing a particular snapshot.
- id: options
type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
description: The optional parameters
return:
description: Promise<msRest.RestResponse>
type: Promise<<xref uid="@azure/ms-rest-js.RestResponse" />>
- name: deleteMethod(string, RequestOptionsBase, ServiceCallback<void>)
uid: '@azure/cognitiveservices-face.SnapshotOperations.deleteMethod_2'
package: '@azure/cognitiveservices-face'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteMethod(snapshotId: string, options: RequestOptionsBase,
callback: ServiceCallback<void>)
parameters:
- id: snapshotId
type: string
description: Id referencing a particular snapshot.
- id: options
type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
description: The optional parameters
- id: callback
type: <xref uid="@azure/ms-rest-js.ServiceCallback" /><void>
description: The callback
- name: deleteMethod(string, ServiceCallback<void>)
uid: '@azure/cognitiveservices-face.SnapshotOperations.deleteMethod_1'
package: '@azure/cognitiveservices-face'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteMethod(snapshotId: string, callback:
ServiceCallback<void>)
parameters:
- id: snapshotId
type: string
description: Id referencing a particular snapshot.
- id: callback
type: <xref uid="@azure/ms-rest-js.ServiceCallback" /><void>
description: The callback
- name: get(string, RequestOptionsBase)
uid: '@azure/cognitiveservices-face.SnapshotOperations.get'
package: '@azure/cognitiveservices-face'
summary: >-
Retrieve information about a snapshot. Snapshot is only accessible to the
source subscription
who took it, and target subscriptions included in the applyScope in
Snapshot - Take.
remarks: ''
isDeprecated: false
syntax:
content: >-
function get(snapshotId: string, options?: RequestOptionsBase):
Promise<SnapshotGetResponse>
parameters:
- id: snapshotId
type: string
description: Id referencing a particular snapshot.
- id: options
type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
description: The optional parameters
return:
description: Promise<Models.SnapshotGetResponse>
type: >-
Promise<<xref
uid="@azure/cognitiveservices-face.FaceModels.SnapshotGetResponse"
/>>
- name: get(string, RequestOptionsBase, ServiceCallback<Snapshot>)
uid: '@azure/cognitiveservices-face.SnapshotOperations.get_2'
package: '@azure/cognitiveservices-face'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function get(snapshotId: string, options: RequestOptionsBase, callback:
ServiceCallback<Snapshot>)
parameters:
- id: snapshotId
type: string
description: Id referencing a particular snapshot.
- id: options
type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
description: The optional parameters
- id: callback
type: >-
<xref uid="@azure/ms-rest-js.ServiceCallback" /><<xref
uid="@azure/cognitiveservices-face.FaceModels.Snapshot" />>
description: The callback
- name: get(string, ServiceCallback<Snapshot>)
uid: '@azure/cognitiveservices-face.SnapshotOperations.get_1'
package: '@azure/cognitiveservices-face'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: 'function get(snapshotId: string, callback: ServiceCallback<Snapshot>)'
parameters:
- id: snapshotId
type: string
description: Id referencing a particular snapshot.
- id: callback
type: >-
<xref uid="@azure/ms-rest-js.ServiceCallback" /><<xref
uid="@azure/cognitiveservices-face.FaceModels.Snapshot" />>
description: The callback
- name: getOperationStatus(string, RequestOptionsBase)
uid: '@azure/cognitiveservices-face.SnapshotOperations.getOperationStatus'
package: '@azure/cognitiveservices-face'
summary: Retrieve the status of a take/apply snapshot operation.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getOperationStatus(operationId: string, options?:
RequestOptionsBase): Promise<SnapshotGetOperationStatusResponse>
parameters:
- id: operationId
type: string
description: Id referencing a particular take/apply snapshot operation.
- id: options
type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
description: The optional parameters
return:
description: Promise<Models.SnapshotGetOperationStatusResponse>
type: >-
Promise<<xref
uid="@azure/cognitiveservices-face.FaceModels.SnapshotGetOperationStatusResponse"
/>>
- name: >-
getOperationStatus(string, RequestOptionsBase,
ServiceCallback<OperationStatus>)
uid: '@azure/cognitiveservices-face.SnapshotOperations.getOperationStatus_2'
package: '@azure/cognitiveservices-face'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function getOperationStatus(operationId: string, options:
RequestOptionsBase, callback: ServiceCallback<OperationStatus>)
parameters:
- id: operationId
type: string
description: Id referencing a particular take/apply snapshot operation.
- id: options
type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
description: The optional parameters
- id: callback
type: >-
<xref uid="@azure/ms-rest-js.ServiceCallback" /><<xref
uid="@azure/cognitiveservices-face.FaceModels.OperationStatus"
/>>
description: The callback
- name: getOperationStatus(string, ServiceCallback<OperationStatus>)
uid: '@azure/cognitiveservices-face.SnapshotOperations.getOperationStatus_1'
package: '@azure/cognitiveservices-face'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function getOperationStatus(operationId: string, callback:
ServiceCallback<OperationStatus>)
parameters:
- id: operationId
type: string
description: Id referencing a particular take/apply snapshot operation.
- id: callback
type: >-
<xref uid="@azure/ms-rest-js.ServiceCallback" /><<xref
uid="@azure/cognitiveservices-face.FaceModels.OperationStatus"
/>>
description: The callback
- name: list(ServiceCallback<Snapshot[]>)
uid: '@azure/cognitiveservices-face.SnapshotOperations.list_1'
package: '@azure/cognitiveservices-face'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: 'function list(callback: ServiceCallback<Snapshot[]>)'
parameters:
- id: callback
type: >-
<xref uid="@azure/ms-rest-js.ServiceCallback" /><<xref
uid="@azure/cognitiveservices-face.FaceModels.Snapshot" />[]>
description: The callback
- name: list(SnapshotListOptionalParams)
uid: '@azure/cognitiveservices-face.SnapshotOperations.list'
package: '@azure/cognitiveservices-face'
summary: >-
List all accessible snapshots with related information, including
snapshots that were taken by
the user, or snapshots to be applied to the user (subscription id was
included in the applyScope
in Snapshot - Take).
remarks: ''
isDeprecated: false
syntax:
content: >-
function list(options?: SnapshotListOptionalParams):
Promise<SnapshotListResponse>
parameters:
- id: options
type: >-
<xref
uid="@azure/cognitiveservices-face.FaceModels.SnapshotListOptionalParams"
/>
description: The optional parameters
return:
description: Promise<Models.SnapshotListResponse>
type: >-
Promise<<xref
uid="@azure/cognitiveservices-face.FaceModels.SnapshotListResponse"
/>>
- name: list(SnapshotListOptionalParams, ServiceCallback<Snapshot[]>)
uid: '@azure/cognitiveservices-face.SnapshotOperations.list_2'
package: '@azure/cognitiveservices-face'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function list(options: SnapshotListOptionalParams, callback:
ServiceCallback<Snapshot[]>)
parameters:
- id: options
type: >-
<xref
uid="@azure/cognitiveservices-face.FaceModels.SnapshotListOptionalParams"
/>
description: The optional parameters
- id: callback
type: >-
<xref uid="@azure/ms-rest-js.ServiceCallback" /><<xref
uid="@azure/cognitiveservices-face.FaceModels.Snapshot" />[]>
description: The callback
- name: take(SnapshotObjectType, string, string[], ServiceCallback<void>)
uid: '@azure/cognitiveservices-face.SnapshotOperations.take_1'
package: '@azure/cognitiveservices-face'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function take(type: SnapshotObjectType, objectId: string, applyScope:
string[], callback: ServiceCallback<void>)
parameters:
- id: type
type: >-
<xref
uid="@azure/cognitiveservices-face.FaceModels.SnapshotObjectType" />
description: >-
User specified type for the source object to take snapshot from.
Currently FaceList,
PersonGroup, LargeFaceList and LargePersonGroup are supported.
Possible values include:
'FaceList', 'LargeFaceList', 'LargePersonGroup', 'PersonGroup'
- id: objectId
type: string
description: User specified source object id to take snapshot from.
- id: applyScope
type: string[]
description: >-
User specified array of target Face subscription ids for the
snapshot. For
each snapshot, only subscriptions included in the applyScope of
Snapshot - Take can apply it.
- id: callback
type: <xref uid="@azure/ms-rest-js.ServiceCallback" /><void>
description: The callback
- name: take(SnapshotObjectType, string, string[], SnapshotTakeOptionalParams)
uid: '@azure/cognitiveservices-face.SnapshotOperations.take'
package: '@azure/cognitiveservices-face'
summary: >-
Submit an operation to take a snapshot of face list, large face list,
person group or large
person group, with user-specified snapshot type, source object id, apply
scope and an optional
user data.<br />
The snapshot interfaces are for users to backup and restore their face
data from one face
subscription to another, inside same region or across regions. The
workflow contains two phases,
user first calls Snapshot - Take to create a copy of the source object and
store it as a
snapshot, then calls Snapshot - Apply to paste the snapshot to target
subscription. The
snapshots are stored in a centralized location (per Azure instance), so
that they can be applied
cross accounts and regions.<br />
Taking snapshot is an asynchronous operation. An operation id can be
obtained from the
"Operation-Location" field in response header, to be used in
OperationStatus - Get for tracking
the progress of creating the snapshot. The snapshot id will be included in
the
"resourceLocation" field in OperationStatus - Get response when the
operation status is
"succeeded".<br />
Snapshot taking time depends on the number of person and face entries in
the source object. It
could be in seconds, or up to several hours for 1,000,000 persons with
multiple faces.<br />
Snapshots will be automatically expired and cleaned in 48 hours after it
is created by Snapshot
- Take. User can delete the snapshot using Snapshot - Delete by themselves
any time before
expiration.<br />
Taking snapshot for a certain object will not block any other operations
against the object. All
read-only operations (Get/List and Identify/FindSimilar/Verify) can be
conducted as usual. For
all writable operations, including Add/Update/Delete the source object or
its persons/faces and
Train, they are not blocked but not recommended because writable updates
may not be reflected on
the snapshot during its taking. After snapshot taking is completed, all
readable and writable
operations can work as normal. Snapshot will also include the training
results of the source
object, which means target subscription the snapshot applied to does not
need re-train the
target object before calling Identify/FindSimilar.<br />
* Free-tier subscription quota: 100 take operations per month.
* S0-tier subscription quota: 100 take operations per day.
remarks: ''
isDeprecated: false
syntax:
content: >-
function take(type: SnapshotObjectType, objectId: string, applyScope:
string[], options?: SnapshotTakeOptionalParams):
Promise<SnapshotTakeResponse>
parameters:
- id: type
type: >-
<xref
uid="@azure/cognitiveservices-face.FaceModels.SnapshotObjectType" />
description: >-
User specified type for the source object to take snapshot from.
Currently FaceList,
PersonGroup, LargeFaceList and LargePersonGroup are supported.
Possible values include:
'FaceList', 'LargeFaceList', 'LargePersonGroup', 'PersonGroup'
- id: objectId
type: string
description: User specified source object id to take snapshot from.
- id: applyScope
type: string[]
description: >-
User specified array of target Face subscription ids for the
snapshot. For
each snapshot, only subscriptions included in the applyScope of
Snapshot - Take can apply it.
- id: options
type: >-
<xref
uid="@azure/cognitiveservices-face.FaceModels.SnapshotTakeOptionalParams"
/>
description: The optional parameters
return:
description: Promise<Models.SnapshotTakeResponse>
type: >-
Promise<<xref
uid="@azure/cognitiveservices-face.FaceModels.SnapshotTakeResponse"
/>>
- name: >-
take(SnapshotObjectType, string, string[], SnapshotTakeOptionalParams,
ServiceCallback<void>)
uid: '@azure/cognitiveservices-face.SnapshotOperations.take_2'
package: '@azure/cognitiveservices-face'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function take(type: SnapshotObjectType, objectId: string, applyScope:
string[], options: SnapshotTakeOptionalParams, callback:
ServiceCallback<void>)
parameters:
- id: type
type: >-
<xref
uid="@azure/cognitiveservices-face.FaceModels.SnapshotObjectType" />
description: >-
User specified type for the source object to take snapshot from.
Currently FaceList,
PersonGroup, LargeFaceList and LargePersonGroup are supported.
Possible values include:
'FaceList', 'LargeFaceList', 'LargePersonGroup', 'PersonGroup'
- id: objectId
type: string
description: User specified source object id to take snapshot from.
- id: applyScope
type: string[]
description: >-
User specified array of target Face subscription ids for the
snapshot. For
each snapshot, only subscriptions included in the applyScope of
Snapshot - Take can apply it.
- id: options
type: >-
<xref
uid="@azure/cognitiveservices-face.FaceModels.SnapshotTakeOptionalParams"
/>
description: The optional parameters
- id: callback
type: <xref uid="@azure/ms-rest-js.ServiceCallback" /><void>
description: The callback
- name: update(string, ServiceCallback<void>)
uid: '@azure/cognitiveservices-face.SnapshotOperations.update_1'
package: '@azure/cognitiveservices-face'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: 'function update(snapshotId: string, callback: ServiceCallback<void>)'
parameters:
- id: snapshotId
type: string
description: Id referencing a particular snapshot.
- id: callback
type: <xref uid="@azure/ms-rest-js.ServiceCallback" /><void>
description: The callback
- name: update(string, SnapshotUpdateOptionalParams)
uid: '@azure/cognitiveservices-face.SnapshotOperations.update'
package: '@azure/cognitiveservices-face'
summary: >-
Update the information of a snapshot. Only the source subscription who
took the snapshot can
update the snapshot.
remarks: ''
isDeprecated: false
syntax:
content: >-
function update(snapshotId: string, options?:
SnapshotUpdateOptionalParams): Promise<RestResponse>
parameters:
- id: snapshotId
type: string
description: Id referencing a particular snapshot.
- id: options
type: >-
<xref
uid="@azure/cognitiveservices-face.FaceModels.SnapshotUpdateOptionalParams"
/>
description: The optional parameters
return:
description: Promise<msRest.RestResponse>
type: Promise<<xref uid="@azure/ms-rest-js.RestResponse" />>
- name: update(string, SnapshotUpdateOptionalParams, ServiceCallback<void>)
uid: '@azure/cognitiveservices-face.SnapshotOperations.update_2'
package: '@azure/cognitiveservices-face'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function update(snapshotId: string, options:
SnapshotUpdateOptionalParams, callback: ServiceCallback<void>)
parameters:
- id: snapshotId
type: string
description: Id referencing a particular snapshot.
- id: options
type: >-
<xref
uid="@azure/cognitiveservices-face.FaceModels.SnapshotUpdateOptionalParams"
/>
description: The optional parameters
- id: callback
type: <xref uid="@azure/ms-rest-js.ServiceCallback" /><void>
description: The callback