@azure/arm-storageimportexport 1.3.1 → 2.0.0

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 (154) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/LICENSE +21 -0
  3. package/README.md +69 -80
  4. package/dist/index.js +1999 -0
  5. package/dist/index.js.map +1 -0
  6. package/dist/index.min.js +1 -0
  7. package/dist/index.min.js.map +1 -0
  8. package/dist-esm/src/index.d.ts +5 -0
  9. package/dist-esm/src/index.d.ts.map +1 -0
  10. package/dist-esm/src/index.js +12 -0
  11. package/dist-esm/src/index.js.map +1 -0
  12. package/dist-esm/src/models/index.d.ts +504 -0
  13. package/dist-esm/src/models/index.d.ts.map +1 -0
  14. package/dist-esm/src/models/index.js +40 -0
  15. package/dist-esm/src/models/index.js.map +1 -0
  16. package/dist-esm/src/models/mappers.d.ts +25 -0
  17. package/dist-esm/src/models/mappers.d.ts.map +1 -0
  18. package/{esm → dist-esm/src}/models/mappers.js +570 -422
  19. package/dist-esm/src/models/mappers.js.map +1 -0
  20. package/dist-esm/src/models/parameters.d.ts +17 -0
  21. package/dist-esm/src/models/parameters.d.ts.map +1 -0
  22. package/{esm → dist-esm/src}/models/parameters.js +79 -49
  23. package/dist-esm/src/models/parameters.js.map +1 -0
  24. package/dist-esm/src/operations/bitLockerKeys.d.ts +32 -0
  25. package/dist-esm/src/operations/bitLockerKeys.d.ts.map +1 -0
  26. package/dist-esm/src/operations/bitLockerKeys.js +101 -0
  27. package/dist-esm/src/operations/bitLockerKeys.js.map +1 -0
  28. package/{esm → dist-esm/src}/operations/index.d.ts +0 -0
  29. package/dist-esm/src/operations/index.d.ts.map +1 -0
  30. package/{esm → dist-esm/src}/operations/index.js +3 -5
  31. package/dist-esm/src/operations/index.js.map +1 -0
  32. package/dist-esm/src/operations/jobs.d.ts +92 -0
  33. package/dist-esm/src/operations/jobs.d.ts.map +1 -0
  34. package/dist-esm/src/operations/jobs.js +376 -0
  35. package/dist-esm/src/operations/jobs.js.map +1 -0
  36. package/dist-esm/src/operations/locations.d.ts +35 -0
  37. package/dist-esm/src/operations/locations.d.ts.map +1 -0
  38. package/dist-esm/src/operations/locations.js +117 -0
  39. package/dist-esm/src/operations/locations.js.map +1 -0
  40. package/dist-esm/src/operations/operations.d.ts +26 -0
  41. package/dist-esm/src/operations/operations.d.ts.map +1 -0
  42. package/dist-esm/src/operations/operations.js +90 -0
  43. package/dist-esm/src/operations/operations.js.map +1 -0
  44. package/dist-esm/src/operationsInterfaces/bitLockerKeys.d.ts +14 -0
  45. package/dist-esm/src/operationsInterfaces/bitLockerKeys.d.ts.map +1 -0
  46. package/dist-esm/src/operationsInterfaces/bitLockerKeys.js +9 -0
  47. package/dist-esm/src/operationsInterfaces/bitLockerKeys.js.map +1 -0
  48. package/dist-esm/src/operationsInterfaces/index.d.ts +5 -0
  49. package/dist-esm/src/operationsInterfaces/index.d.ts.map +1 -0
  50. package/dist-esm/src/operationsInterfaces/index.js +12 -0
  51. package/dist-esm/src/operationsInterfaces/index.js.map +1 -0
  52. package/dist-esm/src/operationsInterfaces/jobs.d.ts +54 -0
  53. package/dist-esm/src/operationsInterfaces/jobs.d.ts.map +1 -0
  54. package/dist-esm/src/operationsInterfaces/jobs.js +9 -0
  55. package/dist-esm/src/operationsInterfaces/jobs.js.map +1 -0
  56. package/dist-esm/src/operationsInterfaces/locations.d.ts +19 -0
  57. package/dist-esm/src/operationsInterfaces/locations.d.ts.map +1 -0
  58. package/dist-esm/src/operationsInterfaces/locations.js +9 -0
  59. package/dist-esm/src/operationsInterfaces/locations.js.map +1 -0
  60. package/dist-esm/src/operationsInterfaces/operations.d.ts +11 -0
  61. package/dist-esm/src/operationsInterfaces/operations.d.ts.map +1 -0
  62. package/dist-esm/src/operationsInterfaces/operations.js +9 -0
  63. package/dist-esm/src/operationsInterfaces/operations.js.map +1 -0
  64. package/dist-esm/src/storageImportExport.d.ts +22 -0
  65. package/dist-esm/src/storageImportExport.d.ts.map +1 -0
  66. package/dist-esm/src/storageImportExport.js +54 -0
  67. package/dist-esm/src/storageImportExport.js.map +1 -0
  68. package/dist-esm/test/sampleTest.d.ts +2 -0
  69. package/dist-esm/test/sampleTest.d.ts.map +1 -0
  70. package/dist-esm/test/sampleTest.js +40 -0
  71. package/dist-esm/test/sampleTest.js.map +1 -0
  72. package/package.json +85 -26
  73. package/review/arm-storageimportexport.api.md +438 -0
  74. package/rollup.config.js +184 -27
  75. package/src/index.ts +12 -0
  76. package/src/models/index.ts +432 -839
  77. package/src/models/mappers.ts +575 -424
  78. package/src/models/parameters.ts +101 -50
  79. package/src/operations/bitLockerKeys.ts +90 -55
  80. package/src/operations/index.ts +3 -5
  81. package/src/operations/jobs.ts +302 -335
  82. package/src/operations/locations.ts +85 -78
  83. package/src/operations/operations.ts +66 -42
  84. package/src/operationsInterfaces/bitLockerKeys.ts +27 -0
  85. package/src/operationsInterfaces/index.ts +12 -0
  86. package/src/operationsInterfaces/jobs.ts +99 -0
  87. package/src/operationsInterfaces/locations.ts +38 -0
  88. package/src/operationsInterfaces/operations.ts +22 -0
  89. package/src/storageImportExport.ts +92 -0
  90. package/tsconfig.json +20 -7
  91. package/types/arm-storageimportexport.d.ts +671 -0
  92. package/types/tsdoc-metadata.json +11 -0
  93. package/dist/arm-storageimportexport.js +0 -1764
  94. package/dist/arm-storageimportexport.js.map +0 -1
  95. package/dist/arm-storageimportexport.min.js +0 -1
  96. package/dist/arm-storageimportexport.min.js.map +0 -1
  97. package/esm/models/bitLockerKeysMappers.d.ts +0 -2
  98. package/esm/models/bitLockerKeysMappers.d.ts.map +0 -1
  99. package/esm/models/bitLockerKeysMappers.js +0 -11
  100. package/esm/models/bitLockerKeysMappers.js.map +0 -1
  101. package/esm/models/index.d.ts +0 -928
  102. package/esm/models/index.d.ts.map +0 -1
  103. package/esm/models/index.js +0 -10
  104. package/esm/models/index.js.map +0 -1
  105. package/esm/models/jobsMappers.d.ts +0 -2
  106. package/esm/models/jobsMappers.d.ts.map +0 -1
  107. package/esm/models/jobsMappers.js +0 -11
  108. package/esm/models/jobsMappers.js.map +0 -1
  109. package/esm/models/locationsMappers.d.ts +0 -2
  110. package/esm/models/locationsMappers.d.ts.map +0 -1
  111. package/esm/models/locationsMappers.js +0 -11
  112. package/esm/models/locationsMappers.js.map +0 -1
  113. package/esm/models/mappers.d.ts +0 -23
  114. package/esm/models/mappers.d.ts.map +0 -1
  115. package/esm/models/mappers.js.map +0 -1
  116. package/esm/models/operationsMappers.d.ts +0 -2
  117. package/esm/models/operationsMappers.d.ts.map +0 -1
  118. package/esm/models/operationsMappers.js +0 -11
  119. package/esm/models/operationsMappers.js.map +0 -1
  120. package/esm/models/parameters.d.ts +0 -12
  121. package/esm/models/parameters.d.ts.map +0 -1
  122. package/esm/models/parameters.js.map +0 -1
  123. package/esm/operations/bitLockerKeys.d.ts +0 -37
  124. package/esm/operations/bitLockerKeys.d.ts.map +0 -1
  125. package/esm/operations/bitLockerKeys.js +0 -58
  126. package/esm/operations/bitLockerKeys.js.map +0 -1
  127. package/esm/operations/index.d.ts.map +0 -1
  128. package/esm/operations/index.js.map +0 -1
  129. package/esm/operations/jobs.d.ts +0 -189
  130. package/esm/operations/jobs.d.ts.map +0 -1
  131. package/esm/operations/jobs.js +0 -276
  132. package/esm/operations/jobs.js.map +0 -1
  133. package/esm/operations/locations.d.ts +0 -48
  134. package/esm/operations/locations.d.ts.map +0 -1
  135. package/esm/operations/locations.js +0 -79
  136. package/esm/operations/locations.js.map +0 -1
  137. package/esm/operations/operations.d.ts +0 -28
  138. package/esm/operations/operations.d.ts.map +0 -1
  139. package/esm/operations/operations.js +0 -51
  140. package/esm/operations/operations.js.map +0 -1
  141. package/esm/storageImportExportManagementClient.d.ts +0 -27
  142. package/esm/storageImportExportManagementClient.d.ts.map +0 -1
  143. package/esm/storageImportExportManagementClient.js +0 -41
  144. package/esm/storageImportExportManagementClient.js.map +0 -1
  145. package/esm/storageImportExportManagementClientContext.d.ts +0 -22
  146. package/esm/storageImportExportManagementClientContext.d.ts.map +0 -1
  147. package/esm/storageImportExportManagementClientContext.js +0 -60
  148. package/esm/storageImportExportManagementClientContext.js.map +0 -1
  149. package/src/models/bitLockerKeysMappers.ts +0 -17
  150. package/src/models/jobsMappers.ts +0 -27
  151. package/src/models/locationsMappers.ts +0 -17
  152. package/src/models/operationsMappers.ts +0 -17
  153. package/src/storageImportExportManagementClient.ts +0 -54
  154. package/src/storageImportExportManagementClientContext.ts +0 -67
@@ -0,0 +1,671 @@
1
+ import * as coreAuth from '@azure/core-auth';
2
+ import * as coreClient from '@azure/core-client';
3
+ import { PagedAsyncIterableIterator } from '@azure/core-paging';
4
+
5
+ /** Interface representing a BitLockerKeys. */
6
+ export declare interface BitLockerKeys {
7
+ /**
8
+ * Returns the BitLocker Keys for all drives in the specified job.
9
+ * @param jobName The name of the import/export job.
10
+ * @param resourceGroupName The resource group name uniquely identifies the resource group within the
11
+ * user subscription.
12
+ * @param options The options parameters.
13
+ */
14
+ list(jobName: string, resourceGroupName: string, options?: BitLockerKeysListOptionalParams): PagedAsyncIterableIterator<DriveBitLockerKey>;
15
+ }
16
+
17
+ /** Optional parameters. */
18
+ export declare interface BitLockerKeysListOptionalParams extends coreClient.OperationOptions {
19
+ }
20
+
21
+ /** Contains response data for the list operation. */
22
+ export declare type BitLockerKeysListResponse = GetBitLockerKeysResponse;
23
+
24
+ /**
25
+ * Defines values for CreatedByType. \
26
+ * {@link KnownCreatedByType} can be used interchangeably with CreatedByType,
27
+ * this enum contains the known values that the service supports.
28
+ * ### Known values supported by the service
29
+ * **User** \
30
+ * **Application** \
31
+ * **ManagedIdentity** \
32
+ * **Key**
33
+ */
34
+ export declare type CreatedByType = string;
35
+
36
+ /** Contains information about the delivery package being shipped by the customer to the Microsoft data center. */
37
+ export declare interface DeliveryPackageInformation {
38
+ /** The name of the carrier that is used to ship the import or export drives. */
39
+ carrierName: string;
40
+ /** The tracking number of the package. */
41
+ trackingNumber: string;
42
+ /** The number of drives included in the package. */
43
+ driveCount?: number;
44
+ /** The date when the package is shipped. */
45
+ shipDate?: string;
46
+ }
47
+
48
+ /** BitLocker recovery key or password to the specified drive */
49
+ export declare interface DriveBitLockerKey {
50
+ /** BitLocker recovery key or password */
51
+ bitLockerKey?: string;
52
+ /** Drive ID */
53
+ driveId?: string;
54
+ }
55
+
56
+ /**
57
+ * Defines values for DriveState. \
58
+ * {@link KnownDriveState} can be used interchangeably with DriveState,
59
+ * this enum contains the known values that the service supports.
60
+ * ### Known values supported by the service
61
+ * **Specified** \
62
+ * **Received** \
63
+ * **NeverReceived** \
64
+ * **Transferring** \
65
+ * **Completed** \
66
+ * **CompletedMoreInfo** \
67
+ * **ShippedBack**
68
+ */
69
+ export declare type DriveState = string;
70
+
71
+ /** Provides information about the drive's status */
72
+ export declare interface DriveStatus {
73
+ /** The drive's hardware serial number, without spaces. */
74
+ driveId?: string;
75
+ /** The BitLocker key used to encrypt the drive. */
76
+ bitLockerKey?: string;
77
+ /** The relative path of the manifest file on the drive. */
78
+ manifestFile?: string;
79
+ /** The Base16-encoded MD5 hash of the manifest file on the drive. */
80
+ manifestHash?: string;
81
+ /** The drive header hash value. */
82
+ driveHeaderHash?: string;
83
+ /** The drive's current state. */
84
+ state?: DriveState;
85
+ /** Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state. */
86
+ copyStatus?: string;
87
+ /** Percentage completed for the drive. */
88
+ percentComplete?: number;
89
+ /** A URI that points to the blob containing the verbose log for the data transfer operation. */
90
+ verboseLogUri?: string;
91
+ /** A URI that points to the blob containing the error log for the data transfer operation. */
92
+ errorLogUri?: string;
93
+ /** A URI that points to the blob containing the drive manifest file. */
94
+ manifestUri?: string;
95
+ /** Bytes successfully transferred for the drive. */
96
+ bytesSucceeded?: number;
97
+ }
98
+
99
+ /**
100
+ * Defines values for EncryptionKekType. \
101
+ * {@link KnownEncryptionKekType} can be used interchangeably with EncryptionKekType,
102
+ * this enum contains the known values that the service supports.
103
+ * ### Known values supported by the service
104
+ * **MicrosoftManaged** \
105
+ * **CustomerManaged**
106
+ */
107
+ export declare type EncryptionKekType = string;
108
+
109
+ /** Specifies the encryption key properties */
110
+ export declare interface EncryptionKeyDetails {
111
+ /** The type of kek encryption key */
112
+ kekType?: EncryptionKekType;
113
+ /** Specifies the url for kek encryption key. */
114
+ kekUrl?: string;
115
+ /** Specifies the keyvault resource id for kek encryption key. */
116
+ kekVaultResourceID?: string;
117
+ }
118
+
119
+ /** Response when errors occurred */
120
+ export declare interface ErrorResponse {
121
+ /** Provides information about the error code. */
122
+ code?: string;
123
+ /** Provides information about the error message. */
124
+ message?: string;
125
+ /** Provides information about the error target. */
126
+ target?: string;
127
+ /** Describes the error details if present. */
128
+ details?: ErrorResponseErrorDetailsItem[];
129
+ /** Inner error object if present. */
130
+ innererror?: Record<string, unknown>;
131
+ }
132
+
133
+ export declare interface ErrorResponseErrorDetailsItem {
134
+ /** Provides information about the error code. */
135
+ code?: string;
136
+ /** Provides information about the error target. */
137
+ target?: string;
138
+ /** Provides information about the error message. */
139
+ message?: string;
140
+ }
141
+
142
+ /** A property containing information about the blobs to be exported for an export job. This property is required for export jobs, but must not be specified for import jobs. */
143
+ export declare interface Export {
144
+ /** The relative URI to the block blob that contains the list of blob paths or blob path prefixes as defined above, beginning with the container name. If the blob is in root container, the URI must begin with $root. */
145
+ blobListBlobPath?: string;
146
+ /** A collection of blob-path strings. */
147
+ blobPath?: string[];
148
+ /** A collection of blob-prefix strings. */
149
+ blobPathPrefix?: string[];
150
+ }
151
+
152
+ /** GetBitLockerKeys response */
153
+ export declare interface GetBitLockerKeysResponse {
154
+ /** drive status */
155
+ value?: DriveBitLockerKey[];
156
+ }
157
+
158
+ /** Specifies the identity properties. */
159
+ export declare interface IdentityDetails {
160
+ /** The type of identity */
161
+ type?: IdentityType;
162
+ /**
163
+ * Specifies the principal id for the identity for the job.
164
+ * NOTE: This property will not be serialized. It can only be populated by the server.
165
+ */
166
+ readonly principalId?: string;
167
+ /**
168
+ * Specifies the tenant id for the identity for the job.
169
+ * NOTE: This property will not be serialized. It can only be populated by the server.
170
+ */
171
+ readonly tenantId?: string;
172
+ }
173
+
174
+ /**
175
+ * Defines values for IdentityType. \
176
+ * {@link KnownIdentityType} can be used interchangeably with IdentityType,
177
+ * this enum contains the known values that the service supports.
178
+ * ### Known values supported by the service
179
+ * **None** \
180
+ * **SystemAssigned** \
181
+ * **UserAssigned**
182
+ */
183
+ export declare type IdentityType = string;
184
+
185
+ /** Specifies the job properties */
186
+ export declare interface JobDetails {
187
+ /** The resource identifier of the storage account where data will be imported to or exported from. */
188
+ storageAccountId?: string;
189
+ /** The type of job */
190
+ jobType?: string;
191
+ /** Specifies the return address information for the job. */
192
+ returnAddress?: ReturnAddress;
193
+ /** Specifies the return carrier and customer's account with the carrier. */
194
+ returnShipping?: ReturnShipping;
195
+ /** Contains information about the Microsoft datacenter to which the drives should be shipped. */
196
+ shippingInformation?: ShippingInformation;
197
+ /** Contains information about the package being shipped by the customer to the Microsoft data center. */
198
+ deliveryPackage?: DeliveryPackageInformation;
199
+ /** Contains information about the package being shipped from the Microsoft data center to the customer to return the drives. The format is the same as the deliveryPackage property above. This property is not included if the drives have not yet been returned. */
200
+ returnPackage?: PackageInformation;
201
+ /** The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored. */
202
+ diagnosticsPath?: string;
203
+ /** Default value is Error. Indicates whether error logging or verbose logging will be enabled. */
204
+ logLevel?: string;
205
+ /** Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs. */
206
+ backupDriveManifest?: boolean;
207
+ /** Current state of the job. */
208
+ state?: string;
209
+ /** Indicates whether a request has been submitted to cancel the job. */
210
+ cancelRequested?: boolean;
211
+ /** Overall percentage completed for the job. */
212
+ percentComplete?: number;
213
+ /** A blob path that points to a block blob containing a list of blob names that were not exported due to insufficient drive space. If all blobs were exported successfully, then this element is not included in the response. */
214
+ incompleteBlobListUri?: string;
215
+ /** List of up to ten drives that comprise the job. The drive list is a required element for an import job; it is not specified for export jobs. */
216
+ driveList?: DriveStatus[];
217
+ /** A property containing information about the blobs to be exported for an export job. This property is included for export jobs only. */
218
+ export?: Export;
219
+ /** Specifies the provisioning state of the job. */
220
+ provisioningState?: string;
221
+ /** Contains information about the encryption key. */
222
+ encryptionKey?: EncryptionKeyDetails;
223
+ }
224
+
225
+ /** Contains the job information. */
226
+ export declare interface JobResponse {
227
+ /**
228
+ * SystemData of ImportExport Jobs.
229
+ * NOTE: This property will not be serialized. It can only be populated by the server.
230
+ */
231
+ readonly systemData?: SystemData;
232
+ /**
233
+ * Specifies the resource identifier of the job.
234
+ * NOTE: This property will not be serialized. It can only be populated by the server.
235
+ */
236
+ readonly id?: string;
237
+ /**
238
+ * Specifies the name of the job.
239
+ * NOTE: This property will not be serialized. It can only be populated by the server.
240
+ */
241
+ readonly name?: string;
242
+ /**
243
+ * Specifies the type of the job resource.
244
+ * NOTE: This property will not be serialized. It can only be populated by the server.
245
+ */
246
+ readonly type?: string;
247
+ /** Specifies the Azure location where the job is created. */
248
+ location?: string;
249
+ /** Specifies the tags that are assigned to the job. */
250
+ tags?: Record<string, unknown>;
251
+ /** Specifies the job properties */
252
+ properties?: JobDetails;
253
+ /** Specifies the job identity details */
254
+ identity?: IdentityDetails;
255
+ }
256
+
257
+ /** Interface representing a Jobs. */
258
+ export declare interface Jobs {
259
+ /**
260
+ * Returns all active and completed jobs in a subscription.
261
+ * @param options The options parameters.
262
+ */
263
+ listBySubscription(options?: JobsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<JobResponse>;
264
+ /**
265
+ * Returns all active and completed jobs in a resource group.
266
+ * @param resourceGroupName The resource group name uniquely identifies the resource group within the
267
+ * user subscription.
268
+ * @param options The options parameters.
269
+ */
270
+ listByResourceGroup(resourceGroupName: string, options?: JobsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<JobResponse>;
271
+ /**
272
+ * Gets information about an existing job.
273
+ * @param jobName The name of the import/export job.
274
+ * @param resourceGroupName The resource group name uniquely identifies the resource group within the
275
+ * user subscription.
276
+ * @param options The options parameters.
277
+ */
278
+ get(jobName: string, resourceGroupName: string, options?: JobsGetOptionalParams): Promise<JobsGetResponse>;
279
+ /**
280
+ * Updates specific properties of a job. You can call this operation to notify the Import/Export
281
+ * service that the hard drives comprising the import or export job have been shipped to the Microsoft
282
+ * data center. It can also be used to cancel an existing job.
283
+ * @param jobName The name of the import/export job.
284
+ * @param resourceGroupName The resource group name uniquely identifies the resource group within the
285
+ * user subscription.
286
+ * @param body The parameters to update in the job
287
+ * @param options The options parameters.
288
+ */
289
+ update(jobName: string, resourceGroupName: string, body: UpdateJobParameters, options?: JobsUpdateOptionalParams): Promise<JobsUpdateResponse>;
290
+ /**
291
+ * Creates a new job or updates an existing job in the specified subscription.
292
+ * @param jobName The name of the import/export job.
293
+ * @param resourceGroupName The resource group name uniquely identifies the resource group within the
294
+ * user subscription.
295
+ * @param body The parameters used for creating the job
296
+ * @param options The options parameters.
297
+ */
298
+ create(jobName: string, resourceGroupName: string, body: PutJobParameters, options?: JobsCreateOptionalParams): Promise<JobsCreateResponse>;
299
+ /**
300
+ * Deletes an existing job. Only jobs in the Creating or Completed states can be deleted.
301
+ * @param jobName The name of the import/export job.
302
+ * @param resourceGroupName The resource group name uniquely identifies the resource group within the
303
+ * user subscription.
304
+ * @param options The options parameters.
305
+ */
306
+ delete(jobName: string, resourceGroupName: string, options?: JobsDeleteOptionalParams): Promise<void>;
307
+ }
308
+
309
+ /** Optional parameters. */
310
+ export declare interface JobsCreateOptionalParams extends coreClient.OperationOptions {
311
+ /** The tenant ID of the client making the request. */
312
+ clientTenantId?: string;
313
+ }
314
+
315
+ /** Contains response data for the create operation. */
316
+ export declare type JobsCreateResponse = JobResponse;
317
+
318
+ /** Optional parameters. */
319
+ export declare interface JobsDeleteOptionalParams extends coreClient.OperationOptions {
320
+ }
321
+
322
+ /** Optional parameters. */
323
+ export declare interface JobsGetOptionalParams extends coreClient.OperationOptions {
324
+ }
325
+
326
+ /** Contains response data for the get operation. */
327
+ export declare type JobsGetResponse = JobResponse;
328
+
329
+ /** Optional parameters. */
330
+ export declare interface JobsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
331
+ /** An integer value that specifies how many jobs at most should be returned. The value cannot exceed 100. */
332
+ top?: number;
333
+ /** Can be used to restrict the results to certain conditions. */
334
+ filter?: string;
335
+ }
336
+
337
+ /** Contains response data for the listByResourceGroupNext operation. */
338
+ export declare type JobsListByResourceGroupNextResponse = ListJobsResponse;
339
+
340
+ /** Optional parameters. */
341
+ export declare interface JobsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
342
+ /** An integer value that specifies how many jobs at most should be returned. The value cannot exceed 100. */
343
+ top?: number;
344
+ /** Can be used to restrict the results to certain conditions. */
345
+ filter?: string;
346
+ }
347
+
348
+ /** Contains response data for the listByResourceGroup operation. */
349
+ export declare type JobsListByResourceGroupResponse = ListJobsResponse;
350
+
351
+ /** Optional parameters. */
352
+ export declare interface JobsListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
353
+ /** An integer value that specifies how many jobs at most should be returned. The value cannot exceed 100. */
354
+ top?: number;
355
+ /** Can be used to restrict the results to certain conditions. */
356
+ filter?: string;
357
+ }
358
+
359
+ /** Contains response data for the listBySubscriptionNext operation. */
360
+ export declare type JobsListBySubscriptionNextResponse = ListJobsResponse;
361
+
362
+ /** Optional parameters. */
363
+ export declare interface JobsListBySubscriptionOptionalParams extends coreClient.OperationOptions {
364
+ /** An integer value that specifies how many jobs at most should be returned. The value cannot exceed 100. */
365
+ top?: number;
366
+ /** Can be used to restrict the results to certain conditions. */
367
+ filter?: string;
368
+ }
369
+
370
+ /** Contains response data for the listBySubscription operation. */
371
+ export declare type JobsListBySubscriptionResponse = ListJobsResponse;
372
+
373
+ /** Optional parameters. */
374
+ export declare interface JobsUpdateOptionalParams extends coreClient.OperationOptions {
375
+ }
376
+
377
+ /** Contains response data for the update operation. */
378
+ export declare type JobsUpdateResponse = JobResponse;
379
+
380
+ /** Known values of {@link CreatedByType} that the service accepts. */
381
+ export declare enum KnownCreatedByType {
382
+ User = "User",
383
+ Application = "Application",
384
+ ManagedIdentity = "ManagedIdentity",
385
+ Key = "Key"
386
+ }
387
+
388
+ /** Known values of {@link DriveState} that the service accepts. */
389
+ export declare enum KnownDriveState {
390
+ Specified = "Specified",
391
+ Received = "Received",
392
+ NeverReceived = "NeverReceived",
393
+ Transferring = "Transferring",
394
+ Completed = "Completed",
395
+ CompletedMoreInfo = "CompletedMoreInfo",
396
+ ShippedBack = "ShippedBack"
397
+ }
398
+
399
+ /** Known values of {@link EncryptionKekType} that the service accepts. */
400
+ export declare enum KnownEncryptionKekType {
401
+ MicrosoftManaged = "MicrosoftManaged",
402
+ CustomerManaged = "CustomerManaged"
403
+ }
404
+
405
+ /** Known values of {@link IdentityType} that the service accepts. */
406
+ export declare enum KnownIdentityType {
407
+ None = "None",
408
+ SystemAssigned = "SystemAssigned",
409
+ UserAssigned = "UserAssigned"
410
+ }
411
+
412
+ /** List jobs response */
413
+ export declare interface ListJobsResponse {
414
+ /** link to next batch of jobs */
415
+ nextLink?: string;
416
+ /** Job list */
417
+ value?: JobResponse[];
418
+ }
419
+
420
+ /** List operations response */
421
+ export declare interface ListOperationsResponse {
422
+ /** operations */
423
+ value?: Operation[];
424
+ }
425
+
426
+ /** Provides information about an Azure data center location. */
427
+ declare interface Location_2 {
428
+ /** Specifies the resource identifier of the location. */
429
+ id?: string;
430
+ /** Specifies the name of the location. Use List Locations to get all supported locations. */
431
+ name?: string;
432
+ /** Specifies the type of the location. */
433
+ type?: string;
434
+ /** The recipient name to use when shipping the drives to the Azure data center. */
435
+ recipientName?: string;
436
+ /** The first line of the street address to use when shipping the drives to the Azure data center. */
437
+ streetAddress1?: string;
438
+ /** The second line of the street address to use when shipping the drives to the Azure data center. */
439
+ streetAddress2?: string;
440
+ /** The city name to use when shipping the drives to the Azure data center. */
441
+ city?: string;
442
+ /** The state or province to use when shipping the drives to the Azure data center. */
443
+ stateOrProvince?: string;
444
+ /** The postal code to use when shipping the drives to the Azure data center. */
445
+ postalCode?: string;
446
+ /** The country or region to use when shipping the drives to the Azure data center. */
447
+ countryOrRegion?: string;
448
+ /** The phone number for the Azure data center. */
449
+ phone?: string;
450
+ /** Additional shipping information for customer, specific to datacenter to which customer should send their disks. */
451
+ additionalShippingInformation?: string;
452
+ /** A list of carriers that are supported at this location. */
453
+ supportedCarriers?: string[];
454
+ /** A list of location IDs that should be used to ship shipping drives to for jobs created against the current location. If the current location is active, it will be part of the list. If it is temporarily closed due to maintenance, this list may contain other locations. */
455
+ alternateLocations?: string[];
456
+ }
457
+ export { Location_2 as Location }
458
+
459
+ /** Interface representing a Locations. */
460
+ export declare interface Locations {
461
+ /**
462
+ * Returns a list of locations to which you can ship the disks associated with an import or export job.
463
+ * A location is a Microsoft data center region.
464
+ * @param options The options parameters.
465
+ */
466
+ list(options?: LocationsListOptionalParams): PagedAsyncIterableIterator<Location_2>;
467
+ /**
468
+ * Returns the details about a location to which you can ship the disks associated with an import or
469
+ * export job. A location is an Azure region.
470
+ * @param locationName The name of the location. For example, West US or westus.
471
+ * @param options The options parameters.
472
+ */
473
+ get(locationName: string, options?: LocationsGetOptionalParams): Promise<LocationsGetResponse>;
474
+ }
475
+
476
+ /** Optional parameters. */
477
+ export declare interface LocationsGetOptionalParams extends coreClient.OperationOptions {
478
+ }
479
+
480
+ /** Contains response data for the get operation. */
481
+ export declare type LocationsGetResponse = Location_2;
482
+
483
+ /** Optional parameters. */
484
+ export declare interface LocationsListOptionalParams extends coreClient.OperationOptions {
485
+ }
486
+
487
+ /** Contains response data for the list operation. */
488
+ export declare type LocationsListResponse = LocationsResponse;
489
+
490
+ /** Locations response */
491
+ export declare interface LocationsResponse {
492
+ /** locations */
493
+ value?: Location_2[];
494
+ }
495
+
496
+ /** Describes a supported operation by the Storage Import/Export job API. */
497
+ export declare interface Operation {
498
+ /** Name of the operation. */
499
+ name: string;
500
+ /** The resource provider name to which the operation belongs. */
501
+ provider?: string;
502
+ /** The name of the resource to which the operation belongs. */
503
+ resource?: string;
504
+ /** The display name of the operation. */
505
+ operation?: string;
506
+ /** Short description of the operation. */
507
+ description?: string;
508
+ }
509
+
510
+ /** Interface representing a Operations. */
511
+ export declare interface Operations {
512
+ /**
513
+ * Returns the list of operations supported by the import/export resource provider.
514
+ * @param options The options parameters.
515
+ */
516
+ list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
517
+ }
518
+
519
+ /** Optional parameters. */
520
+ export declare interface OperationsListOptionalParams extends coreClient.OperationOptions {
521
+ }
522
+
523
+ /** Contains response data for the list operation. */
524
+ export declare type OperationsListResponse = ListOperationsResponse;
525
+
526
+ /** Contains information about the package being shipped by the customer to the Microsoft data center. */
527
+ export declare interface PackageInformation {
528
+ /** The name of the carrier that is used to ship the import or export drives. */
529
+ carrierName: string;
530
+ /** The tracking number of the package. */
531
+ trackingNumber: string;
532
+ /** The number of drives included in the package. */
533
+ driveCount: number;
534
+ /** The date when the package is shipped. */
535
+ shipDate: string;
536
+ }
537
+
538
+ /** Put Job parameters */
539
+ export declare interface PutJobParameters {
540
+ /** Specifies the supported Azure location where the job should be created */
541
+ location?: string;
542
+ /** Specifies the tags that will be assigned to the job. */
543
+ tags?: Record<string, unknown>;
544
+ /** Specifies the job properties */
545
+ properties?: JobDetails;
546
+ }
547
+
548
+ /** Specifies the return address information for the job. */
549
+ export declare interface ReturnAddress {
550
+ /** The name of the recipient who will receive the hard drives when they are returned. */
551
+ recipientName: string;
552
+ /** The first line of the street address to use when returning the drives. */
553
+ streetAddress1: string;
554
+ /** The second line of the street address to use when returning the drives. */
555
+ streetAddress2?: string;
556
+ /** The city name to use when returning the drives. */
557
+ city: string;
558
+ /** The state or province to use when returning the drives. */
559
+ stateOrProvince?: string;
560
+ /** The postal code to use when returning the drives. */
561
+ postalCode: string;
562
+ /** The country or region to use when returning the drives. */
563
+ countryOrRegion: string;
564
+ /** Phone number of the recipient of the returned drives. */
565
+ phone: string;
566
+ /** Email address of the recipient of the returned drives. */
567
+ email: string;
568
+ }
569
+
570
+ /** Specifies the return carrier and customer's account with the carrier. */
571
+ export declare interface ReturnShipping {
572
+ /** The carrier's name. */
573
+ carrierName: string;
574
+ /** The customer's account number with the carrier. */
575
+ carrierAccountNumber: string;
576
+ }
577
+
578
+ /** Contains information about the Microsoft datacenter to which the drives should be shipped. */
579
+ export declare interface ShippingInformation {
580
+ /** The name of the recipient who will receive the hard drives when they are returned. */
581
+ recipientName?: string;
582
+ /** The first line of the street address to use when returning the drives. */
583
+ streetAddress1?: string;
584
+ /** The second line of the street address to use when returning the drives. */
585
+ streetAddress2?: string;
586
+ /** The city name to use when returning the drives. */
587
+ city?: string;
588
+ /** The state or province to use when returning the drives. */
589
+ stateOrProvince?: string;
590
+ /** The postal code to use when returning the drives. */
591
+ postalCode?: string;
592
+ /** The country or region to use when returning the drives. */
593
+ countryOrRegion?: string;
594
+ /** Phone number of the recipient of the returned drives. */
595
+ phone?: string;
596
+ /**
597
+ * Additional shipping information for customer, specific to datacenter to which customer should send their disks.
598
+ * NOTE: This property will not be serialized. It can only be populated by the server.
599
+ */
600
+ readonly additionalInformation?: string;
601
+ }
602
+
603
+ export declare class StorageImportExport extends coreClient.ServiceClient {
604
+ $host: string;
605
+ apiVersion: string;
606
+ acceptLanguage?: string;
607
+ subscriptionId: string;
608
+ /**
609
+ * Initializes a new instance of the StorageImportExport class.
610
+ * @param credentials Subscription credentials which uniquely identify client subscription.
611
+ * @param subscriptionId The subscription ID for the Azure user.
612
+ * @param options The parameter options
613
+ */
614
+ constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: StorageImportExportOptionalParams);
615
+ locations: Locations;
616
+ jobs: Jobs;
617
+ bitLockerKeys: BitLockerKeys;
618
+ operations: Operations;
619
+ }
620
+
621
+ /** Optional parameters. */
622
+ export declare interface StorageImportExportOptionalParams extends coreClient.ServiceClientOptions {
623
+ /** server parameter */
624
+ $host?: string;
625
+ /** Api Version */
626
+ apiVersion?: string;
627
+ /** Specifies the preferred language for the response. */
628
+ acceptLanguage?: string;
629
+ /** Overrides client endpoint. */
630
+ endpoint?: string;
631
+ }
632
+
633
+ /** Metadata pertaining to creation and last modification of the resource. */
634
+ export declare interface SystemData {
635
+ /** The identity that created the resource. */
636
+ createdBy?: string;
637
+ /** The type of identity that created the resource. */
638
+ createdByType?: CreatedByType;
639
+ /** The timestamp of resource creation (UTC). */
640
+ createdAt?: Date;
641
+ /** The identity that last modified the resource. */
642
+ lastModifiedBy?: string;
643
+ /** The type of identity that last modified the resource. */
644
+ lastModifiedByType?: CreatedByType;
645
+ /** The timestamp of resource last modification (UTC) */
646
+ lastModifiedAt?: Date;
647
+ }
648
+
649
+ /** Update Job parameters */
650
+ export declare interface UpdateJobParameters {
651
+ /** Specifies the tags that will be assigned to the job */
652
+ tags?: Record<string, unknown>;
653
+ /** If specified, the value must be true. The service will attempt to cancel the job. */
654
+ cancelRequested?: boolean;
655
+ /** If specified, the value must be Shipping, which tells the Import/Export service that the package for the job has been shipped. The ReturnAddress and DeliveryPackage properties must have been set either in this request or in a previous request, otherwise the request will fail. */
656
+ state?: string;
657
+ /** Specifies the return address information for the job. */
658
+ returnAddress?: ReturnAddress;
659
+ /** Specifies the return carrier and customer's account with the carrier. */
660
+ returnShipping?: ReturnShipping;
661
+ /** Contains information about the package being shipped by the customer to the Microsoft data center. */
662
+ deliveryPackage?: DeliveryPackageInformation;
663
+ /** Indicates whether error logging or verbose logging is enabled. */
664
+ logLevel?: string;
665
+ /** Indicates whether the manifest files on the drives should be copied to block blobs. */
666
+ backupDriveManifest?: boolean;
667
+ /** List of drives that comprise the job. */
668
+ driveList?: DriveStatus[];
669
+ }
670
+
671
+ export { }
@@ -0,0 +1,11 @@
1
+ // This file is read by tools that parse documentation comments conforming to the TSDoc standard.
2
+ // It should be published with your NPM package. It should not be tracked by Git.
3
+ {
4
+ "tsdocVersion": "0.12",
5
+ "toolPackages": [
6
+ {
7
+ "packageName": "@microsoft/api-extractor",
8
+ "packageVersion": "7.19.4"
9
+ }
10
+ ]
11
+ }