@azure/arm-databox 5.1.0-alpha.20250619.1 → 5.1.0-alpha.20250718.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 (2) hide show
  1. package/package.json +1 -1
  2. package/review/{arm-databox.api.md → arm-databox-node.api.md} +1514 -1514
package/review/{arm-databox.api.md → arm-databox-node.api.md} RENAMED
@@ -1,1514 +1,1514 @@
1
- ## API Report File for "@azure/arm-databox"
2
-
3
- > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
-
5
- ```ts
6
-
7
- import * as coreAuth from '@azure/core-auth';
8
- import * as coreClient from '@azure/core-client';
9
- import { OperationState } from '@azure/core-lro';
10
- import { PagedAsyncIterableIterator } from '@azure/core-paging';
11
- import { SimplePollerLike } from '@azure/core-lro';
12
-
13
- // @public
14
- export type AccessProtocol = "SMB" | "NFS";
15
-
16
- // @public
17
- export interface AccountCredentialDetails {
18
- readonly accountConnectionString?: string;
19
- readonly accountName?: string;
20
- readonly dataAccountType?: DataAccountType;
21
- readonly shareCredentialDetails?: ShareCredentialDetails[];
22
- }
23
-
24
- // @public
25
- export interface AdditionalErrorInfo {
26
- info?: Record<string, unknown>;
27
- type?: string;
28
- }
29
-
30
- // @public
31
- export type AddressType = "None" | "Residential" | "Commercial";
32
-
33
- // @public
34
- export interface AddressValidationOutput {
35
- readonly alternateAddresses?: ShippingAddress[];
36
- readonly error?: CloudError;
37
- readonly validationStatus?: AddressValidationStatus;
38
- validationType?: ValidationInputDiscriminator;
39
- }
40
-
41
- // @public
42
- export interface AddressValidationProperties extends ValidationInputResponse {
43
- readonly alternateAddresses?: ShippingAddress[];
44
- readonly validationStatus?: AddressValidationStatus;
45
- validationType: "ValidateAddress";
46
- }
47
-
48
- // @public
49
- export type AddressValidationStatus = "Valid" | "Invalid" | "Ambiguous";
50
-
51
- // @public (undocumented)
52
- export interface ApiError {
53
- // (undocumented)
54
- error: ErrorDetail;
55
- }
56
-
57
- // @public
58
- export interface ApplianceNetworkConfiguration {
59
- readonly macAddress?: string;
60
- readonly name?: string;
61
- }
62
-
63
- // @public
64
- export interface ArmBaseObject {
65
- readonly id?: string;
66
- readonly name?: string;
67
- readonly type?: string;
68
- }
69
-
70
- // @public
71
- export interface AvailableSkuRequest {
72
- country: string;
73
- location: string;
74
- skuNames?: SkuName[];
75
- transferType: TransferType;
76
- }
77
-
78
- // @public
79
- export interface AvailableSkusResult {
80
- nextLink?: string;
81
- readonly value?: SkuInformation[];
82
- }
83
-
84
- // @public
85
- export interface AzureFileFilterDetails {
86
- filePathList?: string[];
87
- filePrefixList?: string[];
88
- fileShareList?: string[];
89
- }
90
-
91
- // @public
92
- export interface BlobFilterDetails {
93
- blobPathList?: string[];
94
- blobPrefixList?: string[];
95
- containerList?: string[];
96
- }
97
-
98
- // @public
99
- export interface CancellationReason {
100
- reason: string;
101
- }
102
-
103
- // @public
104
- export type ClassDiscriminator = "DataBox" | "DataBoxDisk" | "DataBoxHeavy" | "DataBoxCustomerDisk";
105
-
106
- // @public
107
- export interface CloudError {
108
- readonly additionalInfo?: AdditionalErrorInfo[];
109
- code?: string;
110
- readonly details?: CloudError[];
111
- message?: string;
112
- target?: string;
113
- }
114
-
115
- // @public
116
- export interface ContactDetails {
117
- contactName: string;
118
- emailList: string[];
119
- mobile?: string;
120
- notificationPreference?: NotificationPreference[];
121
- phone: string;
122
- phoneExtension?: string;
123
- }
124
-
125
- // @public
126
- export interface ContactInfo {
127
- contactName: string;
128
- mobile?: string;
129
- phone: string;
130
- phoneExtension?: string;
131
- }
132
-
133
- // @public
134
- export interface CopyLogDetails {
135
- copyLogDetailsType: "DataBox" | "DataBoxCustomerDisk" | "DataBoxDisk" | "DataBoxHeavy";
136
- }
137
-
138
- // @public (undocumented)
139
- export type CopyLogDetailsUnion = CopyLogDetails | DataBoxAccountCopyLogDetails | DataBoxCustomerDiskCopyLogDetails | DataBoxDiskCopyLogDetails | DataBoxHeavyAccountCopyLogDetails;
140
-
141
- // @public
142
- export interface CopyProgress {
143
- readonly accountId?: string;
144
- readonly actions?: CustomerResolutionCode[];
145
- readonly bytesProcessed?: number;
146
- readonly dataAccountType?: DataAccountType;
147
- readonly directoriesErroredOut?: number;
148
- readonly error?: CloudError;
149
- readonly filesErroredOut?: number;
150
- readonly filesProcessed?: number;
151
- readonly invalidDirectoriesProcessed?: number;
152
- readonly invalidFileBytesUploaded?: number;
153
- readonly invalidFilesProcessed?: number;
154
- readonly isEnumerationInProgress?: boolean;
155
- readonly renamedContainerCount?: number;
156
- readonly storageAccountName?: string;
157
- readonly totalBytesToProcess?: number;
158
- readonly totalFilesToProcess?: number;
159
- readonly transferType?: TransferType;
160
- }
161
-
162
- // @public
163
- export type CopyStatus = string;
164
-
165
- // @public
166
- export interface CreateJobValidations extends ValidationRequest {
167
- validationCategory: "JobCreationValidation";
168
- }
169
-
170
- // @public
171
- export interface CreateOrderLimitForSubscriptionValidationRequest extends ValidationInputRequest {
172
- deviceType: SkuName;
173
- model?: ModelName;
174
- validationType: "ValidateCreateOrderLimit";
175
- }
176
-
177
- // @public
178
- export interface CreateOrderLimitForSubscriptionValidationResponseProperties extends ValidationInputResponse {
179
- readonly status?: ValidationStatus;
180
- validationType: "ValidateCreateOrderLimit";
181
- }
182
-
183
- // @public
184
- export interface CustomerDiskJobSecrets extends JobSecrets {
185
- readonly carrierAccountNumber?: string;
186
- readonly diskSecrets?: DiskSecret[];
187
- jobSecretsType: "DataBoxCustomerDisk";
188
- }
189
-
190
- // @public
191
- export type CustomerResolutionCode = "None" | "MoveToCleanUpDevice" | "Resume" | "Restart" | "ReachOutToOperation";
192
-
193
- // @public
194
- export interface DataAccountDetails {
195
- dataAccountType: "ManagedDisk" | "StorageAccount";
196
- sharePassword?: string;
197
- }
198
-
199
- // @public (undocumented)
200
- export type DataAccountDetailsUnion = DataAccountDetails | ManagedDiskDetails | StorageAccountDetails;
201
-
202
- // @public
203
- export type DataAccountType = "StorageAccount" | "ManagedDisk";
204
-
205
- // @public
206
- export interface DataBoxAccountCopyLogDetails extends CopyLogDetails {
207
- readonly accountName?: string;
208
- copyLogDetailsType: "DataBox";
209
- readonly copyLogLink?: string;
210
- readonly copyVerboseLogLink?: string;
211
- }
212
-
213
- // @public
214
- export interface DataBoxCustomerDiskCopyLogDetails extends CopyLogDetails {
215
- copyLogDetailsType: "DataBoxCustomerDisk";
216
- readonly errorLogLink?: string;
217
- readonly serialNumber?: string;
218
- readonly verboseLogLink?: string;
219
- }
220
-
221
- // @public
222
- export interface DataBoxCustomerDiskCopyProgress extends CopyProgress {
223
- readonly copyStatus?: CopyStatus;
224
- readonly serialNumber?: string;
225
- }
226
-
227
- // @public
228
- export interface DataBoxCustomerDiskJobDetails extends JobDetails {
229
- readonly copyProgress?: DataBoxCustomerDiskCopyProgress[];
230
- readonly deliverToDcPackageDetails?: PackageCarrierInfo;
231
- enableManifestBackup?: boolean;
232
- readonly exportDiskDetailsCollection?: {
233
- [propertyName: string]: ExportDiskDetails;
234
- };
235
- importDiskDetailsCollection?: {
236
- [propertyName: string]: ImportDiskDetails;
237
- };
238
- jobDetailsType: "DataBoxCustomerDisk";
239
- returnToCustomerPackageDetails: PackageCarrierDetails;
240
- }
241
-
242
- // @public
243
- export interface DataBoxDiskCopyLogDetails extends CopyLogDetails {
244
- copyLogDetailsType: "DataBoxDisk";
245
- readonly diskSerialNumber?: string;
246
- readonly errorLogLink?: string;
247
- readonly verboseLogLink?: string;
248
- }
249
-
250
- // @public
251
- export interface DataBoxDiskCopyProgress {
252
- readonly actions?: CustomerResolutionCode[];
253
- readonly bytesCopied?: number;
254
- readonly error?: CloudError;
255
- readonly percentComplete?: number;
256
- readonly serialNumber?: string;
257
- readonly status?: CopyStatus;
258
- }
259
-
260
- // @public
261
- export interface DataBoxDiskGranularCopyLogDetails extends GranularCopyLogDetails {
262
- readonly accountId?: string;
263
- copyLogDetailsType: "DataBoxCustomerDisk";
264
- readonly errorLogLink?: string;
265
- readonly serialNumber?: string;
266
- readonly verboseLogLink?: string;
267
- }
268
-
269
- // @public
270
- export interface DataBoxDiskGranularCopyProgress extends GranularCopyProgress {
271
- readonly copyStatus?: CopyStatus;
272
- readonly serialNumber?: string;
273
- }
274
-
275
- // @public
276
- export interface DataBoxDiskJobDetails extends JobDetails {
277
- readonly copyProgress?: DataBoxDiskCopyProgress[];
278
- readonly disksAndSizeDetails?: {
279
- [propertyName: string]: number;
280
- };
281
- readonly granularCopyLogDetails?: DataBoxDiskGranularCopyLogDetails[];
282
- readonly granularCopyProgress?: DataBoxDiskGranularCopyProgress[];
283
- jobDetailsType: "DataBoxDisk";
284
- passkey?: string;
285
- preferredDisks?: {
286
- [propertyName: string]: number;
287
- };
288
- }
289
-
290
- // @public
291
- export interface DataBoxDiskJobSecrets extends JobSecrets {
292
- readonly diskSecrets?: DiskSecret[];
293
- readonly isPasskeyUserDefined?: boolean;
294
- jobSecretsType: "DataBoxDisk";
295
- readonly passKey?: string;
296
- }
297
-
298
- // @public
299
- export interface DataBoxHeavyAccountCopyLogDetails extends CopyLogDetails {
300
- readonly accountName?: string;
301
- copyLogDetailsType: "DataBoxHeavy";
302
- readonly copyLogLink?: string[];
303
- readonly copyVerboseLogLink?: string[];
304
- }
305
-
306
- // @public
307
- export interface DataBoxHeavyJobDetails extends JobDetails {
308
- readonly copyProgress?: CopyProgress[];
309
- devicePassword?: string;
310
- jobDetailsType: "DataBoxHeavy";
311
- }
312
-
313
- // @public
314
- export interface DataBoxHeavyJobSecrets extends JobSecrets {
315
- readonly cabinetPodSecrets?: DataBoxHeavySecret[];
316
- jobSecretsType: "DataBoxHeavy";
317
- }
318
-
319
- // @public
320
- export interface DataBoxHeavySecret {
321
- readonly accountCredentialDetails?: AccountCredentialDetails[];
322
- readonly devicePassword?: string;
323
- readonly deviceSerialNumber?: string;
324
- readonly encodedValidationCertPubKey?: string;
325
- readonly networkConfigurations?: ApplianceNetworkConfiguration[];
326
- }
327
-
328
- // @public
329
- export interface DataBoxJobDetails extends JobDetails {
330
- readonly copyProgress?: CopyProgress[];
331
- devicePassword?: string;
332
- jobDetailsType: "DataBox";
333
- }
334
-
335
- // @public
336
- export interface DataboxJobSecrets extends JobSecrets {
337
- jobSecretsType: "DataBox";
338
- podSecrets?: DataBoxSecret[];
339
- }
340
-
341
- // @public (undocumented)
342
- export class DataBoxManagementClient extends coreClient.ServiceClient {
343
- // (undocumented)
344
- $host: string;
345
- constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: DataBoxManagementClientOptionalParams);
346
- // (undocumented)
347
- apiVersion: string;
348
- // (undocumented)
349
- jobs: Jobs;
350
- mitigate(jobName: string, resourceGroupName: string, mitigateJobRequest: MitigateJobRequest, options?: MitigateOptionalParams): Promise<void>;
351
- // (undocumented)
352
- operations: Operations;
353
- // (undocumented)
354
- service: Service;
355
- // (undocumented)
356
- subscriptionId: string;
357
- }
358
-
359
- // @public
360
- export interface DataBoxManagementClientOptionalParams extends coreClient.ServiceClientOptions {
361
- $host?: string;
362
- apiVersion?: string;
363
- endpoint?: string;
364
- }
365
-
366
- // @public
367
- export interface DataBoxScheduleAvailabilityRequest extends ScheduleAvailabilityRequest {
368
- skuName: "DataBox";
369
- }
370
-
371
- // @public
372
- export interface DataBoxSecret {
373
- readonly accountCredentialDetails?: AccountCredentialDetails[];
374
- readonly devicePassword?: string;
375
- readonly deviceSerialNumber?: string;
376
- readonly encodedValidationCertPubKey?: string;
377
- readonly networkConfigurations?: ApplianceNetworkConfiguration[];
378
- }
379
-
380
- // @public
381
- export interface DatacenterAddressInstructionResponse extends DatacenterAddressResponse {
382
- readonly communicationInstruction?: string;
383
- datacenterAddressType: "DatacenterAddressInstruction";
384
- }
385
-
386
- // @public
387
- export interface DatacenterAddressLocationResponse extends DatacenterAddressResponse {
388
- readonly additionalShippingInformation?: string;
389
- readonly addressType?: string;
390
- readonly city?: string;
391
- readonly company?: string;
392
- readonly contactPersonName?: string;
393
- readonly country?: string;
394
- datacenterAddressType: "DatacenterAddressLocation";
395
- readonly phone?: string;
396
- readonly phoneExtension?: string;
397
- readonly state?: string;
398
- readonly street1?: string;
399
- readonly street2?: string;
400
- readonly street3?: string;
401
- readonly zip?: string;
402
- }
403
-
404
- // @public
405
- export interface DatacenterAddressRequest {
406
- model?: ModelName;
407
- skuName: SkuName;
408
- storageLocation: string;
409
- }
410
-
411
- // @public
412
- export interface DatacenterAddressResponse {
413
- datacenterAddressType: "DatacenterAddressInstruction" | "DatacenterAddressLocation";
414
- readonly dataCenterAzureLocation?: string;
415
- readonly supportedCarriersForReturnShipment?: string[];
416
- }
417
-
418
- // @public (undocumented)
419
- export type DatacenterAddressResponseUnion = DatacenterAddressResponse | DatacenterAddressInstructionResponse | DatacenterAddressLocationResponse;
420
-
421
- // @public
422
- export type DatacenterAddressType = "DatacenterAddressLocation" | "DatacenterAddressInstruction";
423
-
424
- // @public
425
- export type DataCenterCode = string;
426
-
427
- // @public
428
- export interface DataExportDetails {
429
- accountDetails: DataAccountDetailsUnion;
430
- logCollectionLevel?: LogCollectionLevel;
431
- transferConfiguration: TransferConfiguration;
432
- }
433
-
434
- // @public
435
- export interface DataImportDetails {
436
- accountDetails: DataAccountDetailsUnion;
437
- logCollectionLevel?: LogCollectionLevel;
438
- }
439
-
440
- // @public
441
- export interface DataLocationToServiceLocationMap {
442
- readonly dataLocation?: string;
443
- readonly serviceLocation?: string;
444
- }
445
-
446
- // @public
447
- export interface DataTransferDetailsValidationRequest extends ValidationInputRequest {
448
- dataExportDetails?: DataExportDetails[];
449
- dataImportDetails?: DataImportDetails[];
450
- deviceType: SkuName;
451
- model?: ModelName;
452
- transferType: TransferType;
453
- validationType: "ValidateDataTransferDetails";
454
- }
455
-
456
- // @public
457
- export interface DataTransferDetailsValidationResponseProperties extends ValidationInputResponse {
458
- readonly status?: ValidationStatus;
459
- validationType: "ValidateDataTransferDetails";
460
- }
461
-
462
- // @public
463
- export interface DcAccessSecurityCode {
464
- forwardDCAccessCode?: string;
465
- reverseDCAccessCode?: string;
466
- }
467
-
468
- // @public
469
- export type DelayNotificationStatus = string;
470
-
471
- // @public (undocumented)
472
- export interface Details {
473
- // (undocumented)
474
- code: string;
475
- // (undocumented)
476
- message: string;
477
- }
478
-
479
- // @public
480
- export interface DeviceCapabilityDetails {
481
- readonly hardwareEncryption?: HardwareEncryption;
482
- }
483
-
484
- // @public
485
- export interface DeviceCapabilityRequest {
486
- model?: ModelName;
487
- skuName?: SkuName;
488
- }
489
-
490
- // @public
491
- export interface DeviceCapabilityResponse {
492
- readonly deviceCapabilityDetails?: DeviceCapabilityDetails[];
493
- }
494
-
495
- // @public
496
- export interface DeviceErasureDetails {
497
- readonly deviceErasureStatus?: StageStatus;
498
- readonly erasureOrDestructionCertificateSasKey?: string;
499
- }
500
-
501
- // @public
502
- export interface DiskScheduleAvailabilityRequest extends ScheduleAvailabilityRequest {
503
- expectedDataSizeInTeraBytes: number;
504
- skuName: "DataBoxDisk";
505
- }
506
-
507
- // @public
508
- export interface DiskSecret {
509
- readonly bitLockerKey?: string;
510
- readonly diskSerialNumber?: string;
511
- }
512
-
513
- // @public
514
- export type DoubleEncryption = "Enabled" | "Disabled";
515
-
516
- // @public
517
- export interface EncryptionPreferences {
518
- doubleEncryption?: DoubleEncryption;
519
- hardwareEncryption?: HardwareEncryption;
520
- }
521
-
522
- // @public (undocumented)
523
- export interface ErrorDetail {
524
- // (undocumented)
525
- code: string;
526
- // (undocumented)
527
- details?: Details[];
528
- // (undocumented)
529
- message: string;
530
- // (undocumented)
531
- target?: string;
532
- }
533
-
534
- // @public
535
- export interface ExportDiskDetails {
536
- readonly backupManifestCloudPath?: string;
537
- readonly manifestFile?: string;
538
- readonly manifestHash?: string;
539
- }
540
-
541
- // @public
542
- export interface FilterFileDetails {
543
- filterFilePath: string;
544
- filterFileType: FilterFileType;
545
- }
546
-
547
- // @public
548
- export type FilterFileType = "AzureBlob" | "AzureFile";
549
-
550
- // @public
551
- export function getContinuationToken(page: unknown): string | undefined;
552
-
553
- // @public
554
- export interface GranularCopyLogDetails {
555
- copyLogDetailsType: "DataBoxCustomerDisk";
556
- }
557
-
558
- // @public (undocumented)
559
- export type GranularCopyLogDetailsUnion = GranularCopyLogDetails | DataBoxDiskGranularCopyLogDetails;
560
-
561
- // @public
562
- export interface GranularCopyProgress {
563
- readonly accountId?: string;
564
- readonly actions?: CustomerResolutionCode[];
565
- readonly bytesProcessed?: number;
566
- readonly dataAccountType?: DataAccountType;
567
- readonly directoriesErroredOut?: number;
568
- readonly error?: CloudError;
569
- readonly filesErroredOut?: number;
570
- readonly filesProcessed?: number;
571
- readonly invalidDirectoriesProcessed?: number;
572
- readonly invalidFileBytesUploaded?: number;
573
- readonly invalidFilesProcessed?: number;
574
- readonly isEnumerationInProgress?: boolean;
575
- readonly renamedContainerCount?: number;
576
- readonly storageAccountName?: string;
577
- readonly totalBytesToProcess?: number;
578
- readonly totalFilesToProcess?: number;
579
- readonly transferType?: TransferType;
580
- }
581
-
582
- // @public
583
- export type HardwareEncryption = "Enabled" | "Disabled";
584
-
585
- // @public
586
- export interface HeavyScheduleAvailabilityRequest extends ScheduleAvailabilityRequest {
587
- skuName: "DataBoxHeavy";
588
- }
589
-
590
- // @public
591
- export interface IdentityProperties {
592
- type?: string;
593
- userAssigned?: UserAssignedProperties;
594
- }
595
-
596
- // @public
597
- export interface ImportDiskDetails {
598
- readonly backupManifestCloudPath?: string;
599
- bitLockerKey: string;
600
- manifestFile: string;
601
- manifestHash: string;
602
- }
603
-
604
- // @public
605
- export interface JobDelayDetails {
606
- readonly description?: string;
607
- readonly errorCode?: PortalDelayErrorCode;
608
- readonly resolutionTime?: Date;
609
- readonly startTime?: Date;
610
- readonly status?: DelayNotificationStatus;
611
- }
612
-
613
- // @public
614
- export interface JobDeliveryInfo {
615
- scheduledDateTime?: Date;
616
- }
617
-
618
- // @public
619
- export type JobDeliveryType = "NonScheduled" | "Scheduled";
620
-
621
- // @public
622
- export interface JobDetails {
623
- readonly actions?: CustomerResolutionCode[];
624
- readonly chainOfCustodySasKey?: string;
625
- contactDetails: ContactDetails;
626
- readonly copyLogDetails?: CopyLogDetailsUnion[];
627
- readonly datacenterAddress?: DatacenterAddressResponseUnion;
628
- readonly dataCenterCode?: DataCenterCode;
629
- dataExportDetails?: DataExportDetails[];
630
- dataImportDetails?: DataImportDetails[];
631
- readonly deliveryPackage?: PackageShippingDetails;
632
- readonly deviceErasureDetails?: DeviceErasureDetails;
633
- expectedDataSizeInTeraBytes?: number;
634
- jobDetailsType: "DataBoxCustomerDisk" | "DataBoxDisk" | "DataBoxHeavy" | "DataBox";
635
- readonly jobStages?: JobStages[];
636
- keyEncryptionKey?: KeyEncryptionKey;
637
- readonly lastMitigationActionOnJob?: LastMitigationActionOnJob;
638
- preferences?: Preferences;
639
- readonly returnPackage?: PackageShippingDetails;
640
- readonly reverseShipmentLabelSasKey?: string;
641
- reverseShippingDetails?: ReverseShippingDetails;
642
- shippingAddress?: ShippingAddress;
643
- }
644
-
645
- // @public (undocumented)
646
- export type JobDetailsUnion = JobDetails | DataBoxCustomerDiskJobDetails | DataBoxDiskJobDetails | DataBoxHeavyJobDetails | DataBoxJobDetails;
647
-
648
- // @public
649
- export interface JobResource extends Resource {
650
- readonly allDevicesLost?: boolean;
651
- readonly cancellationReason?: string;
652
- readonly delayedStage?: StageName;
653
- deliveryInfo?: JobDeliveryInfo;
654
- deliveryType?: JobDeliveryType;
655
- details?: JobDetailsUnion;
656
- readonly error?: CloudError;
657
- readonly id?: string;
658
- readonly isCancellable?: boolean;
659
- readonly isCancellableWithoutFee?: boolean;
660
- readonly isDeletable?: boolean;
661
- readonly isPrepareToShipEnabled?: boolean;
662
- readonly isShippingAddressEditable?: boolean;
663
- readonly name?: string;
664
- readonly reverseShippingDetailsUpdate?: ReverseShippingDetailsEditStatus;
665
- readonly reverseTransportPreferenceUpdate?: ReverseTransportPreferenceEditStatus;
666
- readonly startTime?: Date;
667
- readonly status?: StageName;
668
- readonly systemData?: SystemData;
669
- transferType: TransferType;
670
- readonly type?: string;
671
- }
672
-
673
- // @public
674
- export interface JobResourceList {
675
- nextLink?: string;
676
- value?: JobResource[];
677
- }
678
-
679
- // @public
680
- export interface JobResourceUpdateParameter {
681
- details?: UpdateJobDetails;
682
- identity?: ResourceIdentity;
683
- tags?: {
684
- [propertyName: string]: string;
685
- };
686
- }
687
-
688
- // @public
689
- export interface Jobs {
690
- beginCreate(resourceGroupName: string, jobName: string, jobResource: JobResource, options?: JobsCreateOptionalParams): Promise<SimplePollerLike<OperationState<JobsCreateResponse>, JobsCreateResponse>>;
691
- beginCreateAndWait(resourceGroupName: string, jobName: string, jobResource: JobResource, options?: JobsCreateOptionalParams): Promise<JobsCreateResponse>;
692
- beginDelete(resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
693
- beginDeleteAndWait(resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams): Promise<void>;
694
- beginUpdate(resourceGroupName: string, jobName: string, jobResourceUpdateParameter: JobResourceUpdateParameter, options?: JobsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<JobsUpdateResponse>, JobsUpdateResponse>>;
695
- beginUpdateAndWait(resourceGroupName: string, jobName: string, jobResourceUpdateParameter: JobResourceUpdateParameter, options?: JobsUpdateOptionalParams): Promise<JobsUpdateResponse>;
696
- bookShipmentPickUp(resourceGroupName: string, jobName: string, shipmentPickUpRequest: ShipmentPickUpRequest, options?: JobsBookShipmentPickUpOptionalParams): Promise<JobsBookShipmentPickUpResponse>;
697
- cancel(resourceGroupName: string, jobName: string, cancellationReason: CancellationReason, options?: JobsCancelOptionalParams): Promise<void>;
698
- get(resourceGroupName: string, jobName: string, options?: JobsGetOptionalParams): Promise<JobsGetResponse>;
699
- list(options?: JobsListOptionalParams): PagedAsyncIterableIterator<JobResource>;
700
- listByResourceGroup(resourceGroupName: string, options?: JobsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<JobResource>;
701
- listCredentials(resourceGroupName: string, jobName: string, options?: JobsListCredentialsOptionalParams): PagedAsyncIterableIterator<UnencryptedCredentials>;
702
- markDevicesShipped(jobName: string, resourceGroupName: string, markDevicesShippedRequest: MarkDevicesShippedRequest, options?: JobsMarkDevicesShippedOptionalParams): Promise<void>;
703
- }
704
-
705
- // @public
706
- export interface JobsBookShipmentPickUpOptionalParams extends coreClient.OperationOptions {
707
- }
708
-
709
- // @public
710
- export type JobsBookShipmentPickUpResponse = ShipmentPickUpResponse;
711
-
712
- // @public
713
- export interface JobsCancelOptionalParams extends coreClient.OperationOptions {
714
- }
715
-
716
- // @public
717
- export interface JobsCreateOptionalParams extends coreClient.OperationOptions {
718
- resumeFrom?: string;
719
- updateIntervalInMs?: number;
720
- }
721
-
722
- // @public
723
- export type JobsCreateResponse = JobResource;
724
-
725
- // @public
726
- export interface JobsDeleteHeaders {
727
- location?: string;
728
- }
729
-
730
- // @public
731
- export interface JobsDeleteOptionalParams extends coreClient.OperationOptions {
732
- resumeFrom?: string;
733
- updateIntervalInMs?: number;
734
- }
735
-
736
- // @public
737
- export interface JobSecrets {
738
- readonly dcAccessSecurityCode?: DcAccessSecurityCode;
739
- readonly error?: CloudError;
740
- jobSecretsType: "DataBoxCustomerDisk" | "DataBoxDisk" | "DataBoxHeavy" | "DataBox";
741
- }
742
-
743
- // @public (undocumented)
744
- export type JobSecretsUnion = JobSecrets | CustomerDiskJobSecrets | DataBoxDiskJobSecrets | DataBoxHeavyJobSecrets | DataboxJobSecrets;
745
-
746
- // @public
747
- export interface JobsGetOptionalParams extends coreClient.OperationOptions {
748
- expand?: string;
749
- }
750
-
751
- // @public
752
- export type JobsGetResponse = JobResource;
753
-
754
- // @public
755
- export interface JobsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
756
- }
757
-
758
- // @public
759
- export type JobsListByResourceGroupNextResponse = JobResourceList;
760
-
761
- // @public
762
- export interface JobsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
763
- skipToken?: string;
764
- }
765
-
766
- // @public
767
- export type JobsListByResourceGroupResponse = JobResourceList;
768
-
769
- // @public
770
- export interface JobsListCredentialsOptionalParams extends coreClient.OperationOptions {
771
- }
772
-
773
- // @public
774
- export type JobsListCredentialsResponse = UnencryptedCredentialsList;
775
-
776
- // @public
777
- export interface JobsListNextOptionalParams extends coreClient.OperationOptions {
778
- }
779
-
780
- // @public
781
- export type JobsListNextResponse = JobResourceList;
782
-
783
- // @public
784
- export interface JobsListOptionalParams extends coreClient.OperationOptions {
785
- skipToken?: string;
786
- }
787
-
788
- // @public
789
- export type JobsListResponse = JobResourceList;
790
-
791
- // @public
792
- export interface JobsMarkDevicesShippedOptionalParams extends coreClient.OperationOptions {
793
- }
794
-
795
- // @public
796
- export interface JobStages {
797
- readonly delayInformation?: JobDelayDetails[];
798
- readonly displayName?: string;
799
- readonly jobStageDetails?: Record<string, unknown>;
800
- readonly stageName?: StageName;
801
- readonly stageStatus?: StageStatus;
802
- readonly stageTime?: Date;
803
- }
804
-
805
- // @public
806
- export interface JobsUpdateHeaders {
807
- location?: string;
808
- }
809
-
810
- // @public
811
- export interface JobsUpdateOptionalParams extends coreClient.OperationOptions {
812
- ifMatch?: string;
813
- resumeFrom?: string;
814
- updateIntervalInMs?: number;
815
- }
816
-
817
- // @public
818
- export type JobsUpdateResponse = JobResource;
819
-
820
- // @public
821
- export type KekType = "MicrosoftManaged" | "CustomerManaged";
822
-
823
- // @public
824
- export interface KeyEncryptionKey {
825
- identityProperties?: IdentityProperties;
826
- kekType: KekType;
827
- kekUrl?: string;
828
- kekVaultResourceID?: string;
829
- }
830
-
831
- // @public
832
- export enum KnownCopyStatus {
833
- Completed = "Completed",
834
- CompletedWithErrors = "CompletedWithErrors",
835
- DeviceFormatted = "DeviceFormatted",
836
- DeviceMetadataModified = "DeviceMetadataModified",
837
- DriveCorrupted = "DriveCorrupted",
838
- DriveNotDetected = "DriveNotDetected",
839
- DriveNotReceived = "DriveNotReceived",
840
- Failed = "Failed",
841
- HardwareError = "HardwareError",
842
- InProgress = "InProgress",
843
- MetadataFilesModifiedOrRemoved = "MetadataFilesModifiedOrRemoved",
844
- NotReturned = "NotReturned",
845
- NotStarted = "NotStarted",
846
- OtherServiceError = "OtherServiceError",
847
- OtherUserError = "OtherUserError",
848
- StorageAccountNotAccessible = "StorageAccountNotAccessible",
849
- UnsupportedData = "UnsupportedData",
850
- UnsupportedDrive = "UnsupportedDrive"
851
- }
852
-
853
- // @public
854
- export enum KnownDataCenterCode {
855
- AdHoc = "AdHoc",
856
- AM2 = "AM2",
857
- AMS06 = "AMS06",
858
- AMS20 = "AMS20",
859
- AMS25 = "AMS25",
860
- AUH20 = "AUH20",
861
- BJB = "BJB",
862
- BJS20 = "BJS20",
863
- BL20 = "BL20",
864
- BL24 = "BL24",
865
- BL7 = "BL7",
866
- BN1 = "BN1",
867
- BN7 = "BN7",
868
- BOM01 = "BOM01",
869
- BY1 = "BY1",
870
- BY2 = "BY2",
871
- BY21 = "BY21",
872
- BY24 = "BY24",
873
- CBR20 = "CBR20",
874
- CH1 = "CH1",
875
- CPQ02 = "CPQ02",
876
- CPQ20 = "CPQ20",
877
- CPQ21 = "CPQ21",
878
- CWL20 = "CWL20",
879
- CYS04 = "CYS04",
880
- DSM05 = "DSM05",
881
- DSM11 = "DSM11",
882
- DUB07 = "DUB07",
883
- DXB23 = "DXB23",
884
- FRA22 = "FRA22",
885
- HKG20 = "HKG20",
886
- IDC5 = "IDC5",
887
- Invalid = "Invalid",
888
- JNB21 = "JNB21",
889
- JNB22 = "JNB22",
890
- LON24 = "LON24",
891
- MAA01 = "MAA01",
892
- MEL23 = "MEL23",
893
- MNZ21 = "MNZ21",
894
- MWH01 = "MWH01",
895
- NTG20 = "NTG20",
896
- ORK70 = "ORK70",
897
- OSA02 = "OSA02",
898
- OSA20 = "OSA20",
899
- OSA22 = "OSA22",
900
- OSA23 = "OSA23",
901
- PAR22 = "PAR22",
902
- PNQ01 = "PNQ01",
903
- PUS20 = "PUS20",
904
- SEL20 = "SEL20",
905
- SEL21 = "SEL21",
906
- SG2 = "SG2",
907
- SHA03 = "SHA03",
908
- SIN20 = "SIN20",
909
- SN5 = "SN5",
910
- SN6 = "SN6",
911
- SN8 = "SN8",
912
- SSE90 = "SSE90",
913
- SVG20 = "SVG20",
914
- SYD03 = "SYD03",
915
- SYD23 = "SYD23",
916
- TYO01 = "TYO01",
917
- TYO22 = "TYO22",
918
- TYO23 = "TYO23",
919
- YQB20 = "YQB20",
920
- YTO20 = "YTO20",
921
- YTO21 = "YTO21",
922
- ZRH20 = "ZRH20"
923
- }
924
-
925
- // @public
926
- export enum KnownDelayNotificationStatus {
927
- Active = "Active",
928
- Resolved = "Resolved"
929
- }
930
-
931
- // @public
932
- export enum KnownNotificationStageName {
933
- AtAzureDC = "AtAzureDC",
934
- Created = "Created",
935
- DataCopy = "DataCopy",
936
- Delivered = "Delivered",
937
- DevicePrepared = "DevicePrepared",
938
- Dispatched = "Dispatched",
939
- PickedUp = "PickedUp",
940
- ShippedToCustomer = "ShippedToCustomer"
941
- }
942
-
943
- // @public
944
- export enum KnownPortalDelayErrorCode {
945
- ActiveOrderLimitBreachedDelay = "ActiveOrderLimitBreachedDelay",
946
- HighDemandDelay = "HighDemandDelay",
947
- InternalIssueDelay = "InternalIssueDelay",
948
- LargeNumberOfFilesDelay = "LargeNumberOfFilesDelay"
949
- }
950
-
951
- // @public
952
- export enum KnownStageName {
953
- Aborted = "Aborted",
954
- AtAzureDC = "AtAzureDC",
955
- AwaitingShipmentDetails = "AwaitingShipmentDetails",
956
- Cancelled = "Cancelled",
957
- Completed = "Completed",
958
- CompletedWithErrors = "CompletedWithErrors",
959
- CompletedWithWarnings = "CompletedWithWarnings",
960
- Created = "Created",
961
- DataCopy = "DataCopy",
962
- Delivered = "Delivered",
963
- DeviceOrdered = "DeviceOrdered",
964
- DevicePrepared = "DevicePrepared",
965
- Dispatched = "Dispatched",
966
- FailedIssueDetectedAtAzureDC = "Failed_IssueDetectedAtAzureDC",
967
- FailedIssueReportedAtCustomer = "Failed_IssueReportedAtCustomer",
968
- PickedUp = "PickedUp",
969
- PreparingToShipFromAzureDC = "PreparingToShipFromAzureDC",
970
- ReadyToDispatchFromAzureDC = "ReadyToDispatchFromAzureDC",
971
- ReadyToReceiveAtAzureDC = "ReadyToReceiveAtAzureDC",
972
- ShippedToAzureDC = "ShippedToAzureDC",
973
- ShippedToCustomer = "ShippedToCustomer"
974
- }
975
-
976
- // @public
977
- export interface LastMitigationActionOnJob {
978
- actionDateTimeInUtc?: Date;
979
- customerResolution?: CustomerResolutionCode;
980
- isPerformedByCustomer?: boolean;
981
- }
982
-
983
- // @public
984
- export type LogCollectionLevel = "Error" | "Verbose";
985
-
986
- // @public
987
- export interface ManagedDiskDetails extends DataAccountDetails {
988
- dataAccountType: "ManagedDisk";
989
- resourceGroupId: string;
990
- stagingStorageAccountId: string;
991
- }
992
-
993
- // @public
994
- export interface MarkDevicesShippedRequest {
995
- deliverToDcPackageDetails: PackageCarrierInfo;
996
- }
997
-
998
- // @public
999
- export interface MitigateJobRequest {
1000
- customerResolutionCode?: CustomerResolutionCode;
1001
- serialNumberCustomerResolutionMap?: {
1002
- [propertyName: string]: CustomerResolutionCode;
1003
- };
1004
- }
1005
-
1006
- // @public
1007
- export interface MitigateOptionalParams extends coreClient.OperationOptions {
1008
- }
1009
-
1010
- // @public
1011
- export type ModelName = "DataBox" | "DataBoxDisk" | "DataBoxHeavy" | "DataBoxCustomerDisk" | "AzureDataBox120" | "AzureDataBox525";
1012
-
1013
- // @public
1014
- export interface NotificationPreference {
1015
- sendNotification: boolean;
1016
- stageName: NotificationStageName;
1017
- }
1018
-
1019
- // @public
1020
- export type NotificationStageName = string;
1021
-
1022
- // @public
1023
- export interface Operation {
1024
- readonly display?: OperationDisplay;
1025
- isDataAction?: boolean;
1026
- readonly name?: string;
1027
- readonly origin?: string;
1028
- readonly properties?: Record<string, unknown>;
1029
- }
1030
-
1031
- // @public
1032
- export interface OperationDisplay {
1033
- description?: string;
1034
- operation?: string;
1035
- provider?: string;
1036
- resource?: string;
1037
- }
1038
-
1039
- // @public
1040
- export interface OperationList {
1041
- nextLink?: string;
1042
- readonly value?: Operation[];
1043
- }
1044
-
1045
- // @public
1046
- export interface Operations {
1047
- list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
1048
- }
1049
-
1050
- // @public
1051
- export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
1052
- }
1053
-
1054
- // @public
1055
- export type OperationsListNextResponse = OperationList;
1056
-
1057
- // @public
1058
- export interface OperationsListOptionalParams extends coreClient.OperationOptions {
1059
- }
1060
-
1061
- // @public
1062
- export type OperationsListResponse = OperationList;
1063
-
1064
- // @public
1065
- export type OverallValidationStatus = "AllValidToProceed" | "InputsRevisitRequired" | "CertainInputValidationsSkipped";
1066
-
1067
- // @public
1068
- export interface PackageCarrierDetails {
1069
- carrierAccountNumber?: string;
1070
- carrierName?: string;
1071
- trackingId?: string;
1072
- }
1073
-
1074
- // @public
1075
- export interface PackageCarrierInfo {
1076
- carrierName?: string;
1077
- trackingId?: string;
1078
- }
1079
-
1080
- // @public
1081
- export interface PackageShippingDetails {
1082
- readonly carrierName?: string;
1083
- readonly trackingId?: string;
1084
- readonly trackingUrl?: string;
1085
- }
1086
-
1087
- // @public
1088
- export type PortalDelayErrorCode = string;
1089
-
1090
- // @public
1091
- export interface Preferences {
1092
- encryptionPreferences?: EncryptionPreferences;
1093
- preferredDataCenterRegion?: string[];
1094
- reverseTransportPreferences?: TransportPreferences;
1095
- storageAccountAccessTierPreferences?: string[];
1096
- transportPreferences?: TransportPreferences;
1097
- }
1098
-
1099
- // @public
1100
- export interface PreferencesValidationRequest extends ValidationInputRequest {
1101
- deviceType: SkuName;
1102
- model?: ModelName;
1103
- preference?: Preferences;
1104
- validationType: "ValidatePreferences";
1105
- }
1106
-
1107
- // @public
1108
- export interface PreferencesValidationResponseProperties extends ValidationInputResponse {
1109
- readonly status?: ValidationStatus;
1110
- validationType: "ValidatePreferences";
1111
- }
1112
-
1113
- // @public
1114
- export interface RegionConfigurationRequest {
1115
- datacenterAddressRequest?: DatacenterAddressRequest;
1116
- deviceCapabilityRequest?: DeviceCapabilityRequest;
1117
- scheduleAvailabilityRequest?: ScheduleAvailabilityRequestUnion;
1118
- transportAvailabilityRequest?: TransportAvailabilityRequest;
1119
- }
1120
-
1121
- // @public
1122
- export interface RegionConfigurationResponse {
1123
- readonly datacenterAddressResponse?: DatacenterAddressResponseUnion;
1124
- readonly deviceCapabilityResponse?: DeviceCapabilityResponse;
1125
- readonly scheduleAvailabilityResponse?: ScheduleAvailabilityResponse;
1126
- readonly transportAvailabilityResponse?: TransportAvailabilityResponse;
1127
- }
1128
-
1129
- // @public
1130
- export interface Resource {
1131
- identity?: ResourceIdentity;
1132
- location: string;
1133
- sku: Sku;
1134
- tags?: {
1135
- [propertyName: string]: string;
1136
- };
1137
- }
1138
-
1139
- // @public
1140
- export interface ResourceIdentity {
1141
- readonly principalId?: string;
1142
- readonly tenantId?: string;
1143
- type?: string;
1144
- userAssignedIdentities?: {
1145
- [propertyName: string]: UserAssignedIdentity;
1146
- };
1147
- }
1148
-
1149
- // @public
1150
- export interface ReverseShippingDetails {
1151
- contactDetails?: ContactInfo;
1152
- readonly isUpdated?: boolean;
1153
- shippingAddress?: ShippingAddress;
1154
- }
1155
-
1156
- // @public
1157
- export type ReverseShippingDetailsEditStatus = "Enabled" | "Disabled" | "NotSupported";
1158
-
1159
- // @public
1160
- export type ReverseTransportPreferenceEditStatus = "Enabled" | "Disabled" | "NotSupported";
1161
-
1162
- // @public
1163
- export interface ScheduleAvailabilityRequest {
1164
- country?: string;
1165
- model?: ModelName;
1166
- skuName: "DataBox" | "DataBoxDisk" | "DataBoxHeavy";
1167
- storageLocation: string;
1168
- }
1169
-
1170
- // @public (undocumented)
1171
- export type ScheduleAvailabilityRequestUnion = ScheduleAvailabilityRequest | DataBoxScheduleAvailabilityRequest | DiskScheduleAvailabilityRequest | HeavyScheduleAvailabilityRequest;
1172
-
1173
- // @public
1174
- export interface ScheduleAvailabilityResponse {
1175
- readonly availableDates?: Date[];
1176
- }
1177
-
1178
- // @public
1179
- export interface Service {
1180
- listAvailableSkusByResourceGroup(resourceGroupName: string, location: string, availableSkuRequest: AvailableSkuRequest, options?: ServiceListAvailableSkusByResourceGroupOptionalParams): PagedAsyncIterableIterator<SkuInformation>;
1181
- regionConfiguration(location: string, regionConfigurationRequest: RegionConfigurationRequest, options?: ServiceRegionConfigurationOptionalParams): Promise<ServiceRegionConfigurationResponse>;
1182
- regionConfigurationByResourceGroup(resourceGroupName: string, location: string, regionConfigurationRequest: RegionConfigurationRequest, options?: ServiceRegionConfigurationByResourceGroupOptionalParams): Promise<ServiceRegionConfigurationByResourceGroupResponse>;
1183
- validateAddress(location: string, validateAddress: ValidateAddress, options?: ServiceValidateAddressOptionalParams): Promise<ServiceValidateAddressResponse>;
1184
- validateInputs(location: string, validationRequest: ValidationRequestUnion, options?: ServiceValidateInputsOptionalParams): Promise<ServiceValidateInputsResponse>;
1185
- validateInputsByResourceGroup(resourceGroupName: string, location: string, validationRequest: ValidationRequestUnion, options?: ServiceValidateInputsByResourceGroupOptionalParams): Promise<ServiceValidateInputsByResourceGroupResponse>;
1186
- }
1187
-
1188
- // @public
1189
- export interface ServiceListAvailableSkusByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
1190
- }
1191
-
1192
- // @public
1193
- export type ServiceListAvailableSkusByResourceGroupNextResponse = AvailableSkusResult;
1194
-
1195
- // @public
1196
- export interface ServiceListAvailableSkusByResourceGroupOptionalParams extends coreClient.OperationOptions {
1197
- }
1198
-
1199
- // @public
1200
- export type ServiceListAvailableSkusByResourceGroupResponse = AvailableSkusResult;
1201
-
1202
- // @public
1203
- export interface ServiceRegionConfigurationByResourceGroupOptionalParams extends coreClient.OperationOptions {
1204
- }
1205
-
1206
- // @public
1207
- export type ServiceRegionConfigurationByResourceGroupResponse = RegionConfigurationResponse;
1208
-
1209
- // @public
1210
- export interface ServiceRegionConfigurationOptionalParams extends coreClient.OperationOptions {
1211
- }
1212
-
1213
- // @public
1214
- export type ServiceRegionConfigurationResponse = RegionConfigurationResponse;
1215
-
1216
- // @public
1217
- export interface ServiceValidateAddressOptionalParams extends coreClient.OperationOptions {
1218
- }
1219
-
1220
- // @public
1221
- export type ServiceValidateAddressResponse = AddressValidationOutput;
1222
-
1223
- // @public
1224
- export interface ServiceValidateInputsByResourceGroupOptionalParams extends coreClient.OperationOptions {
1225
- }
1226
-
1227
- // @public
1228
- export type ServiceValidateInputsByResourceGroupResponse = ValidationResponse;
1229
-
1230
- // @public
1231
- export interface ServiceValidateInputsOptionalParams extends coreClient.OperationOptions {
1232
- }
1233
-
1234
- // @public
1235
- export type ServiceValidateInputsResponse = ValidationResponse;
1236
-
1237
- // @public
1238
- export interface ShareCredentialDetails {
1239
- readonly password?: string;
1240
- readonly shareName?: string;
1241
- readonly shareType?: ShareDestinationFormatType;
1242
- readonly supportedAccessProtocols?: AccessProtocol[];
1243
- readonly userName?: string;
1244
- }
1245
-
1246
- // @public
1247
- export type ShareDestinationFormatType = "UnknownType" | "HCS" | "BlockBlob" | "PageBlob" | "AzureFile" | "ManagedDisk";
1248
-
1249
- // @public
1250
- export interface ShipmentPickUpRequest {
1251
- endTime: Date;
1252
- shipmentLocation: string;
1253
- startTime: Date;
1254
- }
1255
-
1256
- // @public
1257
- export interface ShipmentPickUpResponse {
1258
- readonly confirmationNumber?: string;
1259
- readonly readyByTime?: Date;
1260
- }
1261
-
1262
- // @public
1263
- export interface ShippingAddress {
1264
- addressType?: AddressType;
1265
- city?: string;
1266
- companyName?: string;
1267
- country: string;
1268
- postalCode?: string;
1269
- skipAddressValidation?: boolean;
1270
- stateOrProvince?: string;
1271
- streetAddress1: string;
1272
- streetAddress2?: string;
1273
- streetAddress3?: string;
1274
- taxIdentificationNumber?: string;
1275
- zipExtendedCode?: string;
1276
- }
1277
-
1278
- // @public
1279
- export interface Sku {
1280
- displayName?: string;
1281
- family?: string;
1282
- model?: ModelName;
1283
- name: SkuName;
1284
- }
1285
-
1286
- // @public
1287
- export interface SkuAvailabilityValidationRequest extends ValidationInputRequest {
1288
- country: string;
1289
- deviceType: SkuName;
1290
- location: string;
1291
- model?: ModelName;
1292
- transferType: TransferType;
1293
- validationType: "ValidateSkuAvailability";
1294
- }
1295
-
1296
- // @public
1297
- export interface SkuAvailabilityValidationResponseProperties extends ValidationInputResponse {
1298
- readonly status?: ValidationStatus;
1299
- validationType: "ValidateSkuAvailability";
1300
- }
1301
-
1302
- // @public
1303
- export interface SkuCapacity {
1304
- readonly individualSkuUsable?: string;
1305
- readonly maximum?: string;
1306
- readonly usable?: string;
1307
- }
1308
-
1309
- // @public
1310
- export interface SkuCost {
1311
- readonly meterId?: string;
1312
- readonly meterType?: string;
1313
- readonly multiplier?: number;
1314
- }
1315
-
1316
- // @public
1317
- export type SkuDisabledReason = "None" | "Country" | "Region" | "Feature" | "OfferType" | "NoSubscriptionInfo";
1318
-
1319
- // @public
1320
- export interface SkuInformation {
1321
- readonly apiVersions?: string[];
1322
- readonly capacity?: SkuCapacity;
1323
- readonly costs?: SkuCost[];
1324
- readonly countriesWithinCommerceBoundary?: string[];
1325
- readonly dataLocationToServiceLocationMap?: DataLocationToServiceLocationMap[];
1326
- readonly disabledReason?: SkuDisabledReason;
1327
- readonly disabledReasonMessage?: string;
1328
- readonly enabled?: boolean;
1329
- readonly requiredFeature?: string;
1330
- readonly sku?: Sku;
1331
- }
1332
-
1333
- // @public
1334
- export type SkuName = "DataBox" | "DataBoxDisk" | "DataBoxHeavy" | "DataBoxCustomerDisk";
1335
-
1336
- // @public
1337
- export type StageName = string;
1338
-
1339
- // @public
1340
- export type StageStatus = "None" | "InProgress" | "Succeeded" | "Failed" | "Cancelled" | "Cancelling" | "SucceededWithErrors" | "WaitingForCustomerAction" | "SucceededWithWarnings" | "WaitingForCustomerActionForKek" | "WaitingForCustomerActionForCleanUp" | "CustomerActionPerformedForCleanUp" | "CustomerActionPerformed";
1341
-
1342
- // @public
1343
- export interface StorageAccountDetails extends DataAccountDetails {
1344
- dataAccountType: "StorageAccount";
1345
- storageAccountId: string;
1346
- }
1347
-
1348
- // @public
1349
- export interface SubscriptionIsAllowedToCreateJobValidationRequest extends ValidationInputRequest {
1350
- validationType: "ValidateSubscriptionIsAllowedToCreateJob";
1351
- }
1352
-
1353
- // @public
1354
- export interface SubscriptionIsAllowedToCreateJobValidationResponseProperties extends ValidationInputResponse {
1355
- readonly status?: ValidationStatus;
1356
- validationType: "ValidateSubscriptionIsAllowedToCreateJob";
1357
- }
1358
-
1359
- // @public
1360
- export interface SystemData {
1361
- readonly createdAt?: Date;
1362
- readonly createdBy?: string;
1363
- readonly createdByType?: string;
1364
- readonly lastModifiedAt?: Date;
1365
- readonly lastModifiedBy?: string;
1366
- readonly lastModifiedByType?: string;
1367
- }
1368
-
1369
- // @public
1370
- export interface TransferAllDetails {
1371
- dataAccountType: DataAccountType;
1372
- transferAllBlobs?: boolean;
1373
- transferAllFiles?: boolean;
1374
- }
1375
-
1376
- // @public
1377
- export interface TransferConfiguration {
1378
- transferAllDetails?: TransferConfigurationTransferAllDetails;
1379
- transferConfigurationType: TransferConfigurationType;
1380
- transferFilterDetails?: TransferConfigurationTransferFilterDetails;
1381
- }
1382
-
1383
- // @public
1384
- export interface TransferConfigurationTransferAllDetails {
1385
- include?: TransferAllDetails;
1386
- }
1387
-
1388
- // @public
1389
- export interface TransferConfigurationTransferFilterDetails {
1390
- include?: TransferFilterDetails;
1391
- }
1392
-
1393
- // @public
1394
- export type TransferConfigurationType = "TransferAll" | "TransferUsingFilter";
1395
-
1396
- // @public
1397
- export interface TransferFilterDetails {
1398
- azureFileFilterDetails?: AzureFileFilterDetails;
1399
- blobFilterDetails?: BlobFilterDetails;
1400
- dataAccountType: DataAccountType;
1401
- filterFileDetails?: FilterFileDetails[];
1402
- }
1403
-
1404
- // @public
1405
- export type TransferType = "ImportToAzure" | "ExportFromAzure";
1406
-
1407
- // @public
1408
- export interface TransportAvailabilityDetails {
1409
- readonly shipmentType?: TransportShipmentTypes;
1410
- }
1411
-
1412
- // @public
1413
- export interface TransportAvailabilityRequest {
1414
- model?: ModelName;
1415
- skuName?: SkuName;
1416
- }
1417
-
1418
- // @public
1419
- export interface TransportAvailabilityResponse {
1420
- readonly transportAvailabilityDetails?: TransportAvailabilityDetails[];
1421
- }
1422
-
1423
- // @public
1424
- export interface TransportPreferences {
1425
- readonly isUpdated?: boolean;
1426
- preferredShipmentType: TransportShipmentTypes;
1427
- }
1428
-
1429
- // @public
1430
- export type TransportShipmentTypes = "CustomerManaged" | "MicrosoftManaged";
1431
-
1432
- // @public
1433
- export interface UnencryptedCredentials {
1434
- readonly jobName?: string;
1435
- readonly jobSecrets?: JobSecretsUnion;
1436
- }
1437
-
1438
- // @public
1439
- export interface UnencryptedCredentialsList {
1440
- nextLink?: string;
1441
- value?: UnencryptedCredentials[];
1442
- }
1443
-
1444
- // @public
1445
- export interface UpdateJobDetails {
1446
- contactDetails?: ContactDetails;
1447
- keyEncryptionKey?: KeyEncryptionKey;
1448
- preferences?: Preferences;
1449
- returnToCustomerPackageDetails?: PackageCarrierDetails;
1450
- reverseShippingDetails?: ReverseShippingDetails;
1451
- shippingAddress?: ShippingAddress;
1452
- }
1453
-
1454
- // @public
1455
- export interface UserAssignedIdentity {
1456
- readonly clientId?: string;
1457
- readonly principalId?: string;
1458
- }
1459
-
1460
- // @public
1461
- export interface UserAssignedProperties {
1462
- resourceId?: string;
1463
- }
1464
-
1465
- // @public
1466
- export interface ValidateAddress extends ValidationInputRequest {
1467
- deviceType: SkuName;
1468
- model?: ModelName;
1469
- shippingAddress: ShippingAddress;
1470
- transportPreferences?: TransportPreferences;
1471
- validationType: "ValidateAddress";
1472
- }
1473
-
1474
- // @public
1475
- export type ValidationInputDiscriminator = "ValidateAddress" | "ValidateSubscriptionIsAllowedToCreateJob" | "ValidatePreferences" | "ValidateCreateOrderLimit" | "ValidateSkuAvailability" | "ValidateDataTransferDetails";
1476
-
1477
- // @public
1478
- export interface ValidationInputRequest {
1479
- validationType: "ValidateAddress" | "ValidateCreateOrderLimit" | "ValidateDataTransferDetails" | "ValidatePreferences" | "ValidateSkuAvailability" | "ValidateSubscriptionIsAllowedToCreateJob";
1480
- }
1481
-
1482
- // @public (undocumented)
1483
- export type ValidationInputRequestUnion = ValidationInputRequest | ValidateAddress | CreateOrderLimitForSubscriptionValidationRequest | DataTransferDetailsValidationRequest | PreferencesValidationRequest | SkuAvailabilityValidationRequest | SubscriptionIsAllowedToCreateJobValidationRequest;
1484
-
1485
- // @public
1486
- export interface ValidationInputResponse {
1487
- readonly error?: CloudError;
1488
- validationType: "ValidateAddress" | "ValidateCreateOrderLimit" | "ValidateDataTransferDetails" | "ValidatePreferences" | "ValidateSkuAvailability" | "ValidateSubscriptionIsAllowedToCreateJob";
1489
- }
1490
-
1491
- // @public (undocumented)
1492
- export type ValidationInputResponseUnion = ValidationInputResponse | AddressValidationProperties | CreateOrderLimitForSubscriptionValidationResponseProperties | DataTransferDetailsValidationResponseProperties | PreferencesValidationResponseProperties | SkuAvailabilityValidationResponseProperties | SubscriptionIsAllowedToCreateJobValidationResponseProperties;
1493
-
1494
- // @public
1495
- export interface ValidationRequest {
1496
- individualRequestDetails: ValidationInputRequestUnion[];
1497
- validationCategory: "JobCreationValidation";
1498
- }
1499
-
1500
- // @public (undocumented)
1501
- export type ValidationRequestUnion = ValidationRequest | CreateJobValidations;
1502
-
1503
- // @public
1504
- export interface ValidationResponse {
1505
- readonly individualResponseDetails?: ValidationInputResponseUnion[];
1506
- readonly status?: OverallValidationStatus;
1507
- }
1508
-
1509
- // @public
1510
- export type ValidationStatus = "Valid" | "Invalid" | "Skipped";
1511
-
1512
- // (No @packageDocumentation comment for this package)
1513
-
1514
- ```
1
+ ## API Report File for "@azure/arm-databox"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+
7
+ import * as coreAuth from '@azure/core-auth';
8
+ import * as coreClient from '@azure/core-client';
9
+ import { OperationState } from '@azure/core-lro';
10
+ import { PagedAsyncIterableIterator } from '@azure/core-paging';
11
+ import { SimplePollerLike } from '@azure/core-lro';
12
+
13
+ // @public
14
+ export type AccessProtocol = "SMB" | "NFS";
15
+
16
+ // @public
17
+ export interface AccountCredentialDetails {
18
+ readonly accountConnectionString?: string;
19
+ readonly accountName?: string;
20
+ readonly dataAccountType?: DataAccountType;
21
+ readonly shareCredentialDetails?: ShareCredentialDetails[];
22
+ }
23
+
24
+ // @public
25
+ export interface AdditionalErrorInfo {
26
+ info?: Record<string, unknown>;
27
+ type?: string;
28
+ }
29
+
30
+ // @public
31
+ export type AddressType = "None" | "Residential" | "Commercial";
32
+
33
+ // @public
34
+ export interface AddressValidationOutput {
35
+ readonly alternateAddresses?: ShippingAddress[];
36
+ readonly error?: CloudError;
37
+ readonly validationStatus?: AddressValidationStatus;
38
+ validationType?: ValidationInputDiscriminator;
39
+ }
40
+
41
+ // @public
42
+ export interface AddressValidationProperties extends ValidationInputResponse {
43
+ readonly alternateAddresses?: ShippingAddress[];
44
+ readonly validationStatus?: AddressValidationStatus;
45
+ validationType: "ValidateAddress";
46
+ }
47
+
48
+ // @public
49
+ export type AddressValidationStatus = "Valid" | "Invalid" | "Ambiguous";
50
+
51
+ // @public (undocumented)
52
+ export interface ApiError {
53
+ // (undocumented)
54
+ error: ErrorDetail;
55
+ }
56
+
57
+ // @public
58
+ export interface ApplianceNetworkConfiguration {
59
+ readonly macAddress?: string;
60
+ readonly name?: string;
61
+ }
62
+
63
+ // @public
64
+ export interface ArmBaseObject {
65
+ readonly id?: string;
66
+ readonly name?: string;
67
+ readonly type?: string;
68
+ }
69
+
70
+ // @public
71
+ export interface AvailableSkuRequest {
72
+ country: string;
73
+ location: string;
74
+ skuNames?: SkuName[];
75
+ transferType: TransferType;
76
+ }
77
+
78
+ // @public
79
+ export interface AvailableSkusResult {
80
+ nextLink?: string;
81
+ readonly value?: SkuInformation[];
82
+ }
83
+
84
+ // @public
85
+ export interface AzureFileFilterDetails {
86
+ filePathList?: string[];
87
+ filePrefixList?: string[];
88
+ fileShareList?: string[];
89
+ }
90
+
91
+ // @public
92
+ export interface BlobFilterDetails {
93
+ blobPathList?: string[];
94
+ blobPrefixList?: string[];
95
+ containerList?: string[];
96
+ }
97
+
98
+ // @public
99
+ export interface CancellationReason {
100
+ reason: string;
101
+ }
102
+
103
+ // @public
104
+ export type ClassDiscriminator = "DataBox" | "DataBoxDisk" | "DataBoxHeavy" | "DataBoxCustomerDisk";
105
+
106
+ // @public
107
+ export interface CloudError {
108
+ readonly additionalInfo?: AdditionalErrorInfo[];
109
+ code?: string;
110
+ readonly details?: CloudError[];
111
+ message?: string;
112
+ target?: string;
113
+ }
114
+
115
+ // @public
116
+ export interface ContactDetails {
117
+ contactName: string;
118
+ emailList: string[];
119
+ mobile?: string;
120
+ notificationPreference?: NotificationPreference[];
121
+ phone: string;
122
+ phoneExtension?: string;
123
+ }
124
+
125
+ // @public
126
+ export interface ContactInfo {
127
+ contactName: string;
128
+ mobile?: string;
129
+ phone: string;
130
+ phoneExtension?: string;
131
+ }
132
+
133
+ // @public
134
+ export interface CopyLogDetails {
135
+ copyLogDetailsType: "DataBox" | "DataBoxCustomerDisk" | "DataBoxDisk" | "DataBoxHeavy";
136
+ }
137
+
138
+ // @public (undocumented)
139
+ export type CopyLogDetailsUnion = CopyLogDetails | DataBoxAccountCopyLogDetails | DataBoxCustomerDiskCopyLogDetails | DataBoxDiskCopyLogDetails | DataBoxHeavyAccountCopyLogDetails;
140
+
141
+ // @public
142
+ export interface CopyProgress {
143
+ readonly accountId?: string;
144
+ readonly actions?: CustomerResolutionCode[];
145
+ readonly bytesProcessed?: number;
146
+ readonly dataAccountType?: DataAccountType;
147
+ readonly directoriesErroredOut?: number;
148
+ readonly error?: CloudError;
149
+ readonly filesErroredOut?: number;
150
+ readonly filesProcessed?: number;
151
+ readonly invalidDirectoriesProcessed?: number;
152
+ readonly invalidFileBytesUploaded?: number;
153
+ readonly invalidFilesProcessed?: number;
154
+ readonly isEnumerationInProgress?: boolean;
155
+ readonly renamedContainerCount?: number;
156
+ readonly storageAccountName?: string;
157
+ readonly totalBytesToProcess?: number;
158
+ readonly totalFilesToProcess?: number;
159
+ readonly transferType?: TransferType;
160
+ }
161
+
162
+ // @public
163
+ export type CopyStatus = string;
164
+
165
+ // @public
166
+ export interface CreateJobValidations extends ValidationRequest {
167
+ validationCategory: "JobCreationValidation";
168
+ }
169
+
170
+ // @public
171
+ export interface CreateOrderLimitForSubscriptionValidationRequest extends ValidationInputRequest {
172
+ deviceType: SkuName;
173
+ model?: ModelName;
174
+ validationType: "ValidateCreateOrderLimit";
175
+ }
176
+
177
+ // @public
178
+ export interface CreateOrderLimitForSubscriptionValidationResponseProperties extends ValidationInputResponse {
179
+ readonly status?: ValidationStatus;
180
+ validationType: "ValidateCreateOrderLimit";
181
+ }
182
+
183
+ // @public
184
+ export interface CustomerDiskJobSecrets extends JobSecrets {
185
+ readonly carrierAccountNumber?: string;
186
+ readonly diskSecrets?: DiskSecret[];
187
+ jobSecretsType: "DataBoxCustomerDisk";
188
+ }
189
+
190
+ // @public
191
+ export type CustomerResolutionCode = "None" | "MoveToCleanUpDevice" | "Resume" | "Restart" | "ReachOutToOperation";
192
+
193
+ // @public
194
+ export interface DataAccountDetails {
195
+ dataAccountType: "ManagedDisk" | "StorageAccount";
196
+ sharePassword?: string;
197
+ }
198
+
199
+ // @public (undocumented)
200
+ export type DataAccountDetailsUnion = DataAccountDetails | ManagedDiskDetails | StorageAccountDetails;
201
+
202
+ // @public
203
+ export type DataAccountType = "StorageAccount" | "ManagedDisk";
204
+
205
+ // @public
206
+ export interface DataBoxAccountCopyLogDetails extends CopyLogDetails {
207
+ readonly accountName?: string;
208
+ copyLogDetailsType: "DataBox";
209
+ readonly copyLogLink?: string;
210
+ readonly copyVerboseLogLink?: string;
211
+ }
212
+
213
+ // @public
214
+ export interface DataBoxCustomerDiskCopyLogDetails extends CopyLogDetails {
215
+ copyLogDetailsType: "DataBoxCustomerDisk";
216
+ readonly errorLogLink?: string;
217
+ readonly serialNumber?: string;
218
+ readonly verboseLogLink?: string;
219
+ }
220
+
221
+ // @public
222
+ export interface DataBoxCustomerDiskCopyProgress extends CopyProgress {
223
+ readonly copyStatus?: CopyStatus;
224
+ readonly serialNumber?: string;
225
+ }
226
+
227
+ // @public
228
+ export interface DataBoxCustomerDiskJobDetails extends JobDetails {
229
+ readonly copyProgress?: DataBoxCustomerDiskCopyProgress[];
230
+ readonly deliverToDcPackageDetails?: PackageCarrierInfo;
231
+ enableManifestBackup?: boolean;
232
+ readonly exportDiskDetailsCollection?: {
233
+ [propertyName: string]: ExportDiskDetails;
234
+ };
235
+ importDiskDetailsCollection?: {
236
+ [propertyName: string]: ImportDiskDetails;
237
+ };
238
+ jobDetailsType: "DataBoxCustomerDisk";
239
+ returnToCustomerPackageDetails: PackageCarrierDetails;
240
+ }
241
+
242
+ // @public
243
+ export interface DataBoxDiskCopyLogDetails extends CopyLogDetails {
244
+ copyLogDetailsType: "DataBoxDisk";
245
+ readonly diskSerialNumber?: string;
246
+ readonly errorLogLink?: string;
247
+ readonly verboseLogLink?: string;
248
+ }
249
+
250
+ // @public
251
+ export interface DataBoxDiskCopyProgress {
252
+ readonly actions?: CustomerResolutionCode[];
253
+ readonly bytesCopied?: number;
254
+ readonly error?: CloudError;
255
+ readonly percentComplete?: number;
256
+ readonly serialNumber?: string;
257
+ readonly status?: CopyStatus;
258
+ }
259
+
260
+ // @public
261
+ export interface DataBoxDiskGranularCopyLogDetails extends GranularCopyLogDetails {
262
+ readonly accountId?: string;
263
+ copyLogDetailsType: "DataBoxCustomerDisk";
264
+ readonly errorLogLink?: string;
265
+ readonly serialNumber?: string;
266
+ readonly verboseLogLink?: string;
267
+ }
268
+
269
+ // @public
270
+ export interface DataBoxDiskGranularCopyProgress extends GranularCopyProgress {
271
+ readonly copyStatus?: CopyStatus;
272
+ readonly serialNumber?: string;
273
+ }
274
+
275
+ // @public
276
+ export interface DataBoxDiskJobDetails extends JobDetails {
277
+ readonly copyProgress?: DataBoxDiskCopyProgress[];
278
+ readonly disksAndSizeDetails?: {
279
+ [propertyName: string]: number;
280
+ };
281
+ readonly granularCopyLogDetails?: DataBoxDiskGranularCopyLogDetails[];
282
+ readonly granularCopyProgress?: DataBoxDiskGranularCopyProgress[];
283
+ jobDetailsType: "DataBoxDisk";
284
+ passkey?: string;
285
+ preferredDisks?: {
286
+ [propertyName: string]: number;
287
+ };
288
+ }
289
+
290
+ // @public
291
+ export interface DataBoxDiskJobSecrets extends JobSecrets {
292
+ readonly diskSecrets?: DiskSecret[];
293
+ readonly isPasskeyUserDefined?: boolean;
294
+ jobSecretsType: "DataBoxDisk";
295
+ readonly passKey?: string;
296
+ }
297
+
298
+ // @public
299
+ export interface DataBoxHeavyAccountCopyLogDetails extends CopyLogDetails {
300
+ readonly accountName?: string;
301
+ copyLogDetailsType: "DataBoxHeavy";
302
+ readonly copyLogLink?: string[];
303
+ readonly copyVerboseLogLink?: string[];
304
+ }
305
+
306
+ // @public
307
+ export interface DataBoxHeavyJobDetails extends JobDetails {
308
+ readonly copyProgress?: CopyProgress[];
309
+ devicePassword?: string;
310
+ jobDetailsType: "DataBoxHeavy";
311
+ }
312
+
313
+ // @public
314
+ export interface DataBoxHeavyJobSecrets extends JobSecrets {
315
+ readonly cabinetPodSecrets?: DataBoxHeavySecret[];
316
+ jobSecretsType: "DataBoxHeavy";
317
+ }
318
+
319
+ // @public
320
+ export interface DataBoxHeavySecret {
321
+ readonly accountCredentialDetails?: AccountCredentialDetails[];
322
+ readonly devicePassword?: string;
323
+ readonly deviceSerialNumber?: string;
324
+ readonly encodedValidationCertPubKey?: string;
325
+ readonly networkConfigurations?: ApplianceNetworkConfiguration[];
326
+ }
327
+
328
+ // @public
329
+ export interface DataBoxJobDetails extends JobDetails {
330
+ readonly copyProgress?: CopyProgress[];
331
+ devicePassword?: string;
332
+ jobDetailsType: "DataBox";
333
+ }
334
+
335
+ // @public
336
+ export interface DataboxJobSecrets extends JobSecrets {
337
+ jobSecretsType: "DataBox";
338
+ podSecrets?: DataBoxSecret[];
339
+ }
340
+
341
+ // @public (undocumented)
342
+ export class DataBoxManagementClient extends coreClient.ServiceClient {
343
+ // (undocumented)
344
+ $host: string;
345
+ constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: DataBoxManagementClientOptionalParams);
346
+ // (undocumented)
347
+ apiVersion: string;
348
+ // (undocumented)
349
+ jobs: Jobs;
350
+ mitigate(jobName: string, resourceGroupName: string, mitigateJobRequest: MitigateJobRequest, options?: MitigateOptionalParams): Promise<void>;
351
+ // (undocumented)
352
+ operations: Operations;
353
+ // (undocumented)
354
+ service: Service;
355
+ // (undocumented)
356
+ subscriptionId: string;
357
+ }
358
+
359
+ // @public
360
+ export interface DataBoxManagementClientOptionalParams extends coreClient.ServiceClientOptions {
361
+ $host?: string;
362
+ apiVersion?: string;
363
+ endpoint?: string;
364
+ }
365
+
366
+ // @public
367
+ export interface DataBoxScheduleAvailabilityRequest extends ScheduleAvailabilityRequest {
368
+ skuName: "DataBox";
369
+ }
370
+
371
+ // @public
372
+ export interface DataBoxSecret {
373
+ readonly accountCredentialDetails?: AccountCredentialDetails[];
374
+ readonly devicePassword?: string;
375
+ readonly deviceSerialNumber?: string;
376
+ readonly encodedValidationCertPubKey?: string;
377
+ readonly networkConfigurations?: ApplianceNetworkConfiguration[];
378
+ }
379
+
380
+ // @public
381
+ export interface DatacenterAddressInstructionResponse extends DatacenterAddressResponse {
382
+ readonly communicationInstruction?: string;
383
+ datacenterAddressType: "DatacenterAddressInstruction";
384
+ }
385
+
386
+ // @public
387
+ export interface DatacenterAddressLocationResponse extends DatacenterAddressResponse {
388
+ readonly additionalShippingInformation?: string;
389
+ readonly addressType?: string;
390
+ readonly city?: string;
391
+ readonly company?: string;
392
+ readonly contactPersonName?: string;
393
+ readonly country?: string;
394
+ datacenterAddressType: "DatacenterAddressLocation";
395
+ readonly phone?: string;
396
+ readonly phoneExtension?: string;
397
+ readonly state?: string;
398
+ readonly street1?: string;
399
+ readonly street2?: string;
400
+ readonly street3?: string;
401
+ readonly zip?: string;
402
+ }
403
+
404
+ // @public
405
+ export interface DatacenterAddressRequest {
406
+ model?: ModelName;
407
+ skuName: SkuName;
408
+ storageLocation: string;
409
+ }
410
+
411
+ // @public
412
+ export interface DatacenterAddressResponse {
413
+ datacenterAddressType: "DatacenterAddressInstruction" | "DatacenterAddressLocation";
414
+ readonly dataCenterAzureLocation?: string;
415
+ readonly supportedCarriersForReturnShipment?: string[];
416
+ }
417
+
418
+ // @public (undocumented)
419
+ export type DatacenterAddressResponseUnion = DatacenterAddressResponse | DatacenterAddressInstructionResponse | DatacenterAddressLocationResponse;
420
+
421
+ // @public
422
+ export type DatacenterAddressType = "DatacenterAddressLocation" | "DatacenterAddressInstruction";
423
+
424
+ // @public
425
+ export type DataCenterCode = string;
426
+
427
+ // @public
428
+ export interface DataExportDetails {
429
+ accountDetails: DataAccountDetailsUnion;
430
+ logCollectionLevel?: LogCollectionLevel;
431
+ transferConfiguration: TransferConfiguration;
432
+ }
433
+
434
+ // @public
435
+ export interface DataImportDetails {
436
+ accountDetails: DataAccountDetailsUnion;
437
+ logCollectionLevel?: LogCollectionLevel;
438
+ }
439
+
440
+ // @public
441
+ export interface DataLocationToServiceLocationMap {
442
+ readonly dataLocation?: string;
443
+ readonly serviceLocation?: string;
444
+ }
445
+
446
+ // @public
447
+ export interface DataTransferDetailsValidationRequest extends ValidationInputRequest {
448
+ dataExportDetails?: DataExportDetails[];
449
+ dataImportDetails?: DataImportDetails[];
450
+ deviceType: SkuName;
451
+ model?: ModelName;
452
+ transferType: TransferType;
453
+ validationType: "ValidateDataTransferDetails";
454
+ }
455
+
456
+ // @public
457
+ export interface DataTransferDetailsValidationResponseProperties extends ValidationInputResponse {
458
+ readonly status?: ValidationStatus;
459
+ validationType: "ValidateDataTransferDetails";
460
+ }
461
+
462
+ // @public
463
+ export interface DcAccessSecurityCode {
464
+ forwardDCAccessCode?: string;
465
+ reverseDCAccessCode?: string;
466
+ }
467
+
468
+ // @public
469
+ export type DelayNotificationStatus = string;
470
+
471
+ // @public (undocumented)
472
+ export interface Details {
473
+ // (undocumented)
474
+ code: string;
475
+ // (undocumented)
476
+ message: string;
477
+ }
478
+
479
+ // @public
480
+ export interface DeviceCapabilityDetails {
481
+ readonly hardwareEncryption?: HardwareEncryption;
482
+ }
483
+
484
+ // @public
485
+ export interface DeviceCapabilityRequest {
486
+ model?: ModelName;
487
+ skuName?: SkuName;
488
+ }
489
+
490
+ // @public
491
+ export interface DeviceCapabilityResponse {
492
+ readonly deviceCapabilityDetails?: DeviceCapabilityDetails[];
493
+ }
494
+
495
+ // @public
496
+ export interface DeviceErasureDetails {
497
+ readonly deviceErasureStatus?: StageStatus;
498
+ readonly erasureOrDestructionCertificateSasKey?: string;
499
+ }
500
+
501
+ // @public
502
+ export interface DiskScheduleAvailabilityRequest extends ScheduleAvailabilityRequest {
503
+ expectedDataSizeInTeraBytes: number;
504
+ skuName: "DataBoxDisk";
505
+ }
506
+
507
+ // @public
508
+ export interface DiskSecret {
509
+ readonly bitLockerKey?: string;
510
+ readonly diskSerialNumber?: string;
511
+ }
512
+
513
+ // @public
514
+ export type DoubleEncryption = "Enabled" | "Disabled";
515
+
516
+ // @public
517
+ export interface EncryptionPreferences {
518
+ doubleEncryption?: DoubleEncryption;
519
+ hardwareEncryption?: HardwareEncryption;
520
+ }
521
+
522
+ // @public (undocumented)
523
+ export interface ErrorDetail {
524
+ // (undocumented)
525
+ code: string;
526
+ // (undocumented)
527
+ details?: Details[];
528
+ // (undocumented)
529
+ message: string;
530
+ // (undocumented)
531
+ target?: string;
532
+ }
533
+
534
+ // @public
535
+ export interface ExportDiskDetails {
536
+ readonly backupManifestCloudPath?: string;
537
+ readonly manifestFile?: string;
538
+ readonly manifestHash?: string;
539
+ }
540
+
541
+ // @public
542
+ export interface FilterFileDetails {
543
+ filterFilePath: string;
544
+ filterFileType: FilterFileType;
545
+ }
546
+
547
+ // @public
548
+ export type FilterFileType = "AzureBlob" | "AzureFile";
549
+
550
+ // @public
551
+ export function getContinuationToken(page: unknown): string | undefined;
552
+
553
+ // @public
554
+ export interface GranularCopyLogDetails {
555
+ copyLogDetailsType: "DataBoxCustomerDisk";
556
+ }
557
+
558
+ // @public (undocumented)
559
+ export type GranularCopyLogDetailsUnion = GranularCopyLogDetails | DataBoxDiskGranularCopyLogDetails;
560
+
561
+ // @public
562
+ export interface GranularCopyProgress {
563
+ readonly accountId?: string;
564
+ readonly actions?: CustomerResolutionCode[];
565
+ readonly bytesProcessed?: number;
566
+ readonly dataAccountType?: DataAccountType;
567
+ readonly directoriesErroredOut?: number;
568
+ readonly error?: CloudError;
569
+ readonly filesErroredOut?: number;
570
+ readonly filesProcessed?: number;
571
+ readonly invalidDirectoriesProcessed?: number;
572
+ readonly invalidFileBytesUploaded?: number;
573
+ readonly invalidFilesProcessed?: number;
574
+ readonly isEnumerationInProgress?: boolean;
575
+ readonly renamedContainerCount?: number;
576
+ readonly storageAccountName?: string;
577
+ readonly totalBytesToProcess?: number;
578
+ readonly totalFilesToProcess?: number;
579
+ readonly transferType?: TransferType;
580
+ }
581
+
582
+ // @public
583
+ export type HardwareEncryption = "Enabled" | "Disabled";
584
+
585
+ // @public
586
+ export interface HeavyScheduleAvailabilityRequest extends ScheduleAvailabilityRequest {
587
+ skuName: "DataBoxHeavy";
588
+ }
589
+
590
+ // @public
591
+ export interface IdentityProperties {
592
+ type?: string;
593
+ userAssigned?: UserAssignedProperties;
594
+ }
595
+
596
+ // @public
597
+ export interface ImportDiskDetails {
598
+ readonly backupManifestCloudPath?: string;
599
+ bitLockerKey: string;
600
+ manifestFile: string;
601
+ manifestHash: string;
602
+ }
603
+
604
+ // @public
605
+ export interface JobDelayDetails {
606
+ readonly description?: string;
607
+ readonly errorCode?: PortalDelayErrorCode;
608
+ readonly resolutionTime?: Date;
609
+ readonly startTime?: Date;
610
+ readonly status?: DelayNotificationStatus;
611
+ }
612
+
613
+ // @public
614
+ export interface JobDeliveryInfo {
615
+ scheduledDateTime?: Date;
616
+ }
617
+
618
+ // @public
619
+ export type JobDeliveryType = "NonScheduled" | "Scheduled";
620
+
621
+ // @public
622
+ export interface JobDetails {
623
+ readonly actions?: CustomerResolutionCode[];
624
+ readonly chainOfCustodySasKey?: string;
625
+ contactDetails: ContactDetails;
626
+ readonly copyLogDetails?: CopyLogDetailsUnion[];
627
+ readonly datacenterAddress?: DatacenterAddressResponseUnion;
628
+ readonly dataCenterCode?: DataCenterCode;
629
+ dataExportDetails?: DataExportDetails[];
630
+ dataImportDetails?: DataImportDetails[];
631
+ readonly deliveryPackage?: PackageShippingDetails;
632
+ readonly deviceErasureDetails?: DeviceErasureDetails;
633
+ expectedDataSizeInTeraBytes?: number;
634
+ jobDetailsType: "DataBoxCustomerDisk" | "DataBoxDisk" | "DataBoxHeavy" | "DataBox";
635
+ readonly jobStages?: JobStages[];
636
+ keyEncryptionKey?: KeyEncryptionKey;
637
+ readonly lastMitigationActionOnJob?: LastMitigationActionOnJob;
638
+ preferences?: Preferences;
639
+ readonly returnPackage?: PackageShippingDetails;
640
+ readonly reverseShipmentLabelSasKey?: string;
641
+ reverseShippingDetails?: ReverseShippingDetails;
642
+ shippingAddress?: ShippingAddress;
643
+ }
644
+
645
+ // @public (undocumented)
646
+ export type JobDetailsUnion = JobDetails | DataBoxCustomerDiskJobDetails | DataBoxDiskJobDetails | DataBoxHeavyJobDetails | DataBoxJobDetails;
647
+
648
+ // @public
649
+ export interface JobResource extends Resource {
650
+ readonly allDevicesLost?: boolean;
651
+ readonly cancellationReason?: string;
652
+ readonly delayedStage?: StageName;
653
+ deliveryInfo?: JobDeliveryInfo;
654
+ deliveryType?: JobDeliveryType;
655
+ details?: JobDetailsUnion;
656
+ readonly error?: CloudError;
657
+ readonly id?: string;
658
+ readonly isCancellable?: boolean;
659
+ readonly isCancellableWithoutFee?: boolean;
660
+ readonly isDeletable?: boolean;
661
+ readonly isPrepareToShipEnabled?: boolean;
662
+ readonly isShippingAddressEditable?: boolean;
663
+ readonly name?: string;
664
+ readonly reverseShippingDetailsUpdate?: ReverseShippingDetailsEditStatus;
665
+ readonly reverseTransportPreferenceUpdate?: ReverseTransportPreferenceEditStatus;
666
+ readonly startTime?: Date;
667
+ readonly status?: StageName;
668
+ readonly systemData?: SystemData;
669
+ transferType: TransferType;
670
+ readonly type?: string;
671
+ }
672
+
673
+ // @public
674
+ export interface JobResourceList {
675
+ nextLink?: string;
676
+ value?: JobResource[];
677
+ }
678
+
679
+ // @public
680
+ export interface JobResourceUpdateParameter {
681
+ details?: UpdateJobDetails;
682
+ identity?: ResourceIdentity;
683
+ tags?: {
684
+ [propertyName: string]: string;
685
+ };
686
+ }
687
+
688
+ // @public
689
+ export interface Jobs {
690
+ beginCreate(resourceGroupName: string, jobName: string, jobResource: JobResource, options?: JobsCreateOptionalParams): Promise<SimplePollerLike<OperationState<JobsCreateResponse>, JobsCreateResponse>>;
691
+ beginCreateAndWait(resourceGroupName: string, jobName: string, jobResource: JobResource, options?: JobsCreateOptionalParams): Promise<JobsCreateResponse>;
692
+ beginDelete(resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
693
+ beginDeleteAndWait(resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams): Promise<void>;
694
+ beginUpdate(resourceGroupName: string, jobName: string, jobResourceUpdateParameter: JobResourceUpdateParameter, options?: JobsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<JobsUpdateResponse>, JobsUpdateResponse>>;
695
+ beginUpdateAndWait(resourceGroupName: string, jobName: string, jobResourceUpdateParameter: JobResourceUpdateParameter, options?: JobsUpdateOptionalParams): Promise<JobsUpdateResponse>;
696
+ bookShipmentPickUp(resourceGroupName: string, jobName: string, shipmentPickUpRequest: ShipmentPickUpRequest, options?: JobsBookShipmentPickUpOptionalParams): Promise<JobsBookShipmentPickUpResponse>;
697
+ cancel(resourceGroupName: string, jobName: string, cancellationReason: CancellationReason, options?: JobsCancelOptionalParams): Promise<void>;
698
+ get(resourceGroupName: string, jobName: string, options?: JobsGetOptionalParams): Promise<JobsGetResponse>;
699
+ list(options?: JobsListOptionalParams): PagedAsyncIterableIterator<JobResource>;
700
+ listByResourceGroup(resourceGroupName: string, options?: JobsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<JobResource>;
701
+ listCredentials(resourceGroupName: string, jobName: string, options?: JobsListCredentialsOptionalParams): PagedAsyncIterableIterator<UnencryptedCredentials>;
702
+ markDevicesShipped(jobName: string, resourceGroupName: string, markDevicesShippedRequest: MarkDevicesShippedRequest, options?: JobsMarkDevicesShippedOptionalParams): Promise<void>;
703
+ }
704
+
705
+ // @public
706
+ export interface JobsBookShipmentPickUpOptionalParams extends coreClient.OperationOptions {
707
+ }
708
+
709
+ // @public
710
+ export type JobsBookShipmentPickUpResponse = ShipmentPickUpResponse;
711
+
712
+ // @public
713
+ export interface JobsCancelOptionalParams extends coreClient.OperationOptions {
714
+ }
715
+
716
+ // @public
717
+ export interface JobsCreateOptionalParams extends coreClient.OperationOptions {
718
+ resumeFrom?: string;
719
+ updateIntervalInMs?: number;
720
+ }
721
+
722
+ // @public
723
+ export type JobsCreateResponse = JobResource;
724
+
725
+ // @public
726
+ export interface JobsDeleteHeaders {
727
+ location?: string;
728
+ }
729
+
730
+ // @public
731
+ export interface JobsDeleteOptionalParams extends coreClient.OperationOptions {
732
+ resumeFrom?: string;
733
+ updateIntervalInMs?: number;
734
+ }
735
+
736
+ // @public
737
+ export interface JobSecrets {
738
+ readonly dcAccessSecurityCode?: DcAccessSecurityCode;
739
+ readonly error?: CloudError;
740
+ jobSecretsType: "DataBoxCustomerDisk" | "DataBoxDisk" | "DataBoxHeavy" | "DataBox";
741
+ }
742
+
743
+ // @public (undocumented)
744
+ export type JobSecretsUnion = JobSecrets | CustomerDiskJobSecrets | DataBoxDiskJobSecrets | DataBoxHeavyJobSecrets | DataboxJobSecrets;
745
+
746
+ // @public
747
+ export interface JobsGetOptionalParams extends coreClient.OperationOptions {
748
+ expand?: string;
749
+ }
750
+
751
+ // @public
752
+ export type JobsGetResponse = JobResource;
753
+
754
+ // @public
755
+ export interface JobsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
756
+ }
757
+
758
+ // @public
759
+ export type JobsListByResourceGroupNextResponse = JobResourceList;
760
+
761
+ // @public
762
+ export interface JobsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
763
+ skipToken?: string;
764
+ }
765
+
766
+ // @public
767
+ export type JobsListByResourceGroupResponse = JobResourceList;
768
+
769
+ // @public
770
+ export interface JobsListCredentialsOptionalParams extends coreClient.OperationOptions {
771
+ }
772
+
773
+ // @public
774
+ export type JobsListCredentialsResponse = UnencryptedCredentialsList;
775
+
776
+ // @public
777
+ export interface JobsListNextOptionalParams extends coreClient.OperationOptions {
778
+ }
779
+
780
+ // @public
781
+ export type JobsListNextResponse = JobResourceList;
782
+
783
+ // @public
784
+ export interface JobsListOptionalParams extends coreClient.OperationOptions {
785
+ skipToken?: string;
786
+ }
787
+
788
+ // @public
789
+ export type JobsListResponse = JobResourceList;
790
+
791
+ // @public
792
+ export interface JobsMarkDevicesShippedOptionalParams extends coreClient.OperationOptions {
793
+ }
794
+
795
+ // @public
796
+ export interface JobStages {
797
+ readonly delayInformation?: JobDelayDetails[];
798
+ readonly displayName?: string;
799
+ readonly jobStageDetails?: Record<string, unknown>;
800
+ readonly stageName?: StageName;
801
+ readonly stageStatus?: StageStatus;
802
+ readonly stageTime?: Date;
803
+ }
804
+
805
+ // @public
806
+ export interface JobsUpdateHeaders {
807
+ location?: string;
808
+ }
809
+
810
+ // @public
811
+ export interface JobsUpdateOptionalParams extends coreClient.OperationOptions {
812
+ ifMatch?: string;
813
+ resumeFrom?: string;
814
+ updateIntervalInMs?: number;
815
+ }
816
+
817
+ // @public
818
+ export type JobsUpdateResponse = JobResource;
819
+
820
+ // @public
821
+ export type KekType = "MicrosoftManaged" | "CustomerManaged";
822
+
823
+ // @public
824
+ export interface KeyEncryptionKey {
825
+ identityProperties?: IdentityProperties;
826
+ kekType: KekType;
827
+ kekUrl?: string;
828
+ kekVaultResourceID?: string;
829
+ }
830
+
831
+ // @public
832
+ export enum KnownCopyStatus {
833
+ Completed = "Completed",
834
+ CompletedWithErrors = "CompletedWithErrors",
835
+ DeviceFormatted = "DeviceFormatted",
836
+ DeviceMetadataModified = "DeviceMetadataModified",
837
+ DriveCorrupted = "DriveCorrupted",
838
+ DriveNotDetected = "DriveNotDetected",
839
+ DriveNotReceived = "DriveNotReceived",
840
+ Failed = "Failed",
841
+ HardwareError = "HardwareError",
842
+ InProgress = "InProgress",
843
+ MetadataFilesModifiedOrRemoved = "MetadataFilesModifiedOrRemoved",
844
+ NotReturned = "NotReturned",
845
+ NotStarted = "NotStarted",
846
+ OtherServiceError = "OtherServiceError",
847
+ OtherUserError = "OtherUserError",
848
+ StorageAccountNotAccessible = "StorageAccountNotAccessible",
849
+ UnsupportedData = "UnsupportedData",
850
+ UnsupportedDrive = "UnsupportedDrive"
851
+ }
852
+
853
+ // @public
854
+ export enum KnownDataCenterCode {
855
+ AdHoc = "AdHoc",
856
+ AM2 = "AM2",
857
+ AMS06 = "AMS06",
858
+ AMS20 = "AMS20",
859
+ AMS25 = "AMS25",
860
+ AUH20 = "AUH20",
861
+ BJB = "BJB",
862
+ BJS20 = "BJS20",
863
+ BL20 = "BL20",
864
+ BL24 = "BL24",
865
+ BL7 = "BL7",
866
+ BN1 = "BN1",
867
+ BN7 = "BN7",
868
+ BOM01 = "BOM01",
869
+ BY1 = "BY1",
870
+ BY2 = "BY2",
871
+ BY21 = "BY21",
872
+ BY24 = "BY24",
873
+ CBR20 = "CBR20",
874
+ CH1 = "CH1",
875
+ CPQ02 = "CPQ02",
876
+ CPQ20 = "CPQ20",
877
+ CPQ21 = "CPQ21",
878
+ CWL20 = "CWL20",
879
+ CYS04 = "CYS04",
880
+ DSM05 = "DSM05",
881
+ DSM11 = "DSM11",
882
+ DUB07 = "DUB07",
883
+ DXB23 = "DXB23",
884
+ FRA22 = "FRA22",
885
+ HKG20 = "HKG20",
886
+ IDC5 = "IDC5",
887
+ Invalid = "Invalid",
888
+ JNB21 = "JNB21",
889
+ JNB22 = "JNB22",
890
+ LON24 = "LON24",
891
+ MAA01 = "MAA01",
892
+ MEL23 = "MEL23",
893
+ MNZ21 = "MNZ21",
894
+ MWH01 = "MWH01",
895
+ NTG20 = "NTG20",
896
+ ORK70 = "ORK70",
897
+ OSA02 = "OSA02",
898
+ OSA20 = "OSA20",
899
+ OSA22 = "OSA22",
900
+ OSA23 = "OSA23",
901
+ PAR22 = "PAR22",
902
+ PNQ01 = "PNQ01",
903
+ PUS20 = "PUS20",
904
+ SEL20 = "SEL20",
905
+ SEL21 = "SEL21",
906
+ SG2 = "SG2",
907
+ SHA03 = "SHA03",
908
+ SIN20 = "SIN20",
909
+ SN5 = "SN5",
910
+ SN6 = "SN6",
911
+ SN8 = "SN8",
912
+ SSE90 = "SSE90",
913
+ SVG20 = "SVG20",
914
+ SYD03 = "SYD03",
915
+ SYD23 = "SYD23",
916
+ TYO01 = "TYO01",
917
+ TYO22 = "TYO22",
918
+ TYO23 = "TYO23",
919
+ YQB20 = "YQB20",
920
+ YTO20 = "YTO20",
921
+ YTO21 = "YTO21",
922
+ ZRH20 = "ZRH20"
923
+ }
924
+
925
+ // @public
926
+ export enum KnownDelayNotificationStatus {
927
+ Active = "Active",
928
+ Resolved = "Resolved"
929
+ }
930
+
931
+ // @public
932
+ export enum KnownNotificationStageName {
933
+ AtAzureDC = "AtAzureDC",
934
+ Created = "Created",
935
+ DataCopy = "DataCopy",
936
+ Delivered = "Delivered",
937
+ DevicePrepared = "DevicePrepared",
938
+ Dispatched = "Dispatched",
939
+ PickedUp = "PickedUp",
940
+ ShippedToCustomer = "ShippedToCustomer"
941
+ }
942
+
943
+ // @public
944
+ export enum KnownPortalDelayErrorCode {
945
+ ActiveOrderLimitBreachedDelay = "ActiveOrderLimitBreachedDelay",
946
+ HighDemandDelay = "HighDemandDelay",
947
+ InternalIssueDelay = "InternalIssueDelay",
948
+ LargeNumberOfFilesDelay = "LargeNumberOfFilesDelay"
949
+ }
950
+
951
+ // @public
952
+ export enum KnownStageName {
953
+ Aborted = "Aborted",
954
+ AtAzureDC = "AtAzureDC",
955
+ AwaitingShipmentDetails = "AwaitingShipmentDetails",
956
+ Cancelled = "Cancelled",
957
+ Completed = "Completed",
958
+ CompletedWithErrors = "CompletedWithErrors",
959
+ CompletedWithWarnings = "CompletedWithWarnings",
960
+ Created = "Created",
961
+ DataCopy = "DataCopy",
962
+ Delivered = "Delivered",
963
+ DeviceOrdered = "DeviceOrdered",
964
+ DevicePrepared = "DevicePrepared",
965
+ Dispatched = "Dispatched",
966
+ FailedIssueDetectedAtAzureDC = "Failed_IssueDetectedAtAzureDC",
967
+ FailedIssueReportedAtCustomer = "Failed_IssueReportedAtCustomer",
968
+ PickedUp = "PickedUp",
969
+ PreparingToShipFromAzureDC = "PreparingToShipFromAzureDC",
970
+ ReadyToDispatchFromAzureDC = "ReadyToDispatchFromAzureDC",
971
+ ReadyToReceiveAtAzureDC = "ReadyToReceiveAtAzureDC",
972
+ ShippedToAzureDC = "ShippedToAzureDC",
973
+ ShippedToCustomer = "ShippedToCustomer"
974
+ }
975
+
976
+ // @public
977
+ export interface LastMitigationActionOnJob {
978
+ actionDateTimeInUtc?: Date;
979
+ customerResolution?: CustomerResolutionCode;
980
+ isPerformedByCustomer?: boolean;
981
+ }
982
+
983
+ // @public
984
+ export type LogCollectionLevel = "Error" | "Verbose";
985
+
986
+ // @public
987
+ export interface ManagedDiskDetails extends DataAccountDetails {
988
+ dataAccountType: "ManagedDisk";
989
+ resourceGroupId: string;
990
+ stagingStorageAccountId: string;
991
+ }
992
+
993
+ // @public
994
+ export interface MarkDevicesShippedRequest {
995
+ deliverToDcPackageDetails: PackageCarrierInfo;
996
+ }
997
+
998
+ // @public
999
+ export interface MitigateJobRequest {
1000
+ customerResolutionCode?: CustomerResolutionCode;
1001
+ serialNumberCustomerResolutionMap?: {
1002
+ [propertyName: string]: CustomerResolutionCode;
1003
+ };
1004
+ }
1005
+
1006
+ // @public
1007
+ export interface MitigateOptionalParams extends coreClient.OperationOptions {
1008
+ }
1009
+
1010
+ // @public
1011
+ export type ModelName = "DataBox" | "DataBoxDisk" | "DataBoxHeavy" | "DataBoxCustomerDisk" | "AzureDataBox120" | "AzureDataBox525";
1012
+
1013
+ // @public
1014
+ export interface NotificationPreference {
1015
+ sendNotification: boolean;
1016
+ stageName: NotificationStageName;
1017
+ }
1018
+
1019
+ // @public
1020
+ export type NotificationStageName = string;
1021
+
1022
+ // @public
1023
+ export interface Operation {
1024
+ readonly display?: OperationDisplay;
1025
+ isDataAction?: boolean;
1026
+ readonly name?: string;
1027
+ readonly origin?: string;
1028
+ readonly properties?: Record<string, unknown>;
1029
+ }
1030
+
1031
+ // @public
1032
+ export interface OperationDisplay {
1033
+ description?: string;
1034
+ operation?: string;
1035
+ provider?: string;
1036
+ resource?: string;
1037
+ }
1038
+
1039
+ // @public
1040
+ export interface OperationList {
1041
+ nextLink?: string;
1042
+ readonly value?: Operation[];
1043
+ }
1044
+
1045
+ // @public
1046
+ export interface Operations {
1047
+ list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
1048
+ }
1049
+
1050
+ // @public
1051
+ export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
1052
+ }
1053
+
1054
+ // @public
1055
+ export type OperationsListNextResponse = OperationList;
1056
+
1057
+ // @public
1058
+ export interface OperationsListOptionalParams extends coreClient.OperationOptions {
1059
+ }
1060
+
1061
+ // @public
1062
+ export type OperationsListResponse = OperationList;
1063
+
1064
+ // @public
1065
+ export type OverallValidationStatus = "AllValidToProceed" | "InputsRevisitRequired" | "CertainInputValidationsSkipped";
1066
+
1067
+ // @public
1068
+ export interface PackageCarrierDetails {
1069
+ carrierAccountNumber?: string;
1070
+ carrierName?: string;
1071
+ trackingId?: string;
1072
+ }
1073
+
1074
+ // @public
1075
+ export interface PackageCarrierInfo {
1076
+ carrierName?: string;
1077
+ trackingId?: string;
1078
+ }
1079
+
1080
+ // @public
1081
+ export interface PackageShippingDetails {
1082
+ readonly carrierName?: string;
1083
+ readonly trackingId?: string;
1084
+ readonly trackingUrl?: string;
1085
+ }
1086
+
1087
+ // @public
1088
+ export type PortalDelayErrorCode = string;
1089
+
1090
+ // @public
1091
+ export interface Preferences {
1092
+ encryptionPreferences?: EncryptionPreferences;
1093
+ preferredDataCenterRegion?: string[];
1094
+ reverseTransportPreferences?: TransportPreferences;
1095
+ storageAccountAccessTierPreferences?: string[];
1096
+ transportPreferences?: TransportPreferences;
1097
+ }
1098
+
1099
+ // @public
1100
+ export interface PreferencesValidationRequest extends ValidationInputRequest {
1101
+ deviceType: SkuName;
1102
+ model?: ModelName;
1103
+ preference?: Preferences;
1104
+ validationType: "ValidatePreferences";
1105
+ }
1106
+
1107
+ // @public
1108
+ export interface PreferencesValidationResponseProperties extends ValidationInputResponse {
1109
+ readonly status?: ValidationStatus;
1110
+ validationType: "ValidatePreferences";
1111
+ }
1112
+
1113
+ // @public
1114
+ export interface RegionConfigurationRequest {
1115
+ datacenterAddressRequest?: DatacenterAddressRequest;
1116
+ deviceCapabilityRequest?: DeviceCapabilityRequest;
1117
+ scheduleAvailabilityRequest?: ScheduleAvailabilityRequestUnion;
1118
+ transportAvailabilityRequest?: TransportAvailabilityRequest;
1119
+ }
1120
+
1121
+ // @public
1122
+ export interface RegionConfigurationResponse {
1123
+ readonly datacenterAddressResponse?: DatacenterAddressResponseUnion;
1124
+ readonly deviceCapabilityResponse?: DeviceCapabilityResponse;
1125
+ readonly scheduleAvailabilityResponse?: ScheduleAvailabilityResponse;
1126
+ readonly transportAvailabilityResponse?: TransportAvailabilityResponse;
1127
+ }
1128
+
1129
+ // @public
1130
+ export interface Resource {
1131
+ identity?: ResourceIdentity;
1132
+ location: string;
1133
+ sku: Sku;
1134
+ tags?: {
1135
+ [propertyName: string]: string;
1136
+ };
1137
+ }
1138
+
1139
+ // @public
1140
+ export interface ResourceIdentity {
1141
+ readonly principalId?: string;
1142
+ readonly tenantId?: string;
1143
+ type?: string;
1144
+ userAssignedIdentities?: {
1145
+ [propertyName: string]: UserAssignedIdentity;
1146
+ };
1147
+ }
1148
+
1149
+ // @public
1150
+ export interface ReverseShippingDetails {
1151
+ contactDetails?: ContactInfo;
1152
+ readonly isUpdated?: boolean;
1153
+ shippingAddress?: ShippingAddress;
1154
+ }
1155
+
1156
+ // @public
1157
+ export type ReverseShippingDetailsEditStatus = "Enabled" | "Disabled" | "NotSupported";
1158
+
1159
+ // @public
1160
+ export type ReverseTransportPreferenceEditStatus = "Enabled" | "Disabled" | "NotSupported";
1161
+
1162
+ // @public
1163
+ export interface ScheduleAvailabilityRequest {
1164
+ country?: string;
1165
+ model?: ModelName;
1166
+ skuName: "DataBox" | "DataBoxDisk" | "DataBoxHeavy";
1167
+ storageLocation: string;
1168
+ }
1169
+
1170
+ // @public (undocumented)
1171
+ export type ScheduleAvailabilityRequestUnion = ScheduleAvailabilityRequest | DataBoxScheduleAvailabilityRequest | DiskScheduleAvailabilityRequest | HeavyScheduleAvailabilityRequest;
1172
+
1173
+ // @public
1174
+ export interface ScheduleAvailabilityResponse {
1175
+ readonly availableDates?: Date[];
1176
+ }
1177
+
1178
+ // @public
1179
+ export interface Service {
1180
+ listAvailableSkusByResourceGroup(resourceGroupName: string, location: string, availableSkuRequest: AvailableSkuRequest, options?: ServiceListAvailableSkusByResourceGroupOptionalParams): PagedAsyncIterableIterator<SkuInformation>;
1181
+ regionConfiguration(location: string, regionConfigurationRequest: RegionConfigurationRequest, options?: ServiceRegionConfigurationOptionalParams): Promise<ServiceRegionConfigurationResponse>;
1182
+ regionConfigurationByResourceGroup(resourceGroupName: string, location: string, regionConfigurationRequest: RegionConfigurationRequest, options?: ServiceRegionConfigurationByResourceGroupOptionalParams): Promise<ServiceRegionConfigurationByResourceGroupResponse>;
1183
+ validateAddress(location: string, validateAddress: ValidateAddress, options?: ServiceValidateAddressOptionalParams): Promise<ServiceValidateAddressResponse>;
1184
+ validateInputs(location: string, validationRequest: ValidationRequestUnion, options?: ServiceValidateInputsOptionalParams): Promise<ServiceValidateInputsResponse>;
1185
+ validateInputsByResourceGroup(resourceGroupName: string, location: string, validationRequest: ValidationRequestUnion, options?: ServiceValidateInputsByResourceGroupOptionalParams): Promise<ServiceValidateInputsByResourceGroupResponse>;
1186
+ }
1187
+
1188
+ // @public
1189
+ export interface ServiceListAvailableSkusByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
1190
+ }
1191
+
1192
+ // @public
1193
+ export type ServiceListAvailableSkusByResourceGroupNextResponse = AvailableSkusResult;
1194
+
1195
+ // @public
1196
+ export interface ServiceListAvailableSkusByResourceGroupOptionalParams extends coreClient.OperationOptions {
1197
+ }
1198
+
1199
+ // @public
1200
+ export type ServiceListAvailableSkusByResourceGroupResponse = AvailableSkusResult;
1201
+
1202
+ // @public
1203
+ export interface ServiceRegionConfigurationByResourceGroupOptionalParams extends coreClient.OperationOptions {
1204
+ }
1205
+
1206
+ // @public
1207
+ export type ServiceRegionConfigurationByResourceGroupResponse = RegionConfigurationResponse;
1208
+
1209
+ // @public
1210
+ export interface ServiceRegionConfigurationOptionalParams extends coreClient.OperationOptions {
1211
+ }
1212
+
1213
+ // @public
1214
+ export type ServiceRegionConfigurationResponse = RegionConfigurationResponse;
1215
+
1216
+ // @public
1217
+ export interface ServiceValidateAddressOptionalParams extends coreClient.OperationOptions {
1218
+ }
1219
+
1220
+ // @public
1221
+ export type ServiceValidateAddressResponse = AddressValidationOutput;
1222
+
1223
+ // @public
1224
+ export interface ServiceValidateInputsByResourceGroupOptionalParams extends coreClient.OperationOptions {
1225
+ }
1226
+
1227
+ // @public
1228
+ export type ServiceValidateInputsByResourceGroupResponse = ValidationResponse;
1229
+
1230
+ // @public
1231
+ export interface ServiceValidateInputsOptionalParams extends coreClient.OperationOptions {
1232
+ }
1233
+
1234
+ // @public
1235
+ export type ServiceValidateInputsResponse = ValidationResponse;
1236
+
1237
+ // @public
1238
+ export interface ShareCredentialDetails {
1239
+ readonly password?: string;
1240
+ readonly shareName?: string;
1241
+ readonly shareType?: ShareDestinationFormatType;
1242
+ readonly supportedAccessProtocols?: AccessProtocol[];
1243
+ readonly userName?: string;
1244
+ }
1245
+
1246
+ // @public
1247
+ export type ShareDestinationFormatType = "UnknownType" | "HCS" | "BlockBlob" | "PageBlob" | "AzureFile" | "ManagedDisk";
1248
+
1249
+ // @public
1250
+ export interface ShipmentPickUpRequest {
1251
+ endTime: Date;
1252
+ shipmentLocation: string;
1253
+ startTime: Date;
1254
+ }
1255
+
1256
+ // @public
1257
+ export interface ShipmentPickUpResponse {
1258
+ readonly confirmationNumber?: string;
1259
+ readonly readyByTime?: Date;
1260
+ }
1261
+
1262
+ // @public
1263
+ export interface ShippingAddress {
1264
+ addressType?: AddressType;
1265
+ city?: string;
1266
+ companyName?: string;
1267
+ country: string;
1268
+ postalCode?: string;
1269
+ skipAddressValidation?: boolean;
1270
+ stateOrProvince?: string;
1271
+ streetAddress1: string;
1272
+ streetAddress2?: string;
1273
+ streetAddress3?: string;
1274
+ taxIdentificationNumber?: string;
1275
+ zipExtendedCode?: string;
1276
+ }
1277
+
1278
+ // @public
1279
+ export interface Sku {
1280
+ displayName?: string;
1281
+ family?: string;
1282
+ model?: ModelName;
1283
+ name: SkuName;
1284
+ }
1285
+
1286
+ // @public
1287
+ export interface SkuAvailabilityValidationRequest extends ValidationInputRequest {
1288
+ country: string;
1289
+ deviceType: SkuName;
1290
+ location: string;
1291
+ model?: ModelName;
1292
+ transferType: TransferType;
1293
+ validationType: "ValidateSkuAvailability";
1294
+ }
1295
+
1296
+ // @public
1297
+ export interface SkuAvailabilityValidationResponseProperties extends ValidationInputResponse {
1298
+ readonly status?: ValidationStatus;
1299
+ validationType: "ValidateSkuAvailability";
1300
+ }
1301
+
1302
+ // @public
1303
+ export interface SkuCapacity {
1304
+ readonly individualSkuUsable?: string;
1305
+ readonly maximum?: string;
1306
+ readonly usable?: string;
1307
+ }
1308
+
1309
+ // @public
1310
+ export interface SkuCost {
1311
+ readonly meterId?: string;
1312
+ readonly meterType?: string;
1313
+ readonly multiplier?: number;
1314
+ }
1315
+
1316
+ // @public
1317
+ export type SkuDisabledReason = "None" | "Country" | "Region" | "Feature" | "OfferType" | "NoSubscriptionInfo";
1318
+
1319
+ // @public
1320
+ export interface SkuInformation {
1321
+ readonly apiVersions?: string[];
1322
+ readonly capacity?: SkuCapacity;
1323
+ readonly costs?: SkuCost[];
1324
+ readonly countriesWithinCommerceBoundary?: string[];
1325
+ readonly dataLocationToServiceLocationMap?: DataLocationToServiceLocationMap[];
1326
+ readonly disabledReason?: SkuDisabledReason;
1327
+ readonly disabledReasonMessage?: string;
1328
+ readonly enabled?: boolean;
1329
+ readonly requiredFeature?: string;
1330
+ readonly sku?: Sku;
1331
+ }
1332
+
1333
+ // @public
1334
+ export type SkuName = "DataBox" | "DataBoxDisk" | "DataBoxHeavy" | "DataBoxCustomerDisk";
1335
+
1336
+ // @public
1337
+ export type StageName = string;
1338
+
1339
+ // @public
1340
+ export type StageStatus = "None" | "InProgress" | "Succeeded" | "Failed" | "Cancelled" | "Cancelling" | "SucceededWithErrors" | "WaitingForCustomerAction" | "SucceededWithWarnings" | "WaitingForCustomerActionForKek" | "WaitingForCustomerActionForCleanUp" | "CustomerActionPerformedForCleanUp" | "CustomerActionPerformed";
1341
+
1342
+ // @public
1343
+ export interface StorageAccountDetails extends DataAccountDetails {
1344
+ dataAccountType: "StorageAccount";
1345
+ storageAccountId: string;
1346
+ }
1347
+
1348
+ // @public
1349
+ export interface SubscriptionIsAllowedToCreateJobValidationRequest extends ValidationInputRequest {
1350
+ validationType: "ValidateSubscriptionIsAllowedToCreateJob";
1351
+ }
1352
+
1353
+ // @public
1354
+ export interface SubscriptionIsAllowedToCreateJobValidationResponseProperties extends ValidationInputResponse {
1355
+ readonly status?: ValidationStatus;
1356
+ validationType: "ValidateSubscriptionIsAllowedToCreateJob";
1357
+ }
1358
+
1359
+ // @public
1360
+ export interface SystemData {
1361
+ readonly createdAt?: Date;
1362
+ readonly createdBy?: string;
1363
+ readonly createdByType?: string;
1364
+ readonly lastModifiedAt?: Date;
1365
+ readonly lastModifiedBy?: string;
1366
+ readonly lastModifiedByType?: string;
1367
+ }
1368
+
1369
+ // @public
1370
+ export interface TransferAllDetails {
1371
+ dataAccountType: DataAccountType;
1372
+ transferAllBlobs?: boolean;
1373
+ transferAllFiles?: boolean;
1374
+ }
1375
+
1376
+ // @public
1377
+ export interface TransferConfiguration {
1378
+ transferAllDetails?: TransferConfigurationTransferAllDetails;
1379
+ transferConfigurationType: TransferConfigurationType;
1380
+ transferFilterDetails?: TransferConfigurationTransferFilterDetails;
1381
+ }
1382
+
1383
+ // @public
1384
+ export interface TransferConfigurationTransferAllDetails {
1385
+ include?: TransferAllDetails;
1386
+ }
1387
+
1388
+ // @public
1389
+ export interface TransferConfigurationTransferFilterDetails {
1390
+ include?: TransferFilterDetails;
1391
+ }
1392
+
1393
+ // @public
1394
+ export type TransferConfigurationType = "TransferAll" | "TransferUsingFilter";
1395
+
1396
+ // @public
1397
+ export interface TransferFilterDetails {
1398
+ azureFileFilterDetails?: AzureFileFilterDetails;
1399
+ blobFilterDetails?: BlobFilterDetails;
1400
+ dataAccountType: DataAccountType;
1401
+ filterFileDetails?: FilterFileDetails[];
1402
+ }
1403
+
1404
+ // @public
1405
+ export type TransferType = "ImportToAzure" | "ExportFromAzure";
1406
+
1407
+ // @public
1408
+ export interface TransportAvailabilityDetails {
1409
+ readonly shipmentType?: TransportShipmentTypes;
1410
+ }
1411
+
1412
+ // @public
1413
+ export interface TransportAvailabilityRequest {
1414
+ model?: ModelName;
1415
+ skuName?: SkuName;
1416
+ }
1417
+
1418
+ // @public
1419
+ export interface TransportAvailabilityResponse {
1420
+ readonly transportAvailabilityDetails?: TransportAvailabilityDetails[];
1421
+ }
1422
+
1423
+ // @public
1424
+ export interface TransportPreferences {
1425
+ readonly isUpdated?: boolean;
1426
+ preferredShipmentType: TransportShipmentTypes;
1427
+ }
1428
+
1429
+ // @public
1430
+ export type TransportShipmentTypes = "CustomerManaged" | "MicrosoftManaged";
1431
+
1432
+ // @public
1433
+ export interface UnencryptedCredentials {
1434
+ readonly jobName?: string;
1435
+ readonly jobSecrets?: JobSecretsUnion;
1436
+ }
1437
+
1438
+ // @public
1439
+ export interface UnencryptedCredentialsList {
1440
+ nextLink?: string;
1441
+ value?: UnencryptedCredentials[];
1442
+ }
1443
+
1444
+ // @public
1445
+ export interface UpdateJobDetails {
1446
+ contactDetails?: ContactDetails;
1447
+ keyEncryptionKey?: KeyEncryptionKey;
1448
+ preferences?: Preferences;
1449
+ returnToCustomerPackageDetails?: PackageCarrierDetails;
1450
+ reverseShippingDetails?: ReverseShippingDetails;
1451
+ shippingAddress?: ShippingAddress;
1452
+ }
1453
+
1454
+ // @public
1455
+ export interface UserAssignedIdentity {
1456
+ readonly clientId?: string;
1457
+ readonly principalId?: string;
1458
+ }
1459
+
1460
+ // @public
1461
+ export interface UserAssignedProperties {
1462
+ resourceId?: string;
1463
+ }
1464
+
1465
+ // @public
1466
+ export interface ValidateAddress extends ValidationInputRequest {
1467
+ deviceType: SkuName;
1468
+ model?: ModelName;
1469
+ shippingAddress: ShippingAddress;
1470
+ transportPreferences?: TransportPreferences;
1471
+ validationType: "ValidateAddress";
1472
+ }
1473
+
1474
+ // @public
1475
+ export type ValidationInputDiscriminator = "ValidateAddress" | "ValidateSubscriptionIsAllowedToCreateJob" | "ValidatePreferences" | "ValidateCreateOrderLimit" | "ValidateSkuAvailability" | "ValidateDataTransferDetails";
1476
+
1477
+ // @public
1478
+ export interface ValidationInputRequest {
1479
+ validationType: "ValidateAddress" | "ValidateCreateOrderLimit" | "ValidateDataTransferDetails" | "ValidatePreferences" | "ValidateSkuAvailability" | "ValidateSubscriptionIsAllowedToCreateJob";
1480
+ }
1481
+
1482
+ // @public (undocumented)
1483
+ export type ValidationInputRequestUnion = ValidationInputRequest | ValidateAddress | CreateOrderLimitForSubscriptionValidationRequest | DataTransferDetailsValidationRequest | PreferencesValidationRequest | SkuAvailabilityValidationRequest | SubscriptionIsAllowedToCreateJobValidationRequest;
1484
+
1485
+ // @public
1486
+ export interface ValidationInputResponse {
1487
+ readonly error?: CloudError;
1488
+ validationType: "ValidateAddress" | "ValidateCreateOrderLimit" | "ValidateDataTransferDetails" | "ValidatePreferences" | "ValidateSkuAvailability" | "ValidateSubscriptionIsAllowedToCreateJob";
1489
+ }
1490
+
1491
+ // @public (undocumented)
1492
+ export type ValidationInputResponseUnion = ValidationInputResponse | AddressValidationProperties | CreateOrderLimitForSubscriptionValidationResponseProperties | DataTransferDetailsValidationResponseProperties | PreferencesValidationResponseProperties | SkuAvailabilityValidationResponseProperties | SubscriptionIsAllowedToCreateJobValidationResponseProperties;
1493
+
1494
+ // @public
1495
+ export interface ValidationRequest {
1496
+ individualRequestDetails: ValidationInputRequestUnion[];
1497
+ validationCategory: "JobCreationValidation";
1498
+ }
1499
+
1500
+ // @public (undocumented)
1501
+ export type ValidationRequestUnion = ValidationRequest | CreateJobValidations;
1502
+
1503
+ // @public
1504
+ export interface ValidationResponse {
1505
+ readonly individualResponseDetails?: ValidationInputResponseUnion[];
1506
+ readonly status?: OverallValidationStatus;
1507
+ }
1508
+
1509
+ // @public
1510
+ export type ValidationStatus = "Valid" | "Invalid" | "Skipped";
1511
+
1512
+ // (No @packageDocumentation comment for this package)
1513
+
1514
+ ```