-
Notifications
You must be signed in to change notification settings - Fork 255
/
SnapshotOperations.xml
573 lines (573 loc) · 49.1 KB
/
SnapshotOperations.xml
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
<Type Name="SnapshotOperations" FullName="Microsoft.Azure.CognitiveServices.Vision.Face.SnapshotOperations">
<TypeSignature Language="C#" Value="public class SnapshotOperations : Microsoft.Azure.CognitiveServices.Vision.Face.ISnapshotOperations, Microsoft.Rest.IServiceOperations<Microsoft.Azure.CognitiveServices.Vision.Face.FaceClient>" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SnapshotOperations extends System.Object implements class Microsoft.Azure.CognitiveServices.Vision.Face.ISnapshotOperations, class Microsoft.Rest.IServiceOperations`1<class Microsoft.Azure.CognitiveServices.Vision.Face.FaceClient>" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.CognitiveServices.Vision.Face.SnapshotOperations" />
<TypeSignature Language="VB.NET" Value="Public Class SnapshotOperations
Implements IServiceOperations(Of FaceClient), ISnapshotOperations" />
<TypeSignature Language="F#" Value="type SnapshotOperations = class
 interface IServiceOperations<FaceClient>
 interface ISnapshotOperations" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.7.0.0</AssemblyVersion>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Azure.CognitiveServices.Vision.Face.ISnapshotOperations</InterfaceName>
</Interface>
<Interface>
<InterfaceName>Microsoft.Rest.IServiceOperations<Microsoft.Azure.CognitiveServices.Vision.Face.FaceClient></InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
SnapshotOperations operations.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SnapshotOperations (Microsoft.Azure.CognitiveServices.Vision.Face.FaceClient client);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Azure.CognitiveServices.Vision.Face.FaceClient client) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.SnapshotOperations.#ctor(Microsoft.Azure.CognitiveServices.Vision.Face.FaceClient)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (client As FaceClient)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.CognitiveServices.Vision.Face.SnapshotOperations : Microsoft.Azure.CognitiveServices.Vision.Face.FaceClient -> Microsoft.Azure.CognitiveServices.Vision.Face.SnapshotOperations" Usage="new Microsoft.Azure.CognitiveServices.Vision.Face.SnapshotOperations client" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="client" Type="Microsoft.Azure.CognitiveServices.Vision.Face.FaceClient" />
</Parameters>
<Docs>
<param name="client">
Reference to the service client.
</param>
<summary>
Initializes a new instance of the SnapshotOperations class.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
Thrown when a required parameter is null
</exception>
</Docs>
</Member>
<Member MemberName="ApplyWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationHeaderResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotApplyHeaders>> ApplyWithHttpMessagesAsync (Guid snapshotId, string objectId, Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotApplyMode mode = Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotApplyMode.CreateNew, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationHeaderResponse`1<class Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotApplyHeaders>> ApplyWithHttpMessagesAsync(valuetype System.Guid snapshotId, string objectId, valuetype Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotApplyMode mode, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.SnapshotOperations.ApplyWithHttpMessagesAsync(System.Guid,System.String,Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotApplyMode,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function ApplyWithHttpMessagesAsync (snapshotId As Guid, objectId As String, Optional mode As SnapshotApplyMode = Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotApplyMode.CreateNew, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationHeaderResponse(Of SnapshotApplyHeaders))" />
<MemberSignature Language="F#" Value="abstract member ApplyWithHttpMessagesAsync : Guid * string * Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotApplyMode * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationHeaderResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotApplyHeaders>>
override this.ApplyWithHttpMessagesAsync : Guid * string * Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotApplyMode * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationHeaderResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotApplyHeaders>>" Usage="snapshotOperations.ApplyWithHttpMessagesAsync (snapshotId, objectId, mode, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.CognitiveServices.Vision.Face.ISnapshotOperations.ApplyWithHttpMessagesAsync(System.Guid,System.String,Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotApplyMode,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationHeaderResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotApplyHeaders>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="snapshotId" Type="System.Guid" />
<Parameter Name="objectId" Type="System.String" />
<Parameter Name="mode" Type="Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotApplyMode" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="snapshotId">
Id referencing a particular snapshot.
</param>
<param name="objectId">
User specified target object id to be created from the snapshot.
</param>
<param name="mode">
Snapshot applying mode. Currently only CreateNew 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. Possible values
include: 'CreateNew'
</param>
<param name="customHeaders">
Headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<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.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Azure.CognitiveServices.Vision.Face.Models.APIErrorException">
Thrown when the operation returned an invalid status code
</exception>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown when a required parameter is null
</exception>
<exception cref="T:System.ArgumentNullException">
Thrown when a required parameter is null
</exception>
<return>
A response object containing the response body and response headers.
</return>
</Docs>
</Member>
<Member MemberName="Client">
<MemberSignature Language="C#" Value="public Microsoft.Azure.CognitiveServices.Vision.Face.FaceClient Client { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.CognitiveServices.Vision.Face.FaceClient Client" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Vision.Face.SnapshotOperations.Client" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Client As FaceClient" />
<MemberSignature Language="F#" Value="member this.Client : Microsoft.Azure.CognitiveServices.Vision.Face.FaceClient" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.SnapshotOperations.Client" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.CognitiveServices.Vision.Face.FaceClient</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets a reference to the FaceClient
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DeleteWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse> DeleteWithHttpMessagesAsync (Guid snapshotId, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse> DeleteWithHttpMessagesAsync(valuetype System.Guid snapshotId, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.SnapshotOperations.DeleteWithHttpMessagesAsync(System.Guid,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function DeleteWithHttpMessagesAsync (snapshotId As Guid, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse)" />
<MemberSignature Language="F#" Value="abstract member DeleteWithHttpMessagesAsync : Guid * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse>
override this.DeleteWithHttpMessagesAsync : Guid * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse>" Usage="snapshotOperations.DeleteWithHttpMessagesAsync (snapshotId, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.CognitiveServices.Vision.Face.ISnapshotOperations.DeleteWithHttpMessagesAsync(System.Guid,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="snapshotId" Type="System.Guid" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="snapshotId">
Id referencing a particular snapshot.
</param>
<param name="customHeaders">
Headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<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.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Azure.CognitiveServices.Vision.Face.Models.APIErrorException">
Thrown when the operation returned an invalid status code
</exception>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown when a required parameter is null
</exception>
<exception cref="T:System.ArgumentNullException">
Thrown when a required parameter is null
</exception>
<return>
A response object containing the response body and response headers.
</return>
</Docs>
</Member>
<Member MemberName="GetOperationStatusWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatus>> GetOperationStatusWithHttpMessagesAsync (Guid operationId, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse`1<class Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatus>> GetOperationStatusWithHttpMessagesAsync(valuetype System.Guid operationId, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.SnapshotOperations.GetOperationStatusWithHttpMessagesAsync(System.Guid,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetOperationStatusWithHttpMessagesAsync (operationId As Guid, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of OperationStatus))" />
<MemberSignature Language="F#" Value="abstract member GetOperationStatusWithHttpMessagesAsync : Guid * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatus>>
override this.GetOperationStatusWithHttpMessagesAsync : Guid * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatus>>" Usage="snapshotOperations.GetOperationStatusWithHttpMessagesAsync (operationId, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.CognitiveServices.Vision.Face.ISnapshotOperations.GetOperationStatusWithHttpMessagesAsync(System.Guid,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatus>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operationId" Type="System.Guid" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="operationId">
Id referencing a particular take/apply snapshot operation.
</param>
<param name="customHeaders">
Headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Retrieve the status of a take/apply snapshot operation.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Azure.CognitiveServices.Vision.Face.Models.APIErrorException">
Thrown when the operation returned an invalid status code
</exception>
<exception cref="T:Microsoft.Rest.SerializationException">
Thrown when unable to deserialize the response
</exception>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown when a required parameter is null
</exception>
<exception cref="T:System.ArgumentNullException">
Thrown when a required parameter is null
</exception>
<return>
A response object containing the response body and response headers.
</return>
</Docs>
</Member>
<Member MemberName="GetWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.Snapshot>> GetWithHttpMessagesAsync (Guid snapshotId, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse`1<class Microsoft.Azure.CognitiveServices.Vision.Face.Models.Snapshot>> GetWithHttpMessagesAsync(valuetype System.Guid snapshotId, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.SnapshotOperations.GetWithHttpMessagesAsync(System.Guid,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetWithHttpMessagesAsync (snapshotId As Guid, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of Snapshot))" />
<MemberSignature Language="F#" Value="abstract member GetWithHttpMessagesAsync : Guid * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.Snapshot>>
override this.GetWithHttpMessagesAsync : Guid * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.Snapshot>>" Usage="snapshotOperations.GetWithHttpMessagesAsync (snapshotId, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.CognitiveServices.Vision.Face.ISnapshotOperations.GetWithHttpMessagesAsync(System.Guid,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.Snapshot>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="snapshotId" Type="System.Guid" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="snapshotId">
Id referencing a particular snapshot.
</param>
<param name="customHeaders">
Headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<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.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Azure.CognitiveServices.Vision.Face.Models.APIErrorException">
Thrown when the operation returned an invalid status code
</exception>
<exception cref="T:Microsoft.Rest.SerializationException">
Thrown when unable to deserialize the response
</exception>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown when a required parameter is null
</exception>
<exception cref="T:System.ArgumentNullException">
Thrown when a required parameter is null
</exception>
<return>
A response object containing the response body and response headers.
</return>
</Docs>
</Member>
<Member MemberName="ListWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.Face.Models.Snapshot>>> ListWithHttpMessagesAsync (Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotObjectType? type = default, System.Collections.Generic.IList<Guid> applyScope = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse`1<class System.Collections.Generic.IList`1<class Microsoft.Azure.CognitiveServices.Vision.Face.Models.Snapshot>>> ListWithHttpMessagesAsync(valuetype System.Nullable`1<valuetype Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotObjectType> type, class System.Collections.Generic.IList`1<valuetype System.Guid> applyScope, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.SnapshotOperations.ListWithHttpMessagesAsync(System.Nullable{Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotObjectType},System.Collections.Generic.IList{System.Guid},System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function ListWithHttpMessagesAsync (Optional type As Nullable(Of SnapshotObjectType) = Nothing, Optional applyScope As IList(Of Guid) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of IList(Of Snapshot)))" />
<MemberSignature Language="F#" Value="abstract member ListWithHttpMessagesAsync : Nullable<Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotObjectType> * System.Collections.Generic.IList<Guid> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.Face.Models.Snapshot>>>
override this.ListWithHttpMessagesAsync : Nullable<Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotObjectType> * System.Collections.Generic.IList<Guid> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.Face.Models.Snapshot>>>" Usage="snapshotOperations.ListWithHttpMessagesAsync (type, applyScope, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.CognitiveServices.Vision.Face.ISnapshotOperations.ListWithHttpMessagesAsync(System.Nullable{Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotObjectType},System.Collections.Generic.IList{System.Guid},System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.Face.Models.Snapshot>>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="type" Type="System.Nullable<Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotObjectType>" />
<Parameter Name="applyScope" Type="System.Collections.Generic.IList<System.Guid>" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="type">
User specified object type as a search filter. Possible values include:
'FaceList', 'LargeFaceList', 'LargePersonGroup', 'PersonGroup'
</param>
<param name="applyScope">
User specified snapshot apply scopes as a search filter. ApplyScope is an
array of the target Azure subscription ids for the snapshot, specified by
the user who created the snapshot by Snapshot - Take.
</param>
<param name="customHeaders">
Headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<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).
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Azure.CognitiveServices.Vision.Face.Models.APIErrorException">
Thrown when the operation returned an invalid status code
</exception>
<exception cref="T:Microsoft.Rest.SerializationException">
Thrown when unable to deserialize the response
</exception>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown when a required parameter is null
</exception>
<exception cref="T:System.ArgumentNullException">
Thrown when a required parameter is null
</exception>
<return>
A response object containing the response body and response headers.
</return>
</Docs>
</Member>
<Member MemberName="TakeWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationHeaderResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotTakeHeaders>> TakeWithHttpMessagesAsync (Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotObjectType type, string objectId, System.Collections.Generic.IList<Guid> applyScope, string userData = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationHeaderResponse`1<class Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotTakeHeaders>> TakeWithHttpMessagesAsync(valuetype Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotObjectType type, string objectId, class System.Collections.Generic.IList`1<valuetype System.Guid> applyScope, string userData, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.SnapshotOperations.TakeWithHttpMessagesAsync(Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotObjectType,System.String,System.Collections.Generic.IList{System.Guid},System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function TakeWithHttpMessagesAsync (type As SnapshotObjectType, objectId As String, applyScope As IList(Of Guid), Optional userData As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationHeaderResponse(Of SnapshotTakeHeaders))" />
<MemberSignature Language="F#" Value="abstract member TakeWithHttpMessagesAsync : Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotObjectType * string * System.Collections.Generic.IList<Guid> * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationHeaderResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotTakeHeaders>>
override this.TakeWithHttpMessagesAsync : Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotObjectType * string * System.Collections.Generic.IList<Guid> * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationHeaderResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotTakeHeaders>>" Usage="snapshotOperations.TakeWithHttpMessagesAsync (type, objectId, applyScope, userData, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.CognitiveServices.Vision.Face.ISnapshotOperations.TakeWithHttpMessagesAsync(Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotObjectType,System.String,System.Collections.Generic.IList{System.Guid},System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationHeaderResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotTakeHeaders>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="type" Type="Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotObjectType" />
<Parameter Name="objectId" Type="System.String" />
<Parameter Name="applyScope" Type="System.Collections.Generic.IList<System.Guid>" />
<Parameter Name="userData" Type="System.String" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="type">
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'
</param>
<param name="objectId">
User specified source object id to take snapshot from.
</param>
<param name="applyScope">
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.
</param>
<param name="userData">
User specified data about the snapshot for any purpose. Length should not
exceed 16KB.
</param>
<param name="customHeaders">
Headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<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.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Azure.CognitiveServices.Vision.Face.Models.APIErrorException">
Thrown when the operation returned an invalid status code
</exception>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown when a required parameter is null
</exception>
<exception cref="T:System.ArgumentNullException">
Thrown when a required parameter is null
</exception>
<return>
A response object containing the response body and response headers.
</return>
</Docs>
</Member>
<Member MemberName="UpdateWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse> UpdateWithHttpMessagesAsync (Guid snapshotId, System.Collections.Generic.IList<Guid> applyScope = default, string userData = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse> UpdateWithHttpMessagesAsync(valuetype System.Guid snapshotId, class System.Collections.Generic.IList`1<valuetype System.Guid> applyScope, string userData, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.SnapshotOperations.UpdateWithHttpMessagesAsync(System.Guid,System.Collections.Generic.IList{System.Guid},System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function UpdateWithHttpMessagesAsync (snapshotId As Guid, Optional applyScope As IList(Of Guid) = Nothing, Optional userData As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse)" />
<MemberSignature Language="F#" Value="abstract member UpdateWithHttpMessagesAsync : Guid * System.Collections.Generic.IList<Guid> * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse>
override this.UpdateWithHttpMessagesAsync : Guid * System.Collections.Generic.IList<Guid> * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse>" Usage="snapshotOperations.UpdateWithHttpMessagesAsync (snapshotId, applyScope, userData, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.CognitiveServices.Vision.Face.ISnapshotOperations.UpdateWithHttpMessagesAsync(System.Guid,System.Collections.Generic.IList{System.Guid},System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="snapshotId" Type="System.Guid" />
<Parameter Name="applyScope" Type="System.Collections.Generic.IList<System.Guid>" />
<Parameter Name="userData" Type="System.String" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="snapshotId">
Id referencing a particular snapshot.
</param>
<param name="applyScope">
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.
</param>
<param name="userData">
User specified data about the snapshot for any purpose. Length should not
exceed 16KB.
</param>
<param name="customHeaders">
Headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Update the information of a snapshot. Only the source subscription who took
the snapshot can update the snapshot.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Azure.CognitiveServices.Vision.Face.Models.APIErrorException">
Thrown when the operation returned an invalid status code
</exception>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown when a required parameter is null
</exception>
<exception cref="T:System.ArgumentNullException">
Thrown when a required parameter is null
</exception>
<return>
A response object containing the response body and response headers.
</return>
</Docs>
</Member>
</Members>
</Type>