@azure/arm-databox 3.0.0 → 5.0.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (142) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/LICENSE +21 -0
  3. package/README.md +72 -73
  4. package/dist/index.js +5592 -0
  5. package/dist/index.js.map +1 -0
  6. package/dist/index.min.js +1 -0
  7. package/dist/index.min.js.map +1 -0
  8. package/dist-esm/src/dataBoxManagementClient.d.ts +29 -0
  9. package/dist-esm/src/dataBoxManagementClient.d.ts.map +1 -0
  10. package/dist-esm/src/dataBoxManagementClient.js +89 -0
  11. package/dist-esm/src/dataBoxManagementClient.js.map +1 -0
  12. package/dist-esm/src/index.d.ts +5 -0
  13. package/dist-esm/src/index.d.ts.map +1 -0
  14. package/dist-esm/src/index.js +12 -0
  15. package/dist-esm/src/index.js.map +1 -0
  16. package/dist-esm/src/lroImpl.d.ts +16 -0
  17. package/dist-esm/src/lroImpl.d.ts.map +1 -0
  18. package/dist-esm/src/lroImpl.js +29 -0
  19. package/dist-esm/src/lroImpl.js.map +1 -0
  20. package/dist-esm/src/models/index.d.ts +2157 -0
  21. package/dist-esm/src/models/index.d.ts.map +1 -0
  22. package/dist-esm/src/models/index.js +168 -0
  23. package/dist-esm/src/models/index.js.map +1 -0
  24. package/dist-esm/src/models/mappers.d.ts +163 -0
  25. package/dist-esm/src/models/mappers.d.ts.map +1 -0
  26. package/dist-esm/src/models/mappers.js +3911 -0
  27. package/dist-esm/src/models/mappers.js.map +1 -0
  28. package/dist-esm/src/models/parameters.d.ts +24 -0
  29. package/dist-esm/src/models/parameters.d.ts.map +1 -0
  30. package/dist-esm/src/models/parameters.js +176 -0
  31. package/dist-esm/src/models/parameters.js.map +1 -0
  32. package/{esm → dist-esm/src}/operations/index.d.ts +0 -0
  33. package/dist-esm/src/operations/index.d.ts.map +1 -0
  34. package/dist-esm/src/operations/index.js +11 -0
  35. package/dist-esm/src/operations/index.js.map +1 -0
  36. package/dist-esm/src/operations/jobs.d.ts +161 -0
  37. package/dist-esm/src/operations/jobs.d.ts.map +1 -0
  38. package/dist-esm/src/operations/jobs.js +687 -0
  39. package/dist-esm/src/operations/jobs.js.map +1 -0
  40. package/dist-esm/src/operations/operations.d.ts +32 -0
  41. package/dist-esm/src/operations/operations.d.ts.map +1 -0
  42. package/dist-esm/src/operations/operations.js +120 -0
  43. package/dist-esm/src/operations/operations.js.map +1 -0
  44. package/dist-esm/src/operations/service.d.ts +83 -0
  45. package/dist-esm/src/operations/service.d.ts.map +1 -0
  46. package/dist-esm/src/operations/service.js +307 -0
  47. package/dist-esm/src/operations/service.js.map +1 -0
  48. package/dist-esm/src/operationsInterfaces/index.d.ts +4 -0
  49. package/dist-esm/src/operationsInterfaces/index.d.ts.map +1 -0
  50. package/dist-esm/src/operationsInterfaces/index.js +11 -0
  51. package/dist-esm/src/operationsInterfaces/index.js.map +1 -0
  52. package/dist-esm/src/operationsInterfaces/jobs.d.ts +115 -0
  53. package/dist-esm/src/operationsInterfaces/jobs.d.ts.map +1 -0
  54. package/dist-esm/src/operationsInterfaces/jobs.js +9 -0
  55. package/dist-esm/src/operationsInterfaces/jobs.js.map +1 -0
  56. package/dist-esm/src/operationsInterfaces/operations.d.ts +11 -0
  57. package/dist-esm/src/operationsInterfaces/operations.d.ts.map +1 -0
  58. package/dist-esm/src/operationsInterfaces/operations.js +9 -0
  59. package/dist-esm/src/operationsInterfaces/operations.js.map +1 -0
  60. package/dist-esm/src/operationsInterfaces/service.d.ts +54 -0
  61. package/dist-esm/src/operationsInterfaces/service.d.ts.map +1 -0
  62. package/dist-esm/src/operationsInterfaces/service.js +9 -0
  63. package/dist-esm/src/operationsInterfaces/service.js.map +1 -0
  64. package/dist-esm/test/sampleTest.d.ts +2 -0
  65. package/dist-esm/test/sampleTest.d.ts.map +1 -0
  66. package/dist-esm/test/sampleTest.js +40 -0
  67. package/dist-esm/test/sampleTest.js.map +1 -0
  68. package/package.json +65 -31
  69. package/review/arm-databox.api.md +1376 -0
  70. package/rollup.config.js +181 -30
  71. package/src/dataBoxManagementClient.ts +113 -29
  72. package/src/index.ts +12 -0
  73. package/src/lroImpl.ts +34 -0
  74. package/src/models/index.ts +1924 -1354
  75. package/src/models/mappers.ts +3160 -1086
  76. package/src/models/parameters.ts +144 -54
  77. package/src/operations/index.ts +3 -5
  78. package/src/operations/jobs.ts +702 -480
  79. package/src/operations/operations.ts +89 -75
  80. package/src/operations/service.ts +342 -127
  81. package/src/operationsInterfaces/index.ts +11 -0
  82. package/src/operationsInterfaces/jobs.ts +205 -0
  83. package/src/operationsInterfaces/operations.ts +22 -0
  84. package/src/operationsInterfaces/service.ts +107 -0
  85. package/tsconfig.json +3 -3
  86. package/types/arm-databox.d.ts +2558 -0
  87. package/types/tsdoc-metadata.json +11 -0
  88. package/dist/arm-databox.js +0 -3090
  89. package/dist/arm-databox.js.map +0 -1
  90. package/dist/arm-databox.min.js +0 -1
  91. package/dist/arm-databox.min.js.map +0 -1
  92. package/esm/dataBoxManagementClient.d.ts +0 -20
  93. package/esm/dataBoxManagementClient.d.ts.map +0 -1
  94. package/esm/dataBoxManagementClient.js +0 -35
  95. package/esm/dataBoxManagementClient.js.map +0 -1
  96. package/esm/dataBoxManagementClientContext.d.ts +0 -16
  97. package/esm/dataBoxManagementClientContext.d.ts.map +0 -1
  98. package/esm/dataBoxManagementClientContext.js +0 -57
  99. package/esm/dataBoxManagementClientContext.js.map +0 -1
  100. package/esm/models/index.d.ts +0 -1754
  101. package/esm/models/index.d.ts.map +0 -1
  102. package/esm/models/index.js +0 -8
  103. package/esm/models/index.js.map +0 -1
  104. package/esm/models/jobsMappers.d.ts +0 -2
  105. package/esm/models/jobsMappers.d.ts.map +0 -1
  106. package/esm/models/jobsMappers.js +0 -9
  107. package/esm/models/jobsMappers.js.map +0 -1
  108. package/esm/models/mappers.d.ts +0 -75
  109. package/esm/models/mappers.d.ts.map +0 -1
  110. package/esm/models/mappers.js +0 -2020
  111. package/esm/models/mappers.js.map +0 -1
  112. package/esm/models/operationsMappers.d.ts +0 -2
  113. package/esm/models/operationsMappers.d.ts.map +0 -1
  114. package/esm/models/operationsMappers.js +0 -9
  115. package/esm/models/operationsMappers.js.map +0 -1
  116. package/esm/models/parameters.d.ts +0 -12
  117. package/esm/models/parameters.d.ts.map +0 -1
  118. package/esm/models/parameters.js +0 -122
  119. package/esm/models/parameters.js.map +0 -1
  120. package/esm/models/serviceMappers.d.ts +0 -2
  121. package/esm/models/serviceMappers.d.ts.map +0 -1
  122. package/esm/models/serviceMappers.js +0 -9
  123. package/esm/models/serviceMappers.js.map +0 -1
  124. package/esm/operations/index.d.ts.map +0 -1
  125. package/esm/operations/index.js +0 -13
  126. package/esm/operations/index.js.map +0 -1
  127. package/esm/operations/jobs.d.ts +0 -245
  128. package/esm/operations/jobs.d.ts.map +0 -1
  129. package/esm/operations/jobs.js +0 -444
  130. package/esm/operations/jobs.js.map +0 -1
  131. package/esm/operations/operations.d.ts +0 -46
  132. package/esm/operations/operations.d.ts.map +0 -1
  133. package/esm/operations/operations.js +0 -77
  134. package/esm/operations/operations.js.map +0 -1
  135. package/esm/operations/service.d.ts +0 -79
  136. package/esm/operations/service.d.ts.map +0 -1
  137. package/esm/operations/service.js +0 -126
  138. package/esm/operations/service.js.map +0 -1
  139. package/src/dataBoxManagementClientContext.ts +0 -69
  140. package/src/models/jobsMappers.ts +0 -55
  141. package/src/models/operationsMappers.ts +0 -15
  142. package/src/models/serviceMappers.ts +0 -22
@@ -1,1754 +0,0 @@
1
- import { BaseResource, CloudError, AzureServiceClientOptions } from "@azure/ms-rest-azure-js";
2
- import * as msRest from "@azure/ms-rest-js";
3
- export { BaseResource, CloudError };
4
- /**
5
- * Credential details of the shares in account.
6
- */
7
- export interface ShareCredentialDetails {
8
- /**
9
- * Name of the share.
10
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
11
- */
12
- readonly shareName?: string;
13
- /**
14
- * Type of the share. Possible values include: 'UnknownType', 'HCS', 'BlockBlob', 'PageBlob',
15
- * 'AzureFile', 'ManagedDisk'
16
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
17
- */
18
- readonly shareType?: ShareDestinationFormatType;
19
- /**
20
- * User name for the share.
21
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
22
- */
23
- readonly userName?: string;
24
- /**
25
- * Password for the share.
26
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
27
- */
28
- readonly password?: string;
29
- /**
30
- * Access protocols supported on the device.
31
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
32
- */
33
- readonly supportedAccessProtocols?: AccessProtocol[];
34
- }
35
- /**
36
- * Credential details of the account.
37
- */
38
- export interface AccountCredentialDetails {
39
- /**
40
- * Name of the account.
41
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
42
- */
43
- readonly accountName?: string;
44
- /**
45
- * Connection string of the account endpoint to use the account as a storage endpoint on the
46
- * device.
47
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
48
- */
49
- readonly accountConnectionString?: string;
50
- /**
51
- * Per share level unencrypted access credentials.
52
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
53
- */
54
- readonly shareCredentialDetails?: ShareCredentialDetails[];
55
- }
56
- /**
57
- * Shipping address where customer wishes to receive the device.
58
- */
59
- export interface ShippingAddress {
60
- /**
61
- * Street Address line 1.
62
- */
63
- streetAddress1: string;
64
- /**
65
- * Street Address line 2.
66
- */
67
- streetAddress2?: string;
68
- /**
69
- * Street Address line 3.
70
- */
71
- streetAddress3?: string;
72
- /**
73
- * Name of the City.
74
- */
75
- city?: string;
76
- /**
77
- * Name of the State or Province.
78
- */
79
- stateOrProvince?: string;
80
- /**
81
- * Name of the Country.
82
- */
83
- country: string;
84
- /**
85
- * Postal code.
86
- */
87
- postalCode: string;
88
- /**
89
- * Extended Zip Code.
90
- */
91
- zipExtendedCode?: string;
92
- /**
93
- * Name of the company.
94
- */
95
- companyName?: string;
96
- /**
97
- * Type of address. Possible values include: 'None', 'Residential', 'Commercial'
98
- */
99
- addressType?: AddressType;
100
- }
101
- /**
102
- * Output of the address validation api.
103
- */
104
- export interface AddressValidationOutput {
105
- /**
106
- * The address validation status. Possible values include: 'Valid', 'Invalid', 'Ambiguous'
107
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
108
- */
109
- readonly validationStatus?: AddressValidationStatus;
110
- /**
111
- * List of alternate addresses.
112
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
113
- */
114
- readonly alternateAddresses?: ShippingAddress[];
115
- }
116
- /**
117
- * The Network Adapter configuration of a DataBox.
118
- */
119
- export interface ApplianceNetworkConfiguration {
120
- /**
121
- * Name of the network.
122
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
123
- */
124
- readonly name?: string;
125
- /**
126
- * Mac Address.
127
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
128
- */
129
- readonly macAddress?: string;
130
- }
131
- /**
132
- * Base class for all objects under resource.
133
- */
134
- export interface ArmBaseObject {
135
- /**
136
- * Name of the object.
137
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
138
- */
139
- readonly name?: string;
140
- /**
141
- * Id of the object.
142
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
143
- */
144
- readonly id?: string;
145
- /**
146
- * Type of the object.
147
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
148
- */
149
- readonly type?: string;
150
- }
151
- /**
152
- * The filters for showing the available skus.
153
- */
154
- export interface AvailableSkuRequest {
155
- /**
156
- * ISO country code. Country for hardware shipment. For codes check:
157
- * https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
158
- */
159
- country: string;
160
- /**
161
- * Location for data transfer. For locations check:
162
- * https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01
163
- */
164
- location: string;
165
- /**
166
- * Sku Names to filter for available skus
167
- */
168
- skuNames?: SkuName[];
169
- }
170
- /**
171
- * The Sku.
172
- */
173
- export interface Sku {
174
- /**
175
- * The sku name. Possible values include: 'DataBox', 'DataBoxDisk', 'DataBoxHeavy'
176
- */
177
- name: SkuName;
178
- /**
179
- * The display name of the sku.
180
- */
181
- displayName?: string;
182
- /**
183
- * The sku family.
184
- */
185
- family?: string;
186
- }
187
- /**
188
- * Map of destination location to service location
189
- */
190
- export interface DestinationToServiceLocationMap {
191
- /**
192
- * Location of the destination.
193
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
194
- */
195
- readonly destinationLocation?: string;
196
- /**
197
- * Location of the service.
198
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
199
- */
200
- readonly serviceLocation?: string;
201
- }
202
- /**
203
- * Capacity of the sku.
204
- */
205
- export interface SkuCapacity {
206
- /**
207
- * Usable capacity in TB.
208
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
209
- */
210
- readonly usable?: string;
211
- /**
212
- * Maximum capacity in TB.
213
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
214
- */
215
- readonly maximum?: string;
216
- }
217
- /**
218
- * Describes metadata for retrieving price info.
219
- */
220
- export interface SkuCost {
221
- /**
222
- * Meter id of the Sku.
223
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
224
- */
225
- readonly meterId?: string;
226
- /**
227
- * The type of the meter.
228
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
229
- */
230
- readonly meterType?: string;
231
- }
232
- /**
233
- * Information of the sku.
234
- */
235
- export interface SkuInformation {
236
- /**
237
- * The Sku.
238
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
239
- */
240
- readonly sku?: Sku;
241
- /**
242
- * The sku is enabled or not.
243
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
244
- */
245
- readonly enabled?: boolean;
246
- /**
247
- * The map of destination location to service location.
248
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
249
- */
250
- readonly destinationToServiceLocationMap?: DestinationToServiceLocationMap[];
251
- /**
252
- * Capacity of the Sku.
253
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
254
- */
255
- readonly capacity?: SkuCapacity;
256
- /**
257
- * Cost of the Sku.
258
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
259
- */
260
- readonly costs?: SkuCost[];
261
- /**
262
- * Api versions that support this Sku.
263
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
264
- */
265
- readonly apiVersions?: string[];
266
- /**
267
- * Reason why the Sku is disabled. Possible values include: 'None', 'Country', 'Region',
268
- * 'Feature', 'OfferType', 'NoSubscriptionInfo'
269
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
270
- */
271
- readonly disabledReason?: SkuDisabledReason;
272
- /**
273
- * Message for why the Sku is disabled.
274
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
275
- */
276
- readonly disabledReasonMessage?: string;
277
- /**
278
- * Required feature to access the sku.
279
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
280
- */
281
- readonly requiredFeature?: string;
282
- }
283
- /**
284
- * Reason for cancellation.
285
- */
286
- export interface CancellationReason {
287
- /**
288
- * Reason for cancellation.
289
- */
290
- reason: string;
291
- }
292
- /**
293
- * Notification preference for a job stage.
294
- */
295
- export interface NotificationPreference {
296
- /**
297
- * Name of the stage. Possible values include: 'DevicePrepared', 'Dispatched', 'Delivered',
298
- * 'PickedUp', 'AtAzureDC', 'DataCopy'
299
- */
300
- stageName: NotificationStageName;
301
- /**
302
- * Notification is required or not.
303
- */
304
- sendNotification: boolean;
305
- }
306
- /**
307
- * Contact Details.
308
- */
309
- export interface ContactDetails {
310
- /**
311
- * Contact name of the person.
312
- */
313
- contactName: string;
314
- /**
315
- * Phone number of the contact person.
316
- */
317
- phone: string;
318
- /**
319
- * Phone extension number of the contact person.
320
- */
321
- phoneExtension?: string;
322
- /**
323
- * Mobile number of the contact person.
324
- */
325
- mobile?: string;
326
- /**
327
- * List of Email-ids to be notified about job progress.
328
- */
329
- emailList: string[];
330
- /**
331
- * Notification preference for a job stage.
332
- */
333
- notificationPreference?: NotificationPreference[];
334
- }
335
- /**
336
- * Contains the possible cases for CopyLogDetails.
337
- */
338
- export declare type CopyLogDetailsUnion = CopyLogDetails | DataBoxAccountCopyLogDetails | DataBoxDiskCopyLogDetails | DataBoxHeavyAccountCopyLogDetails;
339
- /**
340
- * Details for log generated during copy.
341
- */
342
- export interface CopyLogDetails {
343
- /**
344
- * Polymorphic Discriminator
345
- */
346
- copyLogDetailsType: "CopyLogDetails";
347
- }
348
- /**
349
- * Copy progress.
350
- */
351
- export interface CopyProgress {
352
- /**
353
- * Name of the storage account where the data needs to be uploaded.
354
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
355
- */
356
- readonly storageAccountName?: string;
357
- /**
358
- * Id of the account where the data needs to be uploaded.
359
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
360
- */
361
- readonly accountId?: string;
362
- /**
363
- * Amount of data uploaded by the job as of now.
364
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
365
- */
366
- readonly bytesSentToCloud?: number;
367
- /**
368
- * Total amount of data to be processed by the job.
369
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
370
- */
371
- readonly totalBytesToProcess?: number;
372
- /**
373
- * Number of files processed by the job as of now.
374
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
375
- */
376
- readonly filesProcessed?: number;
377
- /**
378
- * Total number of files to be processed by the job.
379
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
380
- */
381
- readonly totalFilesToProcess?: number;
382
- }
383
- /**
384
- * Copy log details for a storage account of a DataBox job
385
- */
386
- export interface DataBoxAccountCopyLogDetails {
387
- /**
388
- * Polymorphic Discriminator
389
- */
390
- copyLogDetailsType: "DataBox";
391
- /**
392
- * Destination account name.
393
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
394
- */
395
- readonly accountName?: string;
396
- /**
397
- * Link for copy logs.
398
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
399
- */
400
- readonly copyLogLink?: string;
401
- }
402
- /**
403
- * Copy Log Details for a disk
404
- */
405
- export interface DataBoxDiskCopyLogDetails {
406
- /**
407
- * Polymorphic Discriminator
408
- */
409
- copyLogDetailsType: "DataBoxDisk";
410
- /**
411
- * Disk Serial Number.
412
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
413
- */
414
- readonly diskSerialNumber?: string;
415
- /**
416
- * Link for copy error logs.
417
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
418
- */
419
- readonly errorLogLink?: string;
420
- /**
421
- * Link for copy verbose logs.
422
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
423
- */
424
- readonly verboseLogLink?: string;
425
- }
426
- /**
427
- * DataBox Disk Copy Progress
428
- */
429
- export interface DataBoxDiskCopyProgress {
430
- /**
431
- * The serial number of the disk
432
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
433
- */
434
- readonly serialNumber?: string;
435
- /**
436
- * Bytes copied during the copy of disk.
437
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
438
- */
439
- readonly bytesCopied?: number;
440
- /**
441
- * Indicates the percentage completed for the copy of the disk.
442
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
443
- */
444
- readonly percentComplete?: number;
445
- /**
446
- * The Status of the copy. Possible values include: 'NotStarted', 'InProgress', 'Completed',
447
- * 'CompletedWithErrors', 'Failed', 'NotReturned'
448
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
449
- */
450
- readonly status?: CopyStatus;
451
- }
452
- /**
453
- * Contains the possible cases for JobDetails.
454
- */
455
- export declare type JobDetailsUnion = JobDetails | DataBoxDiskJobDetails | DataBoxHeavyJobDetails | DataBoxJobDetails;
456
- /**
457
- * Job details.
458
- */
459
- export interface JobDetails {
460
- /**
461
- * Polymorphic Discriminator
462
- */
463
- jobDetailsType: "JobDetails";
464
- /**
465
- * The expected size of the data, which needs to be transferred in this job, in terabytes.
466
- */
467
- expectedDataSizeInTeraBytes?: number;
468
- /**
469
- * List of stages that run in the job.
470
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
471
- */
472
- readonly jobStages?: JobStages[];
473
- /**
474
- * Contact details for notification and shipping.
475
- */
476
- contactDetails: ContactDetails;
477
- /**
478
- * Shipping address of the customer.
479
- */
480
- shippingAddress: ShippingAddress;
481
- /**
482
- * Delivery package shipping details.
483
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
484
- */
485
- readonly deliveryPackage?: PackageShippingDetails;
486
- /**
487
- * Return package shipping details.
488
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
489
- */
490
- readonly returnPackage?: PackageShippingDetails;
491
- /**
492
- * Destination account details.
493
- */
494
- destinationAccountDetails: DestinationAccountDetailsUnion[];
495
- /**
496
- * Error details for failure. This is optional.
497
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
498
- */
499
- readonly errorDetails?: JobErrorDetails[];
500
- /**
501
- * Preferences for the order.
502
- */
503
- preferences?: Preferences;
504
- /**
505
- * List of copy log details.
506
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
507
- */
508
- readonly copyLogDetails?: CopyLogDetailsUnion[];
509
- /**
510
- * Shared access key to download the return shipment label
511
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
512
- */
513
- readonly reverseShipmentLabelSasKey?: string;
514
- /**
515
- * Shared access key to download the chain of custody logs
516
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
517
- */
518
- readonly chainOfCustodySasKey?: string;
519
- }
520
- /**
521
- * DataBox Disk Job Details.
522
- */
523
- export interface DataBoxDiskJobDetails {
524
- /**
525
- * Polymorphic Discriminator
526
- */
527
- jobDetailsType: "DataBoxDisk";
528
- /**
529
- * The expected size of the data, which needs to be transferred in this job, in terabytes.
530
- */
531
- expectedDataSizeInTeraBytes?: number;
532
- /**
533
- * List of stages that run in the job.
534
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
535
- */
536
- readonly jobStages?: JobStages[];
537
- /**
538
- * Contact details for notification and shipping.
539
- */
540
- contactDetails: ContactDetails;
541
- /**
542
- * Shipping address of the customer.
543
- */
544
- shippingAddress: ShippingAddress;
545
- /**
546
- * Delivery package shipping details.
547
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
548
- */
549
- readonly deliveryPackage?: PackageShippingDetails;
550
- /**
551
- * Return package shipping details.
552
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
553
- */
554
- readonly returnPackage?: PackageShippingDetails;
555
- /**
556
- * Destination account details.
557
- */
558
- destinationAccountDetails: DestinationAccountDetailsUnion[];
559
- /**
560
- * Error details for failure. This is optional.
561
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
562
- */
563
- readonly errorDetails?: JobErrorDetails[];
564
- /**
565
- * Preferences for the order.
566
- */
567
- preferences?: Preferences;
568
- /**
569
- * List of copy log details.
570
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
571
- */
572
- readonly copyLogDetails?: CopyLogDetailsUnion[];
573
- /**
574
- * Shared access key to download the return shipment label
575
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
576
- */
577
- readonly reverseShipmentLabelSasKey?: string;
578
- /**
579
- * Shared access key to download the chain of custody logs
580
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
581
- */
582
- readonly chainOfCustodySasKey?: string;
583
- /**
584
- * User preference on what size disks are needed for the job. The map is from the disk size in TB
585
- * to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against
586
- * an int.
587
- */
588
- preferredDisks?: {
589
- [propertyName: string]: number;
590
- };
591
- /**
592
- * Copy progress per disk.
593
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
594
- */
595
- readonly copyProgress?: DataBoxDiskCopyProgress[];
596
- /**
597
- * Contains the map of disk serial number to the disk size being used for the job. Is returned
598
- * only after the disks are shipped to the customer.
599
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
600
- */
601
- readonly disksAndSizeDetails?: {
602
- [propertyName: string]: number;
603
- };
604
- /**
605
- * User entered passkey for DataBox Disk job.
606
- */
607
- passkey?: string;
608
- }
609
- /**
610
- * Contains all the secrets of a Disk.
611
- */
612
- export interface DiskSecret {
613
- /**
614
- * Serial number of the assigned disk.
615
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
616
- */
617
- readonly diskSerialNumber?: string;
618
- /**
619
- * Bit Locker key of the disk which can be used to unlock the disk to copy data.
620
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
621
- */
622
- readonly bitLockerKey?: string;
623
- }
624
- /**
625
- * Contains the possible cases for JobSecrets.
626
- */
627
- export declare type JobSecretsUnion = JobSecrets | DataBoxDiskJobSecrets | DataBoxHeavyJobSecrets | DataboxJobSecrets;
628
- /**
629
- * The base class for the secrets
630
- */
631
- export interface JobSecrets {
632
- /**
633
- * Polymorphic Discriminator
634
- */
635
- jobSecretsType: "JobSecrets";
636
- }
637
- /**
638
- * The secrets related to disk job.
639
- */
640
- export interface DataBoxDiskJobSecrets {
641
- /**
642
- * Polymorphic Discriminator
643
- */
644
- jobSecretsType: "DataBoxDisk";
645
- /**
646
- * Contains the list of secrets object for that device.
647
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
648
- */
649
- readonly diskSecrets?: DiskSecret[];
650
- /**
651
- * PassKey for the disk Job.
652
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
653
- */
654
- readonly passKey?: string;
655
- /**
656
- * Whether passkey was provided by user.
657
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
658
- */
659
- readonly isPasskeyUserDefined?: boolean;
660
- }
661
- /**
662
- * Copy log details for a storage account for DataBoxHeavy
663
- */
664
- export interface DataBoxHeavyAccountCopyLogDetails {
665
- /**
666
- * Polymorphic Discriminator
667
- */
668
- copyLogDetailsType: "DataBoxHeavy";
669
- /**
670
- * Destination account name.
671
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
672
- */
673
- readonly accountName?: string;
674
- /**
675
- * Link for copy logs.
676
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
677
- */
678
- readonly copyLogLink?: string[];
679
- }
680
- /**
681
- * DataBoxHeavy Device Job Details
682
- */
683
- export interface DataBoxHeavyJobDetails {
684
- /**
685
- * Polymorphic Discriminator
686
- */
687
- jobDetailsType: "DataBoxHeavy";
688
- /**
689
- * The expected size of the data, which needs to be transferred in this job, in terabytes.
690
- */
691
- expectedDataSizeInTeraBytes?: number;
692
- /**
693
- * List of stages that run in the job.
694
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
695
- */
696
- readonly jobStages?: JobStages[];
697
- /**
698
- * Contact details for notification and shipping.
699
- */
700
- contactDetails: ContactDetails;
701
- /**
702
- * Shipping address of the customer.
703
- */
704
- shippingAddress: ShippingAddress;
705
- /**
706
- * Delivery package shipping details.
707
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
708
- */
709
- readonly deliveryPackage?: PackageShippingDetails;
710
- /**
711
- * Return package shipping details.
712
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
713
- */
714
- readonly returnPackage?: PackageShippingDetails;
715
- /**
716
- * Destination account details.
717
- */
718
- destinationAccountDetails: DestinationAccountDetailsUnion[];
719
- /**
720
- * Error details for failure. This is optional.
721
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
722
- */
723
- readonly errorDetails?: JobErrorDetails[];
724
- /**
725
- * Preferences for the order.
726
- */
727
- preferences?: Preferences;
728
- /**
729
- * List of copy log details.
730
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
731
- */
732
- readonly copyLogDetails?: CopyLogDetailsUnion[];
733
- /**
734
- * Shared access key to download the return shipment label
735
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
736
- */
737
- readonly reverseShipmentLabelSasKey?: string;
738
- /**
739
- * Shared access key to download the chain of custody logs
740
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
741
- */
742
- readonly chainOfCustodySasKey?: string;
743
- /**
744
- * Copy progress per account.
745
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
746
- */
747
- readonly copyProgress?: CopyProgress[];
748
- }
749
- /**
750
- * The secrets related to a DataBoxHeavy.
751
- */
752
- export interface DataBoxHeavySecret {
753
- /**
754
- * Serial number of the assigned device.
755
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
756
- */
757
- readonly deviceSerialNumber?: string;
758
- /**
759
- * Password for out of the box experience on device.
760
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
761
- */
762
- readonly devicePassword?: string;
763
- /**
764
- * Network configuration of the appliance.
765
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
766
- */
767
- readonly networkConfigurations?: ApplianceNetworkConfiguration[];
768
- /**
769
- * The base 64 encoded public key to authenticate with the device
770
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
771
- */
772
- readonly encodedValidationCertPubKey?: string;
773
- /**
774
- * Per account level access credentials.
775
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
776
- */
777
- readonly accountCredentialDetails?: AccountCredentialDetails[];
778
- }
779
- /**
780
- * The secrets related to a DataBoxHeavy job.
781
- */
782
- export interface DataBoxHeavyJobSecrets {
783
- /**
784
- * Polymorphic Discriminator
785
- */
786
- jobSecretsType: "DataBoxHeavy";
787
- /**
788
- * Contains the list of secret objects for a DataBoxHeavy job.
789
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
790
- */
791
- readonly cabinetPodSecrets?: DataBoxHeavySecret[];
792
- }
793
- /**
794
- * DataBox Job Details
795
- */
796
- export interface DataBoxJobDetails {
797
- /**
798
- * Polymorphic Discriminator
799
- */
800
- jobDetailsType: "DataBox";
801
- /**
802
- * The expected size of the data, which needs to be transferred in this job, in terabytes.
803
- */
804
- expectedDataSizeInTeraBytes?: number;
805
- /**
806
- * List of stages that run in the job.
807
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
808
- */
809
- readonly jobStages?: JobStages[];
810
- /**
811
- * Contact details for notification and shipping.
812
- */
813
- contactDetails: ContactDetails;
814
- /**
815
- * Shipping address of the customer.
816
- */
817
- shippingAddress: ShippingAddress;
818
- /**
819
- * Delivery package shipping details.
820
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
821
- */
822
- readonly deliveryPackage?: PackageShippingDetails;
823
- /**
824
- * Return package shipping details.
825
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
826
- */
827
- readonly returnPackage?: PackageShippingDetails;
828
- /**
829
- * Destination account details.
830
- */
831
- destinationAccountDetails: DestinationAccountDetailsUnion[];
832
- /**
833
- * Error details for failure. This is optional.
834
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
835
- */
836
- readonly errorDetails?: JobErrorDetails[];
837
- /**
838
- * Preferences for the order.
839
- */
840
- preferences?: Preferences;
841
- /**
842
- * List of copy log details.
843
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
844
- */
845
- readonly copyLogDetails?: CopyLogDetailsUnion[];
846
- /**
847
- * Shared access key to download the return shipment label
848
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
849
- */
850
- readonly reverseShipmentLabelSasKey?: string;
851
- /**
852
- * Shared access key to download the chain of custody logs
853
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
854
- */
855
- readonly chainOfCustodySasKey?: string;
856
- /**
857
- * Copy progress per storage account.
858
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
859
- */
860
- readonly copyProgress?: CopyProgress[];
861
- }
862
- /**
863
- * The secrets related to a DataBox.
864
- */
865
- export interface DataBoxSecret {
866
- /**
867
- * Serial number of the assigned device.
868
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
869
- */
870
- readonly deviceSerialNumber?: string;
871
- /**
872
- * Password for out of the box experience on device.
873
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
874
- */
875
- readonly devicePassword?: string;
876
- /**
877
- * Network configuration of the appliance.
878
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
879
- */
880
- readonly networkConfigurations?: ApplianceNetworkConfiguration[];
881
- /**
882
- * The base 64 encoded public key to authenticate with the device
883
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
884
- */
885
- readonly encodedValidationCertPubKey?: string;
886
- /**
887
- * Per account level access credentials.
888
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
889
- */
890
- readonly accountCredentialDetails?: AccountCredentialDetails[];
891
- }
892
- /**
893
- * The secrets related to a DataBox job.
894
- */
895
- export interface DataboxJobSecrets {
896
- /**
897
- * Polymorphic Discriminator
898
- */
899
- jobSecretsType: "DataBox";
900
- /**
901
- * Contains the list of secret objects for a job.
902
- */
903
- podSecrets?: DataBoxSecret[];
904
- }
905
- /**
906
- * Contains the possible cases for DestinationAccountDetails.
907
- */
908
- export declare type DestinationAccountDetailsUnion = DestinationAccountDetails | DestinationManagedDiskDetails | DestinationStorageAccountDetails;
909
- /**
910
- * Details of the destination of the data
911
- */
912
- export interface DestinationAccountDetails {
913
- /**
914
- * Polymorphic Discriminator
915
- */
916
- dataDestinationType: "DestinationAccountDetails";
917
- /**
918
- * Arm Id of the destination where the data has to be moved.
919
- */
920
- accountId?: string;
921
- }
922
- /**
923
- * Details for the destination compute disks.
924
- */
925
- export interface DestinationManagedDiskDetails {
926
- /**
927
- * Polymorphic Discriminator
928
- */
929
- dataDestinationType: "ManagedDisk";
930
- /**
931
- * Arm Id of the destination where the data has to be moved.
932
- */
933
- accountId?: string;
934
- /**
935
- * Destination Resource Group Id where the Compute disks should be created.
936
- */
937
- resourceGroupId: string;
938
- /**
939
- * Arm Id of the storage account that can be used to copy the vhd for staging.
940
- */
941
- stagingStorageAccountId: string;
942
- }
943
- /**
944
- * Details for the destination storage account.
945
- */
946
- export interface DestinationStorageAccountDetails {
947
- /**
948
- * Polymorphic Discriminator
949
- */
950
- dataDestinationType: "StorageAccount";
951
- /**
952
- * Arm Id of the destination where the data has to be moved.
953
- */
954
- accountId?: string;
955
- /**
956
- * Destination Storage Account Arm Id.
957
- */
958
- storageAccountId: string;
959
- }
960
- /**
961
- * Top level error for the job.
962
- */
963
- export interface ErrorModel {
964
- /**
965
- * Error code that can be used to programmatically identify the error.
966
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
967
- */
968
- readonly code?: string;
969
- /**
970
- * Describes the error in detail and provides debugging information.
971
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
972
- */
973
- readonly message?: string;
974
- }
975
- /**
976
- * Job Error Details for providing the information and recommended action.
977
- */
978
- export interface JobErrorDetails {
979
- /**
980
- * Message for the error.
981
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
982
- */
983
- readonly errorMessage?: string;
984
- /**
985
- * Code for the error.
986
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
987
- */
988
- readonly errorCode?: number;
989
- /**
990
- * Recommended action for the error.
991
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
992
- */
993
- readonly recommendedAction?: string;
994
- /**
995
- * Contains the non localized exception message
996
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
997
- */
998
- readonly exceptionMessage?: string;
999
- }
1000
- /**
1001
- * Job stages.
1002
- */
1003
- export interface JobStages {
1004
- /**
1005
- * Name of the job stage. Possible values include: 'DeviceOrdered', 'DevicePrepared',
1006
- * 'Dispatched', 'Delivered', 'PickedUp', 'AtAzureDC', 'DataCopy', 'Completed',
1007
- * 'CompletedWithErrors', 'Cancelled', 'Failed_IssueReportedAtCustomer',
1008
- * 'Failed_IssueDetectedAtAzureDC', 'Aborted'
1009
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1010
- */
1011
- readonly stageName?: StageName;
1012
- /**
1013
- * Display name of the job stage.
1014
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1015
- */
1016
- readonly displayName?: string;
1017
- /**
1018
- * Status of the job stage. Possible values include: 'None', 'InProgress', 'Succeeded', 'Failed',
1019
- * 'Cancelled', 'Cancelling', 'SucceededWithErrors'
1020
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1021
- */
1022
- readonly stageStatus?: StageStatus;
1023
- /**
1024
- * Time for the job stage in UTC ISO 8601 format.
1025
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1026
- */
1027
- readonly stageTime?: Date;
1028
- /**
1029
- * Job Stage Details
1030
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1031
- */
1032
- readonly jobStageDetails?: any;
1033
- /**
1034
- * Error details for the stage.
1035
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1036
- */
1037
- readonly errorDetails?: JobErrorDetails[];
1038
- }
1039
- /**
1040
- * Shipping details.
1041
- */
1042
- export interface PackageShippingDetails {
1043
- /**
1044
- * Name of the carrier.
1045
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1046
- */
1047
- readonly carrierName?: string;
1048
- /**
1049
- * Tracking Id of shipment.
1050
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1051
- */
1052
- readonly trackingId?: string;
1053
- /**
1054
- * Url where shipment can be tracked.
1055
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1056
- */
1057
- readonly trackingUrl?: string;
1058
- }
1059
- /**
1060
- * Preferences related to the order
1061
- */
1062
- export interface Preferences {
1063
- preferredDataCenterRegion?: string[];
1064
- }
1065
- /**
1066
- * Model of the Resource.
1067
- */
1068
- export interface Resource extends BaseResource {
1069
- /**
1070
- * The location of the resource. This will be one of the supported and registered Azure Regions
1071
- * (e.g. West US, East US, Southeast Asia, etc.). The region of a resource cannot be changed once
1072
- * it is created, but if an identical region is specified on update the request will succeed.
1073
- */
1074
- location: string;
1075
- /**
1076
- * The list of key value pairs that describe the resource. These tags can be used in viewing and
1077
- * grouping this resource (across resource groups).
1078
- */
1079
- tags?: {
1080
- [propertyName: string]: string;
1081
- };
1082
- /**
1083
- * The sku type.
1084
- */
1085
- sku: Sku;
1086
- }
1087
- /**
1088
- * Job Resource.
1089
- */
1090
- export interface JobResource extends Resource {
1091
- /**
1092
- * Describes whether the job is cancellable or not.
1093
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1094
- */
1095
- readonly isCancellable?: boolean;
1096
- /**
1097
- * Describes whether the job is deletable or not.
1098
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1099
- */
1100
- readonly isDeletable?: boolean;
1101
- /**
1102
- * Describes whether the shipping address is editable or not.
1103
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1104
- */
1105
- readonly isShippingAddressEditable?: boolean;
1106
- /**
1107
- * Name of the stage which is in progress. Possible values include: 'DeviceOrdered',
1108
- * 'DevicePrepared', 'Dispatched', 'Delivered', 'PickedUp', 'AtAzureDC', 'DataCopy', 'Completed',
1109
- * 'CompletedWithErrors', 'Cancelled', 'Failed_IssueReportedAtCustomer',
1110
- * 'Failed_IssueDetectedAtAzureDC', 'Aborted'
1111
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1112
- */
1113
- readonly status?: StageName;
1114
- /**
1115
- * Time at which the job was started in UTC ISO 8601 format.
1116
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1117
- */
1118
- readonly startTime?: Date;
1119
- /**
1120
- * Top level error for the job.
1121
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1122
- */
1123
- readonly error?: ErrorModel;
1124
- /**
1125
- * Details of a job run. This field will only be sent for expand details filter.
1126
- */
1127
- details?: JobDetailsUnion;
1128
- /**
1129
- * Reason for cancellation.
1130
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1131
- */
1132
- readonly cancellationReason?: string;
1133
- /**
1134
- * Name of the object.
1135
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1136
- */
1137
- readonly name?: string;
1138
- /**
1139
- * Id of the object.
1140
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1141
- */
1142
- readonly id?: string;
1143
- /**
1144
- * Type of the object.
1145
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1146
- */
1147
- readonly type?: string;
1148
- }
1149
- /**
1150
- * Job details for update.
1151
- */
1152
- export interface UpdateJobDetails {
1153
- /**
1154
- * Contact details for notification and shipping.
1155
- */
1156
- contactDetails?: ContactDetails;
1157
- /**
1158
- * Shipping address of the customer.
1159
- */
1160
- shippingAddress?: ShippingAddress;
1161
- }
1162
- /**
1163
- * The JobResourceUpdateParameter.
1164
- */
1165
- export interface JobResourceUpdateParameter {
1166
- /**
1167
- * Details of a job to be updated.
1168
- */
1169
- details?: UpdateJobDetails;
1170
- /**
1171
- * Destination account details.
1172
- */
1173
- destinationAccountDetails?: DestinationAccountDetailsUnion[];
1174
- /**
1175
- * The list of key value pairs that describe the resource. These tags can be used in viewing and
1176
- * grouping this resource (across resource groups).
1177
- */
1178
- tags?: {
1179
- [propertyName: string]: string;
1180
- };
1181
- }
1182
- /**
1183
- * Operation display
1184
- */
1185
- export interface OperationDisplay {
1186
- /**
1187
- * Provider name.
1188
- */
1189
- provider?: string;
1190
- /**
1191
- * Resource name.
1192
- */
1193
- resource?: string;
1194
- /**
1195
- * Localized name of the operation for display purpose.
1196
- */
1197
- operation?: string;
1198
- /**
1199
- * Localized description of the operation for display purpose.
1200
- */
1201
- description?: string;
1202
- }
1203
- /**
1204
- * Operation entity.
1205
- */
1206
- export interface Operation {
1207
- /**
1208
- * Name of the operation. Format:
1209
- * {resourceProviderNamespace}/{resourceType}/{read|write|delete|action}
1210
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1211
- */
1212
- readonly name?: string;
1213
- /**
1214
- * Operation display values.
1215
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1216
- */
1217
- readonly display?: OperationDisplay;
1218
- /**
1219
- * Operation properties.
1220
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1221
- */
1222
- readonly properties?: any;
1223
- /**
1224
- * Origin of the operation. Can be : user|system|user,system
1225
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1226
- */
1227
- readonly origin?: string;
1228
- }
1229
- /**
1230
- * Shipment pick up request details.
1231
- */
1232
- export interface ShipmentPickUpRequest {
1233
- /**
1234
- * Minimum date after which the pick up should commence, this must be in local time of pick up
1235
- * area.
1236
- */
1237
- startTime: Date;
1238
- /**
1239
- * Maximum date before which the pick up should commence, this must be in local time of pick up
1240
- * area.
1241
- */
1242
- endTime: Date;
1243
- /**
1244
- * Shipment Location in the pickup place. Eg.front desk
1245
- */
1246
- shipmentLocation: string;
1247
- }
1248
- /**
1249
- * Shipment pick up response.
1250
- */
1251
- export interface ShipmentPickUpResponse {
1252
- /**
1253
- * Confirmation number for the pick up request.
1254
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1255
- */
1256
- readonly confirmationNumber?: string;
1257
- /**
1258
- * Time by which shipment should be ready for pick up, this is in local time of pick up area.
1259
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1260
- */
1261
- readonly readyByTime?: Date;
1262
- }
1263
- /**
1264
- * Unencrypted credentials for accessing device.
1265
- */
1266
- export interface UnencryptedCredentials {
1267
- /**
1268
- * Name of the job.
1269
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1270
- */
1271
- readonly jobName?: string;
1272
- /**
1273
- * Secrets related to this job.
1274
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1275
- */
1276
- readonly jobSecrets?: JobSecretsUnion;
1277
- }
1278
- /**
1279
- * The requirements to validate customer address where the device needs to be shipped.
1280
- */
1281
- export interface ValidateAddress {
1282
- /**
1283
- * Shipping address of the customer.
1284
- */
1285
- shippingAddress: ShippingAddress;
1286
- /**
1287
- * Device type to be used for the job. Possible values include: 'DataBox', 'DataBoxDisk',
1288
- * 'DataBoxHeavy'
1289
- */
1290
- deviceType: SkuName;
1291
- }
1292
- /**
1293
- * Optional Parameters.
1294
- */
1295
- export interface JobsListOptionalParams extends msRest.RequestOptionsBase {
1296
- /**
1297
- * $skipToken is supported on Get list of jobs, which provides the next page in the list of jobs.
1298
- */
1299
- skipToken?: string;
1300
- }
1301
- /**
1302
- * Optional Parameters.
1303
- */
1304
- export interface JobsListByResourceGroupOptionalParams extends msRest.RequestOptionsBase {
1305
- /**
1306
- * $skipToken is supported on Get list of jobs, which provides the next page in the list of jobs.
1307
- */
1308
- skipToken?: string;
1309
- }
1310
- /**
1311
- * Optional Parameters.
1312
- */
1313
- export interface JobsGetOptionalParams extends msRest.RequestOptionsBase {
1314
- /**
1315
- * $expand is supported on details parameter for job, which provides details on the job stages.
1316
- */
1317
- expand?: string;
1318
- }
1319
- /**
1320
- * Optional Parameters.
1321
- */
1322
- export interface JobsUpdateOptionalParams extends msRest.RequestOptionsBase {
1323
- /**
1324
- * Defines the If-Match condition. The patch will be performed only if the ETag of the job on the
1325
- * server matches this value.
1326
- */
1327
- ifMatch?: string;
1328
- }
1329
- /**
1330
- * Optional Parameters.
1331
- */
1332
- export interface JobsBeginUpdateOptionalParams extends msRest.RequestOptionsBase {
1333
- /**
1334
- * Defines the If-Match condition. The patch will be performed only if the ETag of the job on the
1335
- * server matches this value.
1336
- */
1337
- ifMatch?: string;
1338
- }
1339
- /**
1340
- * An interface representing DataBoxManagementClientOptions.
1341
- */
1342
- export interface DataBoxManagementClientOptions extends AzureServiceClientOptions {
1343
- baseUri?: string;
1344
- }
1345
- /**
1346
- * @interface
1347
- * Operation Collection.
1348
- * @extends Array<Operation>
1349
- */
1350
- export interface OperationList extends Array<Operation> {
1351
- /**
1352
- * Link for the next set of operations.
1353
- */
1354
- nextLink?: string;
1355
- }
1356
- /**
1357
- * @interface
1358
- * Job Resource Collection
1359
- * @extends Array<JobResource>
1360
- */
1361
- export interface JobResourceList extends Array<JobResource> {
1362
- /**
1363
- * Link for the next set of job resources.
1364
- */
1365
- nextLink?: string;
1366
- }
1367
- /**
1368
- * @interface
1369
- * List of unencrypted credentials for accessing device.
1370
- * @extends Array<UnencryptedCredentials>
1371
- */
1372
- export interface UnencryptedCredentialsList extends Array<UnencryptedCredentials> {
1373
- /**
1374
- * Link for the next set of unencrypted credentials.
1375
- */
1376
- nextLink?: string;
1377
- }
1378
- /**
1379
- * @interface
1380
- * The available skus operation response.
1381
- * @extends Array<SkuInformation>
1382
- */
1383
- export interface AvailableSkusResult extends Array<SkuInformation> {
1384
- /**
1385
- * Link for the next set of skus.
1386
- */
1387
- nextLink?: string;
1388
- }
1389
- /**
1390
- * Defines values for ShareDestinationFormatType.
1391
- * Possible values include: 'UnknownType', 'HCS', 'BlockBlob', 'PageBlob', 'AzureFile',
1392
- * 'ManagedDisk'
1393
- * @readonly
1394
- * @enum {string}
1395
- */
1396
- export declare type ShareDestinationFormatType = 'UnknownType' | 'HCS' | 'BlockBlob' | 'PageBlob' | 'AzureFile' | 'ManagedDisk';
1397
- /**
1398
- * Defines values for AccessProtocol.
1399
- * Possible values include: 'SMB', 'NFS'
1400
- * @readonly
1401
- * @enum {string}
1402
- */
1403
- export declare type AccessProtocol = 'SMB' | 'NFS';
1404
- /**
1405
- * Defines values for AddressValidationStatus.
1406
- * Possible values include: 'Valid', 'Invalid', 'Ambiguous'
1407
- * @readonly
1408
- * @enum {string}
1409
- */
1410
- export declare type AddressValidationStatus = 'Valid' | 'Invalid' | 'Ambiguous';
1411
- /**
1412
- * Defines values for AddressType.
1413
- * Possible values include: 'None', 'Residential', 'Commercial'
1414
- * @readonly
1415
- * @enum {string}
1416
- */
1417
- export declare type AddressType = 'None' | 'Residential' | 'Commercial';
1418
- /**
1419
- * Defines values for SkuName.
1420
- * Possible values include: 'DataBox', 'DataBoxDisk', 'DataBoxHeavy'
1421
- * @readonly
1422
- * @enum {string}
1423
- */
1424
- export declare type SkuName = 'DataBox' | 'DataBoxDisk' | 'DataBoxHeavy';
1425
- /**
1426
- * Defines values for SkuDisabledReason.
1427
- * Possible values include: 'None', 'Country', 'Region', 'Feature', 'OfferType',
1428
- * 'NoSubscriptionInfo'
1429
- * @readonly
1430
- * @enum {string}
1431
- */
1432
- export declare type SkuDisabledReason = 'None' | 'Country' | 'Region' | 'Feature' | 'OfferType' | 'NoSubscriptionInfo';
1433
- /**
1434
- * Defines values for NotificationStageName.
1435
- * Possible values include: 'DevicePrepared', 'Dispatched', 'Delivered', 'PickedUp', 'AtAzureDC',
1436
- * 'DataCopy'
1437
- * @readonly
1438
- * @enum {string}
1439
- */
1440
- export declare type NotificationStageName = 'DevicePrepared' | 'Dispatched' | 'Delivered' | 'PickedUp' | 'AtAzureDC' | 'DataCopy';
1441
- /**
1442
- * Defines values for CopyStatus.
1443
- * Possible values include: 'NotStarted', 'InProgress', 'Completed', 'CompletedWithErrors',
1444
- * 'Failed', 'NotReturned'
1445
- * @readonly
1446
- * @enum {string}
1447
- */
1448
- export declare type CopyStatus = 'NotStarted' | 'InProgress' | 'Completed' | 'CompletedWithErrors' | 'Failed' | 'NotReturned';
1449
- /**
1450
- * Defines values for StageName.
1451
- * Possible values include: 'DeviceOrdered', 'DevicePrepared', 'Dispatched', 'Delivered',
1452
- * 'PickedUp', 'AtAzureDC', 'DataCopy', 'Completed', 'CompletedWithErrors', 'Cancelled',
1453
- * 'Failed_IssueReportedAtCustomer', 'Failed_IssueDetectedAtAzureDC', 'Aborted'
1454
- * @readonly
1455
- * @enum {string}
1456
- */
1457
- export declare type StageName = 'DeviceOrdered' | 'DevicePrepared' | 'Dispatched' | 'Delivered' | 'PickedUp' | 'AtAzureDC' | 'DataCopy' | 'Completed' | 'CompletedWithErrors' | 'Cancelled' | 'Failed_IssueReportedAtCustomer' | 'Failed_IssueDetectedAtAzureDC' | 'Aborted';
1458
- /**
1459
- * Defines values for StageStatus.
1460
- * Possible values include: 'None', 'InProgress', 'Succeeded', 'Failed', 'Cancelled', 'Cancelling',
1461
- * 'SucceededWithErrors'
1462
- * @readonly
1463
- * @enum {string}
1464
- */
1465
- export declare type StageStatus = 'None' | 'InProgress' | 'Succeeded' | 'Failed' | 'Cancelled' | 'Cancelling' | 'SucceededWithErrors';
1466
- /**
1467
- * Contains response data for the list operation.
1468
- */
1469
- export declare type OperationsListResponse = OperationList & {
1470
- /**
1471
- * The underlying HTTP response.
1472
- */
1473
- _response: msRest.HttpResponse & {
1474
- /**
1475
- * The response body as text (string format)
1476
- */
1477
- bodyAsText: string;
1478
- /**
1479
- * The response body as parsed JSON or XML
1480
- */
1481
- parsedBody: OperationList;
1482
- };
1483
- };
1484
- /**
1485
- * Contains response data for the listNext operation.
1486
- */
1487
- export declare type OperationsListNextResponse = OperationList & {
1488
- /**
1489
- * The underlying HTTP response.
1490
- */
1491
- _response: msRest.HttpResponse & {
1492
- /**
1493
- * The response body as text (string format)
1494
- */
1495
- bodyAsText: string;
1496
- /**
1497
- * The response body as parsed JSON or XML
1498
- */
1499
- parsedBody: OperationList;
1500
- };
1501
- };
1502
- /**
1503
- * Contains response data for the list operation.
1504
- */
1505
- export declare type JobsListResponse = JobResourceList & {
1506
- /**
1507
- * The underlying HTTP response.
1508
- */
1509
- _response: msRest.HttpResponse & {
1510
- /**
1511
- * The response body as text (string format)
1512
- */
1513
- bodyAsText: string;
1514
- /**
1515
- * The response body as parsed JSON or XML
1516
- */
1517
- parsedBody: JobResourceList;
1518
- };
1519
- };
1520
- /**
1521
- * Contains response data for the listByResourceGroup operation.
1522
- */
1523
- export declare type JobsListByResourceGroupResponse = JobResourceList & {
1524
- /**
1525
- * The underlying HTTP response.
1526
- */
1527
- _response: msRest.HttpResponse & {
1528
- /**
1529
- * The response body as text (string format)
1530
- */
1531
- bodyAsText: string;
1532
- /**
1533
- * The response body as parsed JSON or XML
1534
- */
1535
- parsedBody: JobResourceList;
1536
- };
1537
- };
1538
- /**
1539
- * Contains response data for the get operation.
1540
- */
1541
- export declare type JobsGetResponse = JobResource & {
1542
- /**
1543
- * The underlying HTTP response.
1544
- */
1545
- _response: msRest.HttpResponse & {
1546
- /**
1547
- * The response body as text (string format)
1548
- */
1549
- bodyAsText: string;
1550
- /**
1551
- * The response body as parsed JSON or XML
1552
- */
1553
- parsedBody: JobResource;
1554
- };
1555
- };
1556
- /**
1557
- * Contains response data for the create operation.
1558
- */
1559
- export declare type JobsCreateResponse = JobResource & {
1560
- /**
1561
- * The underlying HTTP response.
1562
- */
1563
- _response: msRest.HttpResponse & {
1564
- /**
1565
- * The response body as text (string format)
1566
- */
1567
- bodyAsText: string;
1568
- /**
1569
- * The response body as parsed JSON or XML
1570
- */
1571
- parsedBody: JobResource;
1572
- };
1573
- };
1574
- /**
1575
- * Contains response data for the update operation.
1576
- */
1577
- export declare type JobsUpdateResponse = JobResource & {
1578
- /**
1579
- * The underlying HTTP response.
1580
- */
1581
- _response: msRest.HttpResponse & {
1582
- /**
1583
- * The response body as text (string format)
1584
- */
1585
- bodyAsText: string;
1586
- /**
1587
- * The response body as parsed JSON or XML
1588
- */
1589
- parsedBody: JobResource;
1590
- };
1591
- };
1592
- /**
1593
- * Contains response data for the bookShipmentPickUp operation.
1594
- */
1595
- export declare type JobsBookShipmentPickUpResponse = ShipmentPickUpResponse & {
1596
- /**
1597
- * The underlying HTTP response.
1598
- */
1599
- _response: msRest.HttpResponse & {
1600
- /**
1601
- * The response body as text (string format)
1602
- */
1603
- bodyAsText: string;
1604
- /**
1605
- * The response body as parsed JSON or XML
1606
- */
1607
- parsedBody: ShipmentPickUpResponse;
1608
- };
1609
- };
1610
- /**
1611
- * Contains response data for the listCredentials operation.
1612
- */
1613
- export declare type JobsListCredentialsResponse = UnencryptedCredentialsList & {
1614
- /**
1615
- * The underlying HTTP response.
1616
- */
1617
- _response: msRest.HttpResponse & {
1618
- /**
1619
- * The response body as text (string format)
1620
- */
1621
- bodyAsText: string;
1622
- /**
1623
- * The response body as parsed JSON or XML
1624
- */
1625
- parsedBody: UnencryptedCredentialsList;
1626
- };
1627
- };
1628
- /**
1629
- * Contains response data for the beginCreate operation.
1630
- */
1631
- export declare type JobsBeginCreateResponse = JobResource & {
1632
- /**
1633
- * The underlying HTTP response.
1634
- */
1635
- _response: msRest.HttpResponse & {
1636
- /**
1637
- * The response body as text (string format)
1638
- */
1639
- bodyAsText: string;
1640
- /**
1641
- * The response body as parsed JSON or XML
1642
- */
1643
- parsedBody: JobResource;
1644
- };
1645
- };
1646
- /**
1647
- * Contains response data for the beginUpdate operation.
1648
- */
1649
- export declare type JobsBeginUpdateResponse = JobResource & {
1650
- /**
1651
- * The underlying HTTP response.
1652
- */
1653
- _response: msRest.HttpResponse & {
1654
- /**
1655
- * The response body as text (string format)
1656
- */
1657
- bodyAsText: string;
1658
- /**
1659
- * The response body as parsed JSON or XML
1660
- */
1661
- parsedBody: JobResource;
1662
- };
1663
- };
1664
- /**
1665
- * Contains response data for the listNext operation.
1666
- */
1667
- export declare type JobsListNextResponse = JobResourceList & {
1668
- /**
1669
- * The underlying HTTP response.
1670
- */
1671
- _response: msRest.HttpResponse & {
1672
- /**
1673
- * The response body as text (string format)
1674
- */
1675
- bodyAsText: string;
1676
- /**
1677
- * The response body as parsed JSON or XML
1678
- */
1679
- parsedBody: JobResourceList;
1680
- };
1681
- };
1682
- /**
1683
- * Contains response data for the listByResourceGroupNext operation.
1684
- */
1685
- export declare type JobsListByResourceGroupNextResponse = JobResourceList & {
1686
- /**
1687
- * The underlying HTTP response.
1688
- */
1689
- _response: msRest.HttpResponse & {
1690
- /**
1691
- * The response body as text (string format)
1692
- */
1693
- bodyAsText: string;
1694
- /**
1695
- * The response body as parsed JSON or XML
1696
- */
1697
- parsedBody: JobResourceList;
1698
- };
1699
- };
1700
- /**
1701
- * Contains response data for the listAvailableSkus operation.
1702
- */
1703
- export declare type ServiceListAvailableSkusResponse = AvailableSkusResult & {
1704
- /**
1705
- * The underlying HTTP response.
1706
- */
1707
- _response: msRest.HttpResponse & {
1708
- /**
1709
- * The response body as text (string format)
1710
- */
1711
- bodyAsText: string;
1712
- /**
1713
- * The response body as parsed JSON or XML
1714
- */
1715
- parsedBody: AvailableSkusResult;
1716
- };
1717
- };
1718
- /**
1719
- * Contains response data for the validateAddressMethod operation.
1720
- */
1721
- export declare type ServiceValidateAddressMethodResponse = AddressValidationOutput & {
1722
- /**
1723
- * The underlying HTTP response.
1724
- */
1725
- _response: msRest.HttpResponse & {
1726
- /**
1727
- * The response body as text (string format)
1728
- */
1729
- bodyAsText: string;
1730
- /**
1731
- * The response body as parsed JSON or XML
1732
- */
1733
- parsedBody: AddressValidationOutput;
1734
- };
1735
- };
1736
- /**
1737
- * Contains response data for the listAvailableSkusNext operation.
1738
- */
1739
- export declare type ServiceListAvailableSkusNextResponse = AvailableSkusResult & {
1740
- /**
1741
- * The underlying HTTP response.
1742
- */
1743
- _response: msRest.HttpResponse & {
1744
- /**
1745
- * The response body as text (string format)
1746
- */
1747
- bodyAsText: string;
1748
- /**
1749
- * The response body as parsed JSON or XML
1750
- */
1751
- parsedBody: AvailableSkusResult;
1752
- };
1753
- };
1754
- //# sourceMappingURL=index.d.ts.map