/
ProvisioningServiceClient.yml
716 lines (716 loc) · 25.8 KB
/
ProvisioningServiceClient.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
### YamlMime:TSType
name: ProvisioningServiceClient
uid: azure-iot-provisioning-service.ProvisioningServiceClient
package: azure-iot-provisioning-service
summary: ''
fullName: ProvisioningServiceClient
remarks: ''
isDeprecated: false
type: class
constructors:
- name: ProvisioningServiceClient(TransportConfig, RestApiClient)
uid: azure-iot-provisioning-service.ProvisioningServiceClient.constructor
package: azure-iot-provisioning-service
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
new ProvisioningServiceClient(config: TransportConfig, restApiClient?:
RestApiClient)
parameters:
- id: config
type: TransportConfig
description: ''
- id: restApiClient
type: RestApiClient
description: ''
methods:
- name: >-
createEnrollmentGroupDeviceRegistrationStateQuery(QuerySpecification,
string, number)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.createEnrollmentGroupDeviceRegistrationStateQuery
package: azure-iot-provisioning-service
summary: >-
Creates a query that can be used to return, for a specific
EnrollmentGroup, pages of existing device registration status.
remarks: ''
isDeprecated: false
syntax:
content: >-
function
createEnrollmentGroupDeviceRegistrationStateQuery(querySpecification:
QuerySpecification, enrollmentGroupId: string, pageSize?: number): Query
parameters:
- id: querySpecification
type: QuerySpecification
description: The query specification.
- id: enrollmentGroupId
type: string
description: The EnrollmentGroup id that provides the scope for the query.
- id: pageSize
type: number
description: The maximum number of elements to return per page.
return:
description: ''
type: Query
- name: createEnrollmentGroupQuery(QuerySpecification, number)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.createEnrollmentGroupQuery
package: azure-iot-provisioning-service
summary: >-
Creates a query that can be used to return pages of existing enrollment
groups.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createEnrollmentGroupQuery(querySpecification:
QuerySpecification, pageSize?: number): Query
parameters:
- id: querySpecification
type: QuerySpecification
description: The query specification.
- id: pageSize
type: number
description: The maximum number of elements to return per page.
return:
description: ''
type: Query
- name: createIndividualEnrollmentQuery(QuerySpecification, number)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.createIndividualEnrollmentQuery
package: azure-iot-provisioning-service
summary: Creates a query that can be used to return pages of existing enrollments.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createIndividualEnrollmentQuery(querySpecification:
QuerySpecification, pageSize?: number): Query
parameters:
- id: querySpecification
type: QuerySpecification
description: The query specification.
- id: pageSize
type: number
description: The maximum number of elements to return per page.
return:
description: ''
type: Query
- name: createOrUpdateEnrollmentGroup(EnrollmentGroup)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.createOrUpdateEnrollmentGroup_1
package: azure-iot-provisioning-service
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function createOrUpdateEnrollmentGroup(enrollmentGroup:
EnrollmentGroup): Promise<ResultWithHttpResponse<EnrollmentGroup>>
parameters:
- id: enrollmentGroup
type: EnrollmentGroup
description: ''
return:
description: ''
type: Promise<ResultWithHttpResponse<EnrollmentGroup>>
- name: >-
createOrUpdateEnrollmentGroup(EnrollmentGroup,
HttpResponseCallback<EnrollmentGroup>)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.createOrUpdateEnrollmentGroup
package: azure-iot-provisioning-service
summary: Create or update a device enrollment group.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createOrUpdateEnrollmentGroup(enrollmentGroup: EnrollmentGroup,
callback?: HttpResponseCallback<EnrollmentGroup>)
parameters:
- id: enrollmentGroup
type: EnrollmentGroup
description: The device enrollment group.
- id: callback
type: HttpResponseCallback<EnrollmentGroup>
description: Invoked upon completion of the operation.
- name: createOrUpdateIndividualEnrollment(IndividualEnrollment)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.createOrUpdateIndividualEnrollment_1
package: azure-iot-provisioning-service
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function createOrUpdateIndividualEnrollment(enrollment:
IndividualEnrollment):
Promise<ResultWithHttpResponse<IndividualEnrollment>>
parameters:
- id: enrollment
type: IndividualEnrollment
description: ''
return:
description: ''
type: Promise<ResultWithHttpResponse<IndividualEnrollment>>
- name: >-
createOrUpdateIndividualEnrollment(IndividualEnrollment,
HttpResponseCallback<IndividualEnrollment>)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.createOrUpdateIndividualEnrollment
package: azure-iot-provisioning-service
summary: Create or update a device enrollment record.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createOrUpdateIndividualEnrollment(enrollment:
IndividualEnrollment, callback?:
HttpResponseCallback<IndividualEnrollment>)
parameters:
- id: enrollment
type: IndividualEnrollment
description: The device enrollment record.
- id: callback
type: HttpResponseCallback<IndividualEnrollment>
description: Invoked upon completion of the operation.
- name: deleteDeviceRegistrationState(string | DeviceRegistrationState)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.deleteDeviceRegistrationState_3
package: azure-iot-provisioning-service
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteDeviceRegistrationState(idOrRegistrationState: string |
DeviceRegistrationState): Promise<void>
parameters:
- id: idOrRegistrationState
type: string | DeviceRegistrationState
description: ''
return:
description: ''
type: Promise<void>
- name: >-
deleteDeviceRegistrationState(string | DeviceRegistrationState,
ErrorCallback)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.deleteDeviceRegistrationState_1
package: azure-iot-provisioning-service
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteDeviceRegistrationState(idOrRegistrationState: string |
DeviceRegistrationState, deleteCallback: ErrorCallback)
parameters:
- id: idOrRegistrationState
type: string | DeviceRegistrationState
description: ''
- id: deleteCallback
type: ErrorCallback
description: ''
- name: deleteDeviceRegistrationState(string | DeviceRegistrationState, string)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.deleteDeviceRegistrationState_2
package: azure-iot-provisioning-service
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteDeviceRegistrationState(idOrRegistrationState: string |
DeviceRegistrationState, etag: string): Promise<void>
parameters:
- id: idOrRegistrationState
type: string | DeviceRegistrationState
description: ''
- id: etag
type: string
description: ''
return:
description: ''
type: Promise<void>
- name: >-
deleteDeviceRegistrationState(string | DeviceRegistrationState, string,
ErrorCallback)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.deleteDeviceRegistrationState
package: azure-iot-provisioning-service
summary: Delete a device registration status.
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteDeviceRegistrationState(idOrRegistrationState: string |
DeviceRegistrationState, etag: string, deleteCallback?: ErrorCallback)
parameters:
- id: idOrRegistrationState
type: string | DeviceRegistrationState
description: >-
A string containing the registration id OR an actual
DeviceRegistrationState.
- id: etag
type: string
description: ''
- id: deleteCallback
type: ErrorCallback
description: Invoked upon completion of the operation.
- name: deleteEnrollmentGroup(string | EnrollmentGroup)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.deleteEnrollmentGroup_3
package: azure-iot-provisioning-service
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteEnrollmentGroup(enrollmentGroupOrId: string |
EnrollmentGroup): Promise<void>
parameters:
- id: enrollmentGroupOrId
type: string | EnrollmentGroup
description: ''
return:
description: ''
type: Promise<void>
- name: deleteEnrollmentGroup(string | EnrollmentGroup, ErrorCallback)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.deleteEnrollmentGroup_1
package: azure-iot-provisioning-service
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteEnrollmentGroup(enrollmentGroupOrId: string |
EnrollmentGroup, deleteCallback: ErrorCallback)
parameters:
- id: enrollmentGroupOrId
type: string | EnrollmentGroup
description: ''
- id: deleteCallback
type: ErrorCallback
description: ''
- name: deleteEnrollmentGroup(string | EnrollmentGroup, string)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.deleteEnrollmentGroup_2
package: azure-iot-provisioning-service
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteEnrollmentGroup(enrollmentGroupOrId: string |
EnrollmentGroup, etag: string): Promise<void>
parameters:
- id: enrollmentGroupOrId
type: string | EnrollmentGroup
description: ''
- id: etag
type: string
description: ''
return:
description: ''
type: Promise<void>
- name: deleteEnrollmentGroup(string | EnrollmentGroup, string, ErrorCallback)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.deleteEnrollmentGroup
package: azure-iot-provisioning-service
summary: Delete a device enrollment group.
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteEnrollmentGroup(enrollmentGroupOrId: string |
EnrollmentGroup, etag: string, deleteCallback?: ErrorCallback)
parameters:
- id: enrollmentGroupOrId
type: string | EnrollmentGroup
description: >-
EnrollmentGroup object or a string containing the enrollment Group
Id.
- id: etag
type: string
description: ''
- id: deleteCallback
type: ErrorCallback
description: Invoked upon completion of the operation.
- name: deleteIndividualEnrollment(string | IndividualEnrollment)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.deleteIndividualEnrollment_3
package: azure-iot-provisioning-service
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteIndividualEnrollment(enrollmentOrId: string |
IndividualEnrollment): Promise<void>
parameters:
- id: enrollmentOrId
type: string | IndividualEnrollment
description: ''
return:
description: ''
type: Promise<void>
- name: deleteIndividualEnrollment(string | IndividualEnrollment, ErrorCallback)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.deleteIndividualEnrollment_1
package: azure-iot-provisioning-service
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteIndividualEnrollment(enrollmentOrId: string |
IndividualEnrollment, deleteCallback: ErrorCallback)
parameters:
- id: enrollmentOrId
type: string | IndividualEnrollment
description: ''
- id: deleteCallback
type: ErrorCallback
description: ''
- name: deleteIndividualEnrollment(string | IndividualEnrollment, string)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.deleteIndividualEnrollment_2
package: azure-iot-provisioning-service
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteIndividualEnrollment(enrollmentOrId: string |
IndividualEnrollment, etag: string): Promise<void>
parameters:
- id: enrollmentOrId
type: string | IndividualEnrollment
description: ''
- id: etag
type: string
description: ''
return:
description: ''
type: Promise<void>
- name: >-
deleteIndividualEnrollment(string | IndividualEnrollment, string,
ErrorCallback)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.deleteIndividualEnrollment
package: azure-iot-provisioning-service
summary: Delete a device enrollment record.
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteIndividualEnrollment(enrollmentOrId: string |
IndividualEnrollment, etag: string, deleteCallback?: ErrorCallback)
parameters:
- id: enrollmentOrId
type: string | IndividualEnrollment
description: >-
An IndividualEnrollment object or a string containing the
registration id.
- id: etag
type: string
description: ''
- id: deleteCallback
type: ErrorCallback
description: Invoked upon completion of the operation.
- name: fromConnectionString(string)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.fromConnectionString
package: azure-iot-provisioning-service
summary: |-
Constructs a ProvisioningServiceClient object from the given connection
string using the default transport
([Http](xref:azure-iothub.Http)).
remarks: ''
isDeprecated: false
syntax:
content: >-
static function fromConnectionString(value: string):
ProvisioningServiceClient
parameters:
- id: value
type: string
description: |-
A connection string which encapsulates the
appropriate (read and/or write) ProvisioningServiceClient
permissions.
return:
description: ''
type: >-
<xref uid="azure-iot-provisioning-service.ProvisioningServiceClient"
/>
- name: fromTokenCredential(string, TokenCredential)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.fromTokenCredential
package: azure-iot-provisioning-service
summary: >-
Constructs a ProvisioningServiceClient object from the given Azure
TokenCredential
using the default transport
([Http](xref:azure-iothub.Http)).
remarks: ''
isDeprecated: false
syntax:
content: >-
static function fromTokenCredential(hostName: string, tokenCredential:
TokenCredential): ProvisioningServiceClient
parameters:
- id: hostName
type: string
description: Host name of the Azure service.
- id: tokenCredential
type: <xref uid="@azure/core-auth.TokenCredential" />
description: |-
An Azure TokenCredential used to authenticate
with the Azure service
return:
description: ''
type: >-
<xref uid="azure-iot-provisioning-service.ProvisioningServiceClient"
/>
- name: getDeviceRegistrationState(string)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.getDeviceRegistrationState_1
package: azure-iot-provisioning-service
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function getDeviceRegistrationState(id: string):
Promise<ResultWithHttpResponse<DeviceRegistrationState>>
parameters:
- id: id
type: string
description: ''
return:
description: ''
type: Promise<ResultWithHttpResponse<DeviceRegistrationState>>
- name: >-
getDeviceRegistrationState(string,
HttpResponseCallback<DeviceRegistrationState>)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.getDeviceRegistrationState
package: azure-iot-provisioning-service
summary: Gets the device registration status.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getDeviceRegistrationState(id: string, callback?:
HttpResponseCallback<DeviceRegistrationState>)
parameters:
- id: id
type: string
description: Registration ID.
- id: callback
type: HttpResponseCallback<DeviceRegistrationState>
description: Invoked upon completion of the operation.
- name: getEnrollmentGroup(string)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.getEnrollmentGroup_1
package: azure-iot-provisioning-service
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function getEnrollmentGroup(id: string):
Promise<ResultWithHttpResponse<EnrollmentGroup>>
parameters:
- id: id
type: string
description: ''
return:
description: ''
type: Promise<ResultWithHttpResponse<EnrollmentGroup>>
- name: getEnrollmentGroup(string, HttpResponseCallback<EnrollmentGroup>)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.getEnrollmentGroup
package: azure-iot-provisioning-service
summary: Get a device enrollment group.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getEnrollmentGroup(id: string, getCallback?:
HttpResponseCallback<EnrollmentGroup>)
parameters:
- id: id
type: string
description: IndividualEnrollment group ID.
- id: getCallback
type: HttpResponseCallback<EnrollmentGroup>
description: Invoked upon completion of the operation.
- name: getEnrollmentGroupAttestationMechanism(string)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.getEnrollmentGroupAttestationMechanism_1
package: azure-iot-provisioning-service
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function getEnrollmentGroupAttestationMechanism(enrollmentGroupId:
string): Promise<ResultWithHttpResponse<AttestationMechanism>>
parameters:
- id: enrollmentGroupId
type: string
description: ''
return:
description: ''
type: Promise<ResultWithHttpResponse<AttestationMechanism>>
- name: >-
getEnrollmentGroupAttestationMechanism(string,
HttpResponseCallback<AttestationMechanism>)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.getEnrollmentGroupAttestationMechanism
package: azure-iot-provisioning-service
summary: Gets the attestation mechanism for an EnrollmentGroup record.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getEnrollmentGroupAttestationMechanism(enrollmentGroupId:
string, callback: HttpResponseCallback<AttestationMechanism>)
parameters:
- id: enrollmentGroupId
type: string
description: Unique identifier of the EnrollmentGroup.
- id: callback
type: HttpResponseCallback<AttestationMechanism>
description: >-
Function called when the request is completed, either with an error
or with an AttestationMechanism object.
- name: getIndividualEnrollment(string)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.getIndividualEnrollment_1
package: azure-iot-provisioning-service
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function getIndividualEnrollment(id: string):
Promise<ResultWithHttpResponse<IndividualEnrollment>>
parameters:
- id: id
type: string
description: ''
return:
description: ''
type: Promise<ResultWithHttpResponse<IndividualEnrollment>>
- name: >-
getIndividualEnrollment(string,
HttpResponseCallback<IndividualEnrollment>)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.getIndividualEnrollment
package: azure-iot-provisioning-service
summary: Get a device enrollment record.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getIndividualEnrollment(id: string, getCallback?:
HttpResponseCallback<IndividualEnrollment>)
parameters:
- id: id
type: string
description: Registration ID.
- id: getCallback
type: HttpResponseCallback<IndividualEnrollment>
description: Invoked upon completion of the operation.
- name: getIndividualEnrollmentAttestationMechanism(string)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.getIndividualEnrollmentAttestationMechanism_1
package: azure-iot-provisioning-service
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function getIndividualEnrollmentAttestationMechanism(enrollmentId:
string): Promise<ResultWithHttpResponse<AttestationMechanism>>
parameters:
- id: enrollmentId
type: string
description: ''
return:
description: ''
type: Promise<ResultWithHttpResponse<AttestationMechanism>>
- name: >-
getIndividualEnrollmentAttestationMechanism(string,
HttpResponseCallback<AttestationMechanism>)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.getIndividualEnrollmentAttestationMechanism
package: azure-iot-provisioning-service
summary: Gets the attestation mechanism for an IndividualEnrollment record.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getIndividualEnrollmentAttestationMechanism(enrollmentId:
string, callback: HttpResponseCallback<AttestationMechanism>)
parameters:
- id: enrollmentId
type: string
description: Unique identifier of the enrollment.
- id: callback
type: HttpResponseCallback<AttestationMechanism>
description: >-
Function called when the request is completed, either with an error
or with an AttestationMechanism object.
- name: runBulkEnrollmentOperation(BulkEnrollmentOperation)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.runBulkEnrollmentOperation_1
package: azure-iot-provisioning-service
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function runBulkEnrollmentOperation(bulkEnrollmentOperation:
BulkEnrollmentOperation):
Promise<ResultWithHttpResponse<BulkEnrollmentOperationResult>>
parameters:
- id: bulkEnrollmentOperation
type: BulkEnrollmentOperation
description: ''
return:
description: ''
type: >-
Promise<ResultWithHttpResponse<BulkEnrollmentOperationResult>>
- name: >-
runBulkEnrollmentOperation(BulkEnrollmentOperation,
HttpResponseCallback<BulkEnrollmentOperationResult>)
uid: >-
azure-iot-provisioning-service.ProvisioningServiceClient.runBulkEnrollmentOperation
package: azure-iot-provisioning-service
summary: Runs a number CRUD operations on an array of enrollment records.
remarks: ''
isDeprecated: false
syntax:
content: >-
function runBulkEnrollmentOperation(bulkEnrollmentOperation:
BulkEnrollmentOperation, callback:
HttpResponseCallback<BulkEnrollmentOperationResult>)
parameters:
- id: bulkEnrollmentOperation
type: BulkEnrollmentOperation
description: >-
An object that specifies the single kind of CRUD operations on the
array of IndividualEnrollment objects that are also part of the
object.
- id: callback
type: HttpResponseCallback<BulkEnrollmentOperationResult>
description: Invoked upon completion of the operation.