@azure-rest/iot-device-update 1.0.1-alpha.20241203.1 → 1.0.1-alpha.20241204.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 (175) hide show
  1. package/dist/browser/clientDefinitions.d.ts +273 -0
  2. package/dist/browser/clientDefinitions.d.ts.map +1 -0
  3. package/dist/browser/clientDefinitions.js.map +1 -0
  4. package/dist/browser/deviceUpdate.d.ts +5 -0
  5. package/dist/browser/deviceUpdate.d.ts.map +1 -0
  6. package/{dist-esm/src → dist/browser}/deviceUpdate.js.map +1 -1
  7. package/dist/browser/index.d.ts +12 -0
  8. package/dist/browser/index.d.ts.map +1 -0
  9. package/dist/browser/index.js +15 -0
  10. package/dist/browser/index.js.map +1 -0
  11. package/dist/browser/isUnexpected.d.ts +52 -0
  12. package/dist/browser/isUnexpected.d.ts.map +1 -0
  13. package/dist/browser/isUnexpected.js.map +1 -0
  14. package/dist/browser/models.d.ts +95 -0
  15. package/dist/browser/models.d.ts.map +1 -0
  16. package/dist/browser/outputModels.d.ts +499 -0
  17. package/dist/browser/outputModels.d.ts.map +1 -0
  18. package/dist/browser/package.json +3 -0
  19. package/dist/browser/paginateHelper.d.ts +43 -0
  20. package/dist/browser/paginateHelper.d.ts.map +1 -0
  21. package/dist/browser/parameters.d.ts +212 -0
  22. package/dist/browser/parameters.d.ts.map +1 -0
  23. package/dist/browser/parameters.js.map +1 -0
  24. package/dist/browser/pollingHelper.d.ts +11 -0
  25. package/dist/browser/pollingHelper.d.ts.map +1 -0
  26. package/dist/browser/responses.d.ts +554 -0
  27. package/dist/browser/responses.d.ts.map +1 -0
  28. package/dist/browser/responses.js.map +1 -0
  29. package/dist/commonjs/clientDefinitions.d.ts +273 -0
  30. package/dist/commonjs/clientDefinitions.d.ts.map +1 -0
  31. package/dist/commonjs/clientDefinitions.js +5 -0
  32. package/dist/commonjs/clientDefinitions.js.map +1 -0
  33. package/dist/commonjs/deviceUpdate.d.ts +5 -0
  34. package/dist/commonjs/deviceUpdate.d.ts.map +1 -0
  35. package/dist/commonjs/deviceUpdate.js +24 -0
  36. package/dist/commonjs/deviceUpdate.js.map +1 -0
  37. package/dist/commonjs/index.d.ts +12 -0
  38. package/dist/commonjs/index.d.ts.map +1 -0
  39. package/dist/commonjs/index.js +18 -0
  40. package/dist/commonjs/index.js.map +1 -0
  41. package/dist/commonjs/isUnexpected.d.ts +52 -0
  42. package/dist/commonjs/isUnexpected.d.ts.map +1 -0
  43. package/dist/{index.js → commonjs/isUnexpected.js} +4 -152
  44. package/dist/commonjs/isUnexpected.js.map +1 -0
  45. package/dist/commonjs/models.d.ts +95 -0
  46. package/dist/commonjs/models.d.ts.map +1 -0
  47. package/dist/commonjs/models.js +5 -0
  48. package/dist/commonjs/models.js.map +1 -0
  49. package/dist/commonjs/outputModels.d.ts +499 -0
  50. package/dist/commonjs/outputModels.d.ts.map +1 -0
  51. package/dist/commonjs/outputModels.js +5 -0
  52. package/dist/commonjs/outputModels.js.map +1 -0
  53. package/dist/commonjs/package.json +3 -0
  54. package/dist/commonjs/paginateHelper.d.ts +43 -0
  55. package/dist/commonjs/paginateHelper.d.ts.map +1 -0
  56. package/dist/commonjs/paginateHelper.js +73 -0
  57. package/dist/commonjs/paginateHelper.js.map +1 -0
  58. package/dist/commonjs/parameters.d.ts +212 -0
  59. package/dist/commonjs/parameters.d.ts.map +1 -0
  60. package/dist/commonjs/parameters.js +5 -0
  61. package/dist/commonjs/parameters.js.map +1 -0
  62. package/dist/commonjs/pollingHelper.d.ts +11 -0
  63. package/dist/commonjs/pollingHelper.d.ts.map +1 -0
  64. package/dist/commonjs/pollingHelper.js +51 -0
  65. package/dist/commonjs/pollingHelper.js.map +1 -0
  66. package/dist/commonjs/responses.d.ts +554 -0
  67. package/dist/commonjs/responses.d.ts.map +1 -0
  68. package/dist/commonjs/responses.js +5 -0
  69. package/dist/commonjs/responses.js.map +1 -0
  70. package/dist/commonjs/tsdoc-metadata.json +11 -0
  71. package/dist/esm/clientDefinitions.d.ts +273 -0
  72. package/dist/esm/clientDefinitions.d.ts.map +1 -0
  73. package/dist/esm/clientDefinitions.js +4 -0
  74. package/dist/esm/clientDefinitions.js.map +1 -0
  75. package/dist/esm/deviceUpdate.d.ts +5 -0
  76. package/dist/esm/deviceUpdate.d.ts.map +1 -0
  77. package/dist/esm/deviceUpdate.js +21 -0
  78. package/dist/esm/deviceUpdate.js.map +1 -0
  79. package/dist/esm/index.d.ts +12 -0
  80. package/dist/esm/index.d.ts.map +1 -0
  81. package/dist/esm/index.js +15 -0
  82. package/dist/esm/index.js.map +1 -0
  83. package/dist/esm/isUnexpected.d.ts +52 -0
  84. package/dist/esm/isUnexpected.d.ts.map +1 -0
  85. package/dist/esm/isUnexpected.js +127 -0
  86. package/dist/esm/isUnexpected.js.map +1 -0
  87. package/dist/esm/models.d.ts +95 -0
  88. package/dist/esm/models.d.ts.map +1 -0
  89. package/dist/esm/models.js +4 -0
  90. package/dist/esm/models.js.map +1 -0
  91. package/dist/esm/outputModels.d.ts +499 -0
  92. package/dist/esm/outputModels.d.ts.map +1 -0
  93. package/dist/esm/outputModels.js +4 -0
  94. package/dist/esm/outputModels.js.map +1 -0
  95. package/dist/esm/package.json +3 -0
  96. package/dist/esm/paginateHelper.d.ts +43 -0
  97. package/dist/esm/paginateHelper.d.ts.map +1 -0
  98. package/dist/esm/paginateHelper.js +70 -0
  99. package/dist/esm/paginateHelper.js.map +1 -0
  100. package/dist/esm/parameters.d.ts +212 -0
  101. package/dist/esm/parameters.d.ts.map +1 -0
  102. package/dist/esm/parameters.js +4 -0
  103. package/dist/esm/parameters.js.map +1 -0
  104. package/dist/esm/pollingHelper.d.ts +11 -0
  105. package/dist/esm/pollingHelper.d.ts.map +1 -0
  106. package/dist/esm/pollingHelper.js +48 -0
  107. package/dist/esm/pollingHelper.js.map +1 -0
  108. package/dist/esm/responses.d.ts +554 -0
  109. package/dist/esm/responses.d.ts.map +1 -0
  110. package/dist/esm/responses.js +4 -0
  111. package/dist/esm/responses.js.map +1 -0
  112. package/dist/react-native/clientDefinitions.d.ts +273 -0
  113. package/dist/react-native/clientDefinitions.d.ts.map +1 -0
  114. package/dist/react-native/clientDefinitions.js +4 -0
  115. package/dist/react-native/clientDefinitions.js.map +1 -0
  116. package/dist/react-native/deviceUpdate.d.ts +5 -0
  117. package/dist/react-native/deviceUpdate.d.ts.map +1 -0
  118. package/dist/react-native/deviceUpdate.js +21 -0
  119. package/dist/react-native/deviceUpdate.js.map +1 -0
  120. package/dist/react-native/index.d.ts +12 -0
  121. package/dist/react-native/index.d.ts.map +1 -0
  122. package/dist/react-native/index.js +15 -0
  123. package/dist/react-native/index.js.map +1 -0
  124. package/dist/react-native/isUnexpected.d.ts +52 -0
  125. package/dist/react-native/isUnexpected.d.ts.map +1 -0
  126. package/dist/react-native/isUnexpected.js +127 -0
  127. package/dist/react-native/isUnexpected.js.map +1 -0
  128. package/dist/react-native/models.d.ts +95 -0
  129. package/dist/react-native/models.d.ts.map +1 -0
  130. package/dist/react-native/models.js +4 -0
  131. package/dist/react-native/models.js.map +1 -0
  132. package/dist/react-native/outputModels.d.ts +499 -0
  133. package/dist/react-native/outputModels.d.ts.map +1 -0
  134. package/dist/react-native/outputModels.js +4 -0
  135. package/dist/react-native/outputModels.js.map +1 -0
  136. package/dist/react-native/package.json +3 -0
  137. package/dist/react-native/paginateHelper.d.ts +43 -0
  138. package/dist/react-native/paginateHelper.d.ts.map +1 -0
  139. package/dist/react-native/paginateHelper.js +70 -0
  140. package/dist/react-native/paginateHelper.js.map +1 -0
  141. package/dist/react-native/parameters.d.ts +212 -0
  142. package/dist/react-native/parameters.d.ts.map +1 -0
  143. package/dist/react-native/parameters.js +4 -0
  144. package/dist/react-native/parameters.js.map +1 -0
  145. package/dist/react-native/pollingHelper.d.ts +11 -0
  146. package/dist/react-native/pollingHelper.d.ts.map +1 -0
  147. package/dist/react-native/pollingHelper.js +48 -0
  148. package/dist/react-native/pollingHelper.js.map +1 -0
  149. package/dist/react-native/responses.d.ts +554 -0
  150. package/dist/react-native/responses.d.ts.map +1 -0
  151. package/dist/react-native/responses.js +4 -0
  152. package/dist/react-native/responses.js.map +1 -0
  153. package/package.json +65 -50
  154. package/dist/index.js.map +0 -1
  155. package/dist-esm/src/clientDefinitions.js.map +0 -1
  156. package/dist-esm/src/index.js +0 -14
  157. package/dist-esm/src/index.js.map +0 -1
  158. package/dist-esm/src/isUnexpected.js.map +0 -1
  159. package/dist-esm/src/parameters.js.map +0 -1
  160. package/dist-esm/src/responses.js.map +0 -1
  161. package/review/iot-device-update.api.md +0 -2198
  162. package/types/iot-device-update.d.ts +0 -2096
  163. /package/{dist-esm/src → dist/browser}/clientDefinitions.js +0 -0
  164. /package/{dist-esm/src → dist/browser}/deviceUpdate.js +0 -0
  165. /package/{dist-esm/src → dist/browser}/isUnexpected.js +0 -0
  166. /package/{dist-esm/src → dist/browser}/models.js +0 -0
  167. /package/{dist-esm/src → dist/browser}/models.js.map +0 -0
  168. /package/{dist-esm/src → dist/browser}/outputModels.js +0 -0
  169. /package/{dist-esm/src → dist/browser}/outputModels.js.map +0 -0
  170. /package/{dist-esm/src → dist/browser}/paginateHelper.js +0 -0
  171. /package/{dist-esm/src → dist/browser}/paginateHelper.js.map +0 -0
  172. /package/{dist-esm/src → dist/browser}/parameters.js +0 -0
  173. /package/{dist-esm/src → dist/browser}/pollingHelper.js +0 -0
  174. /package/{dist-esm/src → dist/browser}/pollingHelper.js.map +0 -0
  175. /package/{dist-esm/src → dist/browser}/responses.js +0 -0
@@ -0,0 +1,499 @@
1
+ export interface UpdateListOutput {
2
+ /** The collection of pageable items. */
3
+ value: Array<UpdateOutput>;
4
+ /** The link to the next page of items. */
5
+ nextLink?: string;
6
+ }
7
+ export interface UpdateOutput {
8
+ /** Update identity. */
9
+ updateId: UpdateIdOutput;
10
+ /** Update description specified by creator. */
11
+ description?: string;
12
+ /** Friendly update name specified by importer. */
13
+ friendlyName?: string;
14
+ /** Whether the update can be deployed to a device on its own. */
15
+ isDeployable?: boolean;
16
+ /** Update type. Deprecated in latest import manifest schema. */
17
+ updateType?: string;
18
+ /** String interpreted by Device Update client to determine if the update is installed on the device. Deprecated in latest import manifest schema. */
19
+ installedCriteria?: string;
20
+ /** List of update compatibility information. */
21
+ compatibility: Array<Record<string, string>>;
22
+ /** Update install instructions. */
23
+ instructions?: InstructionsOutput;
24
+ /** List of update identities that reference this update. */
25
+ referencedBy?: Array<UpdateIdOutput>;
26
+ /** Update aggregate scan result (calculated from payload file scan results). */
27
+ scanResult?: string;
28
+ /** Schema version of manifest used to import the update. */
29
+ manifestVersion: string;
30
+ /** Date and time in UTC when the update was imported. */
31
+ importedDateTime: string;
32
+ /** Date and time in UTC when the update was created. */
33
+ createdDateTime: string;
34
+ /** Update ETag. */
35
+ etag?: string;
36
+ }
37
+ export interface UpdateIdOutput {
38
+ /** Update provider. */
39
+ provider: string;
40
+ /** Update name. */
41
+ name: string;
42
+ /** Update version. */
43
+ version: string;
44
+ }
45
+ export interface InstructionsOutput {
46
+ /** Collection of installation steps. */
47
+ steps: Array<StepOutput>;
48
+ }
49
+ export interface StepOutput {
50
+ /** Step type. */
51
+ type?: "Inline" | "Reference";
52
+ /** Step description. */
53
+ description?: string;
54
+ /** Identity of handler that will execute this step. Required if step type is inline. */
55
+ handler?: string;
56
+ /** Parameters to be passed to handler during execution. */
57
+ handlerProperties?: Record<string, unknown>;
58
+ /** Collection of file names to be passed to handler during execution. Required if step type is inline. */
59
+ files?: Array<string>;
60
+ /** Referenced child update identity. Required if step type is reference. */
61
+ updateId?: UpdateIdOutput;
62
+ }
63
+ export interface ErrorResponseOutput {
64
+ /** The error details. */
65
+ error: ErrorModelOutput;
66
+ }
67
+ export interface ErrorModelOutput {
68
+ /** Server defined error code. */
69
+ code: string;
70
+ /** A human-readable representation of the error. */
71
+ message: string;
72
+ /** The target of the error. */
73
+ target?: string;
74
+ /** An array of errors that led to the reported error. */
75
+ details?: Array<ErrorModelOutput>;
76
+ /** An object containing more specific information than the current object about the error. */
77
+ innererror?: InnerErrorOutput;
78
+ /** Date and time in UTC when the error occurred. */
79
+ occurredDateTime?: string;
80
+ }
81
+ export interface InnerErrorOutput {
82
+ /** A more specific error code than what was provided by the containing error. */
83
+ code: string;
84
+ /** A human-readable representation of the error. */
85
+ message?: string;
86
+ /** The internal error or exception message. */
87
+ errorDetail?: string;
88
+ /** An object containing more specific information than the current object about the error. */
89
+ innerError?: InnerErrorOutput;
90
+ }
91
+ export interface StringsListOutput {
92
+ /** The collection of pageable items. */
93
+ value: Array<string>;
94
+ /** The link to the next page of items. */
95
+ nextLink?: string;
96
+ }
97
+ export interface UpdateFileOutput extends UpdateFileBaseOutput {
98
+ /** File identity, generated by server at import time. */
99
+ fileId: string;
100
+ /** Optional related files metadata used together DownloadHandler metadata to download payload file. */
101
+ relatedFiles?: Array<UpdateFileBaseOutput>;
102
+ /** Optional download handler for utilizing related files to download payload file. */
103
+ downloadHandler?: UpdateFileDownloadHandlerOutput;
104
+ /** File ETag. */
105
+ etag?: string;
106
+ }
107
+ export interface UpdateFileBaseOutput {
108
+ /** File name. */
109
+ fileName: string;
110
+ /** File size in number of bytes. */
111
+ sizeInBytes: number;
112
+ /** Mapping of hashing algorithm to base64 encoded hash values. */
113
+ hashes: Record<string, string>;
114
+ /** File MIME type. */
115
+ mimeType?: string;
116
+ /** Anti-malware scan result. */
117
+ scanResult?: string;
118
+ /** Anti-malware scan details. */
119
+ scanDetails?: string;
120
+ /** Optional file properties (not consumed by service but pass-through to device). */
121
+ properties?: Record<string, string>;
122
+ }
123
+ export interface UpdateFileDownloadHandlerOutput {
124
+ /** Download handler identifier. */
125
+ id: string;
126
+ }
127
+ export interface UpdateOperationsListOutput {
128
+ /** The collection of pageable items. */
129
+ value: Array<UpdateOperationOutput>;
130
+ /** The link to the next page of items. */
131
+ nextLink?: string;
132
+ }
133
+ export interface UpdateOperationOutput {
134
+ /** Operation Id. */
135
+ operationId: string;
136
+ /** Operation status. */
137
+ status: "NotStarted" | "Running" | "Succeeded" | "Failed";
138
+ /** The update being imported or deleted. For import, this property will only be populated after import manifest is processed successfully. */
139
+ update?: UpdateInfoOutput;
140
+ /** Location of the imported update when operation is successful. */
141
+ resourceLocation?: string;
142
+ /** Operation error encountered, if any. */
143
+ error?: ErrorModelOutput;
144
+ /** Operation correlation identity that can used by Microsoft Support for troubleshooting. */
145
+ traceId?: string;
146
+ /** Date and time in UTC when the operation status was last updated. */
147
+ lastActionDateTime: string;
148
+ /** Date and time in UTC when the operation was created. */
149
+ createdDateTime: string;
150
+ /** Operation ETag. */
151
+ etag?: string;
152
+ }
153
+ export interface UpdateInfoOutput {
154
+ /** Update identifier. */
155
+ updateId: UpdateIdOutput;
156
+ /** Update description. */
157
+ description?: string;
158
+ /** Friendly update name. */
159
+ friendlyName?: string;
160
+ }
161
+ export interface DeviceClassesListOutput {
162
+ /** The collection of pageable items. */
163
+ value: Array<DeviceClassOutput>;
164
+ /** The link to the next page of items. */
165
+ nextLink?: string;
166
+ }
167
+ export interface DeviceClassOutput {
168
+ /** The device class identifier. This is generated from the model Id and the compat properties reported by the device update agent in the Device Update PnP interface in IoT Hub. It is a hex-encoded SHA1 hash. */
169
+ deviceClassId: string;
170
+ /** The device class friendly name. This can be updated by callers after the device class has been automatically created. */
171
+ friendlyName?: string;
172
+ /** The device class properties that are used to calculate the device class Id */
173
+ deviceClassProperties: DeviceClassPropertiesOutput;
174
+ /** Update that is the highest version compatible with this device class. */
175
+ bestCompatibleUpdate?: UpdateInfoOutput;
176
+ }
177
+ export interface DeviceClassPropertiesOutput {
178
+ /** The Device Update agent contract model. */
179
+ contractModel?: ContractModelOutput;
180
+ /** The compat properties of the device class. This object can be thought of as a set of key-value pairs where the key is the name of the compatibility property and the value is the value of the compatibility property. There will always be at least 1 compat property */
181
+ compatProperties: Record<string, string>;
182
+ }
183
+ export interface ContractModelOutput {
184
+ /** The Device Update agent contract model Id of the device class. This is also used to calculate the device class Id. */
185
+ id: string;
186
+ /** The Device Update agent contract model name of the device class. Intended to be a more readable form of the contract model Id. */
187
+ name: string;
188
+ }
189
+ export interface UpdateInfoListOutput {
190
+ /** The collection of pageable items. */
191
+ value: Array<UpdateInfoOutput>;
192
+ /** The link to the next page of items. */
193
+ nextLink?: string;
194
+ }
195
+ export interface DevicesListOutput {
196
+ /** The collection of pageable items. */
197
+ value: Array<DeviceOutput>;
198
+ /** The link to the next page of items. */
199
+ nextLink?: string;
200
+ }
201
+ export interface DeviceOutput {
202
+ /** Device identity. */
203
+ deviceId: string;
204
+ /** Device module identity. */
205
+ moduleId?: string;
206
+ /** Device class identity. */
207
+ deviceClassId: string;
208
+ /** Device group identity. */
209
+ groupId?: string;
210
+ /** The update that device last attempted to install. */
211
+ lastAttemptedUpdate?: UpdateInfoOutput;
212
+ /** State of the device in its last deployment. */
213
+ deploymentStatus?: "Succeeded" | "InProgress" | "Canceled" | "Failed";
214
+ /** Currently installed update on device. */
215
+ installedUpdate?: UpdateInfoOutput;
216
+ /** Boolean flag indicating whether the latest update (the best compatible update for the device's device class and group) is installed on the device */
217
+ onLatestUpdate: boolean;
218
+ /** The deployment identifier for the last deployment to the device */
219
+ lastDeploymentId?: string;
220
+ /** Last install result. */
221
+ lastInstallResult?: InstallResultOutput;
222
+ }
223
+ export interface InstallResultOutput {
224
+ /** Install result code. */
225
+ resultCode: number;
226
+ /** Install extended result code */
227
+ extendedResultCode: number;
228
+ /** A string containing further details about the install result */
229
+ resultDetails?: string;
230
+ /** Array of step results */
231
+ stepResults?: Array<StepResultOutput>;
232
+ }
233
+ export interface StepResultOutput {
234
+ /** The update that this step installs if it is of reference type. */
235
+ update?: UpdateInfoOutput;
236
+ /** Step description. */
237
+ description?: string;
238
+ /** Install result code. */
239
+ resultCode: number;
240
+ /** Install extended result code */
241
+ extendedResultCode: number;
242
+ /** A string containing further details about the install result */
243
+ resultDetails?: string;
244
+ }
245
+ export interface UpdateComplianceOutput {
246
+ /** Total number of devices. */
247
+ totalDeviceCount: number;
248
+ /** Number of devices on the latest update. */
249
+ onLatestUpdateDeviceCount: number;
250
+ /** Number of devices with a newer update available. */
251
+ newUpdatesAvailableDeviceCount: number;
252
+ /** Number of devices with update in-progress. */
253
+ updatesInProgressDeviceCount: number;
254
+ }
255
+ export interface GroupsListOutput {
256
+ /** The collection of pageable items. */
257
+ value: Array<GroupOutput>;
258
+ /** The link to the next page of items. */
259
+ nextLink?: string;
260
+ }
261
+ export interface GroupOutput {
262
+ /** Group identity. This is created from the value of the ADUGroup tag in the Iot Hub's device/module twin or $default for devices with no tag. */
263
+ groupId: string;
264
+ /** Group type. */
265
+ groupType: "IoTHubTag" | "DefaultNoTag";
266
+ /** Date and time when the update was created. */
267
+ createdDateTime: string;
268
+ /** The number of devices in the group. */
269
+ deviceCount?: number;
270
+ /** The count of subgroups with new updates available. */
271
+ subgroupsWithNewUpdatesAvailableCount?: number;
272
+ /** The count of subgroups with updates in progress. */
273
+ subgroupsWithUpdatesInProgressCount?: number;
274
+ /** The count of subgroups with devices on the latest update. */
275
+ subgroupsWithOnLatestUpdateCount?: number;
276
+ /** The active deployment Ids for the group */
277
+ deployments?: Array<string>;
278
+ }
279
+ export interface DeviceClassSubgroupUpdatableDevicesListOutput {
280
+ /** The collection of pageable items. */
281
+ value: Array<DeviceClassSubgroupUpdatableDevicesOutput>;
282
+ /** The link to the next page of items. */
283
+ nextLink?: string;
284
+ }
285
+ export interface DeviceClassSubgroupUpdatableDevicesOutput {
286
+ /** The group Id */
287
+ groupId: string;
288
+ /** The device class subgroup's device class Id */
289
+ deviceClassId: string;
290
+ /** Update information. */
291
+ update: UpdateInfoOutput;
292
+ /** Total number of devices for which the update is applicable. */
293
+ deviceCount: number;
294
+ }
295
+ export interface DeploymentsListOutput {
296
+ /** The collection of pageable items. */
297
+ value: Array<DeploymentOutput>;
298
+ /** The link to the next page of items. */
299
+ nextLink?: string;
300
+ }
301
+ export interface DeploymentOutput {
302
+ /** The caller-provided deployment identifier. This cannot be longer than 73 characters, must be all lower-case, and cannot contain '&', '^', '[', ']', '{', '}', '|', '<', '>', forward slash, backslash, or double quote. The Updates view in the Azure Portal IoT Hub resource generates a GUID for deploymentId when you create a deployment. */
303
+ deploymentId: string;
304
+ /** The deployment start datetime. */
305
+ startDateTime: string;
306
+ /** Update information for the update in the deployment. */
307
+ update: UpdateInfoOutput;
308
+ /** The group identity for the devices the deployment is intended to update. */
309
+ groupId: string;
310
+ /** The device class subgroups the deployment is compatible with and subgroup deployments have been created for. This is not provided by the caller during CreateOrUpdateDeployment but is automatically determined by Device Update */
311
+ deviceClassSubgroups?: Array<string>;
312
+ /** Boolean flag indicating whether the deployment was canceled. */
313
+ isCanceled?: boolean;
314
+ /** Boolean flag indicating whether the deployment has been retried. */
315
+ isRetried?: boolean;
316
+ /** The rollback policy for the deployment. */
317
+ rollbackPolicy?: CloudInitiatedRollbackPolicyOutput;
318
+ /** Boolean flag indicating whether the deployment is a rollback deployment. */
319
+ isCloudInitiatedRollback?: boolean;
320
+ }
321
+ export interface CloudInitiatedRollbackPolicyOutput {
322
+ /** Update to rollback to. */
323
+ update: UpdateInfoOutput;
324
+ /** Failure conditions to initiate rollback policy. */
325
+ failure: CloudInitiatedRollbackPolicyFailureOutput;
326
+ }
327
+ export interface CloudInitiatedRollbackPolicyFailureOutput {
328
+ /** Percentage of devices that failed. */
329
+ devicesFailedPercentage: number;
330
+ /** Number of devices that failed. */
331
+ devicesFailedCount: number;
332
+ }
333
+ export interface DeploymentStatusOutput {
334
+ /** The group identity */
335
+ groupId: string;
336
+ /** The state of the deployment. */
337
+ deploymentState: "Active" | "ActiveWithSubgroupFailures" | "Failed" | "Inactive" | "Canceled";
338
+ /** The error details of the Failed state. This is not present if the deployment state is not Failed. */
339
+ error?: ErrorModelOutput;
340
+ /** The collection of device class subgroup status objects */
341
+ subgroupStatus: Array<DeviceClassSubgroupDeploymentStatusOutput>;
342
+ }
343
+ export interface DeviceClassSubgroupDeploymentStatusOutput {
344
+ /** The group identity */
345
+ groupId: string;
346
+ /** The device class subgroup identity */
347
+ deviceClassId: string;
348
+ /** The state of the subgroup deployment. */
349
+ deploymentState: "Active" | "Failed" | "Inactive" | "Canceled";
350
+ /** The error details of the Failed state. This is not present if the deployment state is not Failed. */
351
+ error?: ErrorModelOutput;
352
+ /** The total number of devices in the deployment. */
353
+ totalDevices?: number;
354
+ /** The number of devices that are currently in deployment. */
355
+ devicesInProgressCount?: number;
356
+ /** The number of devices that have completed deployment with a failure. */
357
+ devicesCompletedFailedCount?: number;
358
+ /** The number of devices which have successfully completed deployment. */
359
+ devicesCompletedSucceededCount?: number;
360
+ /** The number of devices which have had their deployment canceled. */
361
+ devicesCanceledCount?: number;
362
+ }
363
+ export interface DeviceClassSubgroupsListOutput {
364
+ /** The collection of pageable items. */
365
+ value: Array<DeviceClassSubgroupOutput>;
366
+ /** The link to the next page of items. */
367
+ nextLink?: string;
368
+ }
369
+ export interface DeviceClassSubgroupOutput {
370
+ /** Device class subgroup identity. This is generated from the model Id and the compat properties reported by the device update agent in the Device Update PnP interface in IoT Hub. It is a hex-encoded SHA1 hash. */
371
+ deviceClassId: string;
372
+ /** Group identity. */
373
+ groupId: string;
374
+ /** Date and time when the device class subgroup was created. */
375
+ createdDateTime: string;
376
+ /** The number of devices in the device class subgroup. */
377
+ deviceCount?: number;
378
+ /** The active deployment Id for the device class subgroup. */
379
+ deploymentId?: string;
380
+ }
381
+ export interface DeploymentDeviceStatesListOutput {
382
+ /** The collection of pageable items. */
383
+ value: Array<DeploymentDeviceStateOutput>;
384
+ /** The link to the next page of items. */
385
+ nextLink?: string;
386
+ }
387
+ export interface DeploymentDeviceStateOutput {
388
+ /** Device identity. */
389
+ deviceId: string;
390
+ /** Device module identity. */
391
+ moduleId?: string;
392
+ /** The number of times this deployment has been retried on this device. */
393
+ retryCount: number;
394
+ /** Boolean flag indicating whether this device is in a newer deployment and can no longer retry this deployment. */
395
+ movedOnToNewDeployment: boolean;
396
+ /** Deployment device state. */
397
+ deviceState: "Succeeded" | "InProgress" | "Canceled" | "Failed";
398
+ }
399
+ export interface DeviceOperationOutput {
400
+ /** Operation Id. */
401
+ operationId: string;
402
+ /** Operation status. */
403
+ status: "NotStarted" | "Running" | "Succeeded" | "Failed";
404
+ /** Operation error encountered, if any. */
405
+ error?: ErrorModelOutput;
406
+ /** Operation correlation identity that can used by Microsoft Support for troubleshooting. */
407
+ traceId?: string;
408
+ /** Date and time in UTC when the operation status was last updated. */
409
+ lastActionDateTime: string;
410
+ /** Date and time in UTC when the operation was created. */
411
+ createdDateTime: string;
412
+ /** Operation ETag. */
413
+ etag?: string;
414
+ }
415
+ export interface DeviceOperationsListOutput {
416
+ /** The collection of pageable items. */
417
+ value: Array<DeviceOperationOutput>;
418
+ /** The link to the next page of items. */
419
+ nextLink?: string;
420
+ }
421
+ export interface LogCollectionOutput {
422
+ /** The log collection id. */
423
+ operationId?: string;
424
+ /** Array of Device Update agent ids */
425
+ deviceList: Array<DeviceUpdateAgentIdOutput>;
426
+ /** Description of the diagnostics operation. */
427
+ description?: string;
428
+ /** The timestamp when the operation was created. */
429
+ createdDateTime?: string;
430
+ /** A timestamp for when the current state was entered. */
431
+ lastActionDateTime?: string;
432
+ /** Operation status. */
433
+ status?: "NotStarted" | "Running" | "Succeeded" | "Failed";
434
+ }
435
+ export interface DeviceUpdateAgentIdOutput {
436
+ /** Device Id */
437
+ deviceId: string;
438
+ /** Module Id */
439
+ moduleId?: string;
440
+ }
441
+ export interface LogCollectionListOutput {
442
+ /** The collection of pageable items. */
443
+ value: Array<LogCollectionOutput>;
444
+ /** The link to the next page of items. */
445
+ nextLink?: string;
446
+ }
447
+ export interface LogCollectionOperationDetailedStatusOutput {
448
+ /** The device diagnostics operation id. */
449
+ operationId?: string;
450
+ /** The timestamp when the operation was created. */
451
+ createdDateTime?: string;
452
+ /** A timestamp for when the current state was entered. */
453
+ lastActionDateTime?: string;
454
+ /** Operation status. */
455
+ status?: "NotStarted" | "Running" | "Succeeded" | "Failed";
456
+ /** Status of the devices in the operation */
457
+ deviceStatus?: Array<LogCollectionOperationDeviceStatusOutput>;
458
+ /** Device diagnostics operation description. */
459
+ description?: string;
460
+ }
461
+ export interface LogCollectionOperationDeviceStatusOutput {
462
+ /** Device id */
463
+ deviceId: string;
464
+ /** Module id. */
465
+ moduleId?: string;
466
+ /** Log upload status */
467
+ status: "NotStarted" | "Running" | "Succeeded" | "Failed";
468
+ /** Log upload result code */
469
+ resultCode?: string;
470
+ /** Log upload extended result code */
471
+ extendedResultCode?: string;
472
+ /** Log upload location */
473
+ logLocation?: string;
474
+ }
475
+ export interface DeviceHealthListOutput {
476
+ /** The collection of pageable items. */
477
+ value: Array<DeviceHealthOutput>;
478
+ /** The link to the next page of items. */
479
+ nextLink?: string;
480
+ }
481
+ export interface DeviceHealthOutput {
482
+ /** Device id */
483
+ deviceId: string;
484
+ /** Module id */
485
+ moduleId?: string;
486
+ /** Aggregate device health state */
487
+ state: "healthy" | "unhealthy";
488
+ /** Digital twin model Id */
489
+ digitalTwinModelId?: string;
490
+ /** Array of health checks and their results */
491
+ healthChecks: Array<HealthCheckOutput>;
492
+ }
493
+ export interface HealthCheckOutput {
494
+ /** Health check name */
495
+ name?: string;
496
+ /** Health check result */
497
+ result?: "success" | "userError";
498
+ }
499
+ //# sourceMappingURL=outputModels.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"outputModels.d.ts","sourceRoot":"","sources":["../../src/outputModels.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,gBAAgB;IAC/B,wCAAwC;IACxC,KAAK,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAC3B,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,YAAY;IAC3B,uBAAuB;IACvB,QAAQ,EAAE,cAAc,CAAC;IACzB,+CAA+C;IAC/C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kDAAkD;IAClD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iEAAiE;IACjE,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,gEAAgE;IAChE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,qJAAqJ;IACrJ,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,gDAAgD;IAChD,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAC7C,mCAAmC;IACnC,YAAY,CAAC,EAAE,kBAAkB,CAAC;IAClC,4DAA4D;IAC5D,YAAY,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACrC,gFAAgF;IAChF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4DAA4D;IAC5D,eAAe,EAAE,MAAM,CAAC;IACxB,yDAAyD;IACzD,gBAAgB,EAAE,MAAM,CAAC;IACzB,wDAAwD;IACxD,eAAe,EAAE,MAAM,CAAC;IACxB,mBAAmB;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,uBAAuB;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,sBAAsB;IACtB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC,wCAAwC;IACxC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAC1B;AAED,MAAM,WAAW,UAAU;IACzB,iBAAiB;IACjB,IAAI,CAAC,EAAE,QAAQ,GAAG,WAAW,CAAC;IAC9B,wBAAwB;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,wFAAwF;IACxF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,2DAA2D;IAC3D,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC5C,0GAA0G;IAC1G,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACtB,6EAA6E;IAC7E,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC3B;AAED,MAAM,WAAW,mBAAmB;IAClC,yBAAyB;IACzB,KAAK,EAAE,gBAAgB,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,oDAAoD;IACpD,OAAO,EAAE,MAAM,CAAC;IAChB,+BAA+B;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,yDAAyD;IACzD,OAAO,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAClC,8FAA8F;IAC9F,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B,oDAAoD;IACpD,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,gBAAgB;IAC/B,iFAAiF;IACjF,IAAI,EAAE,MAAM,CAAC;IACb,oDAAoD;IACpD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,+CAA+C;IAC/C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,8FAA8F;IAC9F,UAAU,CAAC,EAAE,gBAAgB,CAAC;CAC/B;AAED,MAAM,WAAW,iBAAiB;IAChC,wCAAwC;IACxC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACrB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,gBAAiB,SAAQ,oBAAoB;IAC5D,yDAAyD;IACzD,MAAM,EAAE,MAAM,CAAC;IACf,uGAAuG;IACvG,YAAY,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAC3C,sFAAsF;IACtF,eAAe,CAAC,EAAE,+BAA+B,CAAC;IAClD,iBAAiB;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC,iBAAiB;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,oCAAoC;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,kEAAkE;IAClE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,sBAAsB;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gCAAgC;IAChC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iCAAiC;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qFAAqF;IACrF,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACrC;AAED,MAAM,WAAW,+BAA+B;IAC9C,mCAAmC;IACnC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,0BAA0B;IACzC,wCAAwC;IACxC,KAAK,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACpC,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC,oBAAoB;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,wBAAwB;IACxB,MAAM,EAAE,YAAY,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAC1D,8IAA8I;IAC9I,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,oEAAoE;IACpE,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,2CAA2C;IAC3C,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB,6FAA6F;IAC7F,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,uEAAuE;IACvE,kBAAkB,EAAE,MAAM,CAAC;IAC3B,2DAA2D;IAC3D,eAAe,EAAE,MAAM,CAAC;IACxB,sBAAsB;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gBAAgB;IAC/B,yBAAyB;IACzB,QAAQ,EAAE,cAAc,CAAC;IACzB,0BAA0B;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,4BAA4B;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,uBAAuB;IACtC,wCAAwC;IACxC,KAAK,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAChC,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC,mNAAmN;IACnN,aAAa,EAAE,MAAM,CAAC;IACtB,4HAA4H;IAC5H,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iFAAiF;IACjF,qBAAqB,EAAE,2BAA2B,CAAC;IACnD,4EAA4E;IAC5E,oBAAoB,CAAC,EAAE,gBAAgB,CAAC;CACzC;AAED,MAAM,WAAW,2BAA2B;IAC1C,8CAA8C;IAC9C,aAAa,CAAC,EAAE,mBAAmB,CAAC;IACpC,6QAA6Q;IAC7Q,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,mBAAmB;IAClC,yHAAyH;IACzH,EAAE,EAAE,MAAM,CAAC;IACX,qIAAqI;IACrI,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oBAAoB;IACnC,wCAAwC;IACxC,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAC/B,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC,wCAAwC;IACxC,KAAK,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAC3B,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,YAAY;IAC3B,uBAAuB;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,8BAA8B;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6BAA6B;IAC7B,aAAa,EAAE,MAAM,CAAC;IACtB,6BAA6B;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,wDAAwD;IACxD,mBAAmB,CAAC,EAAE,gBAAgB,CAAC;IACvC,kDAAkD;IAClD,gBAAgB,CAAC,EAAE,WAAW,GAAG,YAAY,GAAG,UAAU,GAAG,QAAQ,CAAC;IACtE,4CAA4C;IAC5C,eAAe,CAAC,EAAE,gBAAgB,CAAC;IACnC,wJAAwJ;IACxJ,cAAc,EAAE,OAAO,CAAC;IACxB,sEAAsE;IACtE,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,2BAA2B;IAC3B,iBAAiB,CAAC,EAAE,mBAAmB,CAAC;CACzC;AAED,MAAM,WAAW,mBAAmB;IAClC,2BAA2B;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,mCAAmC;IACnC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,mEAAmE;IACnE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,4BAA4B;IAC5B,WAAW,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;CACvC;AAED,MAAM,WAAW,gBAAgB;IAC/B,qEAAqE;IACrE,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,wBAAwB;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2BAA2B;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,mCAAmC;IACnC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,mEAAmE;IACnE,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,sBAAsB;IACrC,+BAA+B;IAC/B,gBAAgB,EAAE,MAAM,CAAC;IACzB,8CAA8C;IAC9C,yBAAyB,EAAE,MAAM,CAAC;IAClC,uDAAuD;IACvD,8BAA8B,EAAE,MAAM,CAAC;IACvC,iDAAiD;IACjD,4BAA4B,EAAE,MAAM,CAAC;CACtC;AAED,MAAM,WAAW,gBAAgB;IAC/B,wCAAwC;IACxC,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAC1B,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,WAAW;IAC1B,kJAAkJ;IAClJ,OAAO,EAAE,MAAM,CAAC;IAChB,kBAAkB;IAClB,SAAS,EAAE,WAAW,GAAG,cAAc,CAAC;IACxC,iDAAiD;IACjD,eAAe,EAAE,MAAM,CAAC;IACxB,0CAA0C;IAC1C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yDAAyD;IACzD,qCAAqC,CAAC,EAAE,MAAM,CAAC;IAC/C,uDAAuD;IACvD,mCAAmC,CAAC,EAAE,MAAM,CAAC;IAC7C,gEAAgE;IAChE,gCAAgC,CAAC,EAAE,MAAM,CAAC;IAC1C,8CAA8C;IAC9C,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,6CAA6C;IAC5D,wCAAwC;IACxC,KAAK,EAAE,KAAK,CAAC,yCAAyC,CAAC,CAAC;IACxD,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,yCAAyC;IACxD,mBAAmB;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,kDAAkD;IAClD,aAAa,EAAE,MAAM,CAAC;IACtB,0BAA0B;IAC1B,MAAM,EAAE,gBAAgB,CAAC;IACzB,kEAAkE;IAClE,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC,wCAAwC;IACxC,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAC/B,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,gBAAgB;IAC/B,oVAAoV;IACpV,YAAY,EAAE,MAAM,CAAC;IACrB,qCAAqC;IACrC,aAAa,EAAE,MAAM,CAAC;IACtB,2DAA2D;IAC3D,MAAM,EAAE,gBAAgB,CAAC;IACzB,+EAA+E;IAC/E,OAAO,EAAE,MAAM,CAAC;IAChB,uOAAuO;IACvO,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACrC,mEAAmE;IACnE,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,uEAAuE;IACvE,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,8CAA8C;IAC9C,cAAc,CAAC,EAAE,kCAAkC,CAAC;IACpD,+EAA+E;IAC/E,wBAAwB,CAAC,EAAE,OAAO,CAAC;CACpC;AAED,MAAM,WAAW,kCAAkC;IACjD,6BAA6B;IAC7B,MAAM,EAAE,gBAAgB,CAAC;IACzB,sDAAsD;IACtD,OAAO,EAAE,yCAAyC,CAAC;CACpD;AAED,MAAM,WAAW,yCAAyC;IACxD,yCAAyC;IACzC,uBAAuB,EAAE,MAAM,CAAC;IAChC,qCAAqC;IACrC,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,sBAAsB;IACrC,yBAAyB;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,mCAAmC;IACnC,eAAe,EAAE,QAAQ,GAAG,4BAA4B,GAAG,QAAQ,GAAG,UAAU,GAAG,UAAU,CAAC;IAC9F,yGAAyG;IACzG,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB,6DAA6D;IAC7D,cAAc,EAAE,KAAK,CAAC,yCAAyC,CAAC,CAAC;CAClE;AAED,MAAM,WAAW,yCAAyC;IACxD,yBAAyB;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,yCAAyC;IACzC,aAAa,EAAE,MAAM,CAAC;IACtB,4CAA4C;IAC5C,eAAe,EAAE,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,UAAU,CAAC;IAC/D,yGAAyG;IACzG,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB,qDAAqD;IACrD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,8DAA8D;IAC9D,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,2EAA2E;IAC3E,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC,0EAA0E;IAC1E,8BAA8B,CAAC,EAAE,MAAM,CAAC;IACxC,sEAAsE;IACtE,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,MAAM,WAAW,8BAA8B;IAC7C,wCAAwC;IACxC,KAAK,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAC;IACxC,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,yBAAyB;IACxC,sNAAsN;IACtN,aAAa,EAAE,MAAM,CAAC;IACtB,sBAAsB;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,gEAAgE;IAChE,eAAe,EAAE,MAAM,CAAC;IACxB,0DAA0D;IAC1D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,8DAA8D;IAC9D,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,gCAAgC;IAC/C,wCAAwC;IACxC,KAAK,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC1C,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,2BAA2B;IAC1C,uBAAuB;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,8BAA8B;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,2EAA2E;IAC3E,UAAU,EAAE,MAAM,CAAC;IACnB,oHAAoH;IACpH,sBAAsB,EAAE,OAAO,CAAC;IAChC,+BAA+B;IAC/B,WAAW,EAAE,WAAW,GAAG,YAAY,GAAG,UAAU,GAAG,QAAQ,CAAC;CACjE;AAED,MAAM,WAAW,qBAAqB;IACpC,oBAAoB;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,wBAAwB;IACxB,MAAM,EAAE,YAAY,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAC1D,2CAA2C;IAC3C,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB,6FAA6F;IAC7F,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,uEAAuE;IACvE,kBAAkB,EAAE,MAAM,CAAC;IAC3B,2DAA2D;IAC3D,eAAe,EAAE,MAAM,CAAC;IACxB,sBAAsB;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,0BAA0B;IACzC,wCAAwC;IACxC,KAAK,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACpC,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,mBAAmB;IAClC,6BAA6B;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uCAAuC;IACvC,UAAU,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,gDAAgD;IAChD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oDAAoD;IACpD,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,0DAA0D;IAC1D,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,wBAAwB;IACxB,MAAM,CAAC,EAAE,YAAY,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;CAC5D;AAED,MAAM,WAAW,yBAAyB;IACxC,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,uBAAuB;IACtC,wCAAwC;IACxC,KAAK,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAClC,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,0CAA0C;IACzD,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oDAAoD;IACpD,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,0DAA0D;IAC1D,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,wBAAwB;IACxB,MAAM,CAAC,EAAE,YAAY,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAC3D,6CAA6C;IAC7C,YAAY,CAAC,EAAE,KAAK,CAAC,wCAAwC,CAAC,CAAC;IAC/D,gDAAgD;IAChD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,wCAAwC;IACvD,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wBAAwB;IACxB,MAAM,EAAE,YAAY,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAC1D,6BAA6B;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,sCAAsC;IACtC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,0BAA0B;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,sBAAsB;IACrC,wCAAwC;IACxC,KAAK,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACjC,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oCAAoC;IACpC,KAAK,EAAE,SAAS,GAAG,WAAW,CAAC;IAC/B,4BAA4B;IAC5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,+CAA+C;IAC/C,YAAY,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;CACxC;AAED,MAAM,WAAW,iBAAiB;IAChC,wBAAwB;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,0BAA0B;IAC1B,MAAM,CAAC,EAAE,SAAS,GAAG,WAAW,CAAC;CAClC"}
@@ -0,0 +1,4 @@
1
+ // Copyright (c) Microsoft Corporation.
2
+ // Licensed under the MIT License.
3
+ export {};
4
+ //# sourceMappingURL=outputModels.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"outputModels.js","sourceRoot":"","sources":["../../src/outputModels.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nexport interface UpdateListOutput {\n /** The collection of pageable items. */\n value: Array<UpdateOutput>;\n /** The link to the next page of items. */\n nextLink?: string;\n}\n\nexport interface UpdateOutput {\n /** Update identity. */\n updateId: UpdateIdOutput;\n /** Update description specified by creator. */\n description?: string;\n /** Friendly update name specified by importer. */\n friendlyName?: string;\n /** Whether the update can be deployed to a device on its own. */\n isDeployable?: boolean;\n /** Update type. Deprecated in latest import manifest schema. */\n updateType?: string;\n /** String interpreted by Device Update client to determine if the update is installed on the device. Deprecated in latest import manifest schema. */\n installedCriteria?: string;\n /** List of update compatibility information. */\n compatibility: Array<Record<string, string>>;\n /** Update install instructions. */\n instructions?: InstructionsOutput;\n /** List of update identities that reference this update. */\n referencedBy?: Array<UpdateIdOutput>;\n /** Update aggregate scan result (calculated from payload file scan results). */\n scanResult?: string;\n /** Schema version of manifest used to import the update. */\n manifestVersion: string;\n /** Date and time in UTC when the update was imported. */\n importedDateTime: string;\n /** Date and time in UTC when the update was created. */\n createdDateTime: string;\n /** Update ETag. */\n etag?: string;\n}\n\nexport interface UpdateIdOutput {\n /** Update provider. */\n provider: string;\n /** Update name. */\n name: string;\n /** Update version. */\n version: string;\n}\n\nexport interface InstructionsOutput {\n /** Collection of installation steps. */\n steps: Array<StepOutput>;\n}\n\nexport interface StepOutput {\n /** Step type. */\n type?: \"Inline\" | \"Reference\";\n /** Step description. */\n description?: string;\n /** Identity of handler that will execute this step. Required if step type is inline. */\n handler?: string;\n /** Parameters to be passed to handler during execution. */\n handlerProperties?: Record<string, unknown>;\n /** Collection of file names to be passed to handler during execution. Required if step type is inline. */\n files?: Array<string>;\n /** Referenced child update identity. Required if step type is reference. */\n updateId?: UpdateIdOutput;\n}\n\nexport interface ErrorResponseOutput {\n /** The error details. */\n error: ErrorModelOutput;\n}\n\nexport interface ErrorModelOutput {\n /** Server defined error code. */\n code: string;\n /** A human-readable representation of the error. */\n message: string;\n /** The target of the error. */\n target?: string;\n /** An array of errors that led to the reported error. */\n details?: Array<ErrorModelOutput>;\n /** An object containing more specific information than the current object about the error. */\n innererror?: InnerErrorOutput;\n /** Date and time in UTC when the error occurred. */\n occurredDateTime?: string;\n}\n\nexport interface InnerErrorOutput {\n /** A more specific error code than what was provided by the containing error. */\n code: string;\n /** A human-readable representation of the error. */\n message?: string;\n /** The internal error or exception message. */\n errorDetail?: string;\n /** An object containing more specific information than the current object about the error. */\n innerError?: InnerErrorOutput;\n}\n\nexport interface StringsListOutput {\n /** The collection of pageable items. */\n value: Array<string>;\n /** The link to the next page of items. */\n nextLink?: string;\n}\n\nexport interface UpdateFileOutput extends UpdateFileBaseOutput {\n /** File identity, generated by server at import time. */\n fileId: string;\n /** Optional related files metadata used together DownloadHandler metadata to download payload file. */\n relatedFiles?: Array<UpdateFileBaseOutput>;\n /** Optional download handler for utilizing related files to download payload file. */\n downloadHandler?: UpdateFileDownloadHandlerOutput;\n /** File ETag. */\n etag?: string;\n}\n\nexport interface UpdateFileBaseOutput {\n /** File name. */\n fileName: string;\n /** File size in number of bytes. */\n sizeInBytes: number;\n /** Mapping of hashing algorithm to base64 encoded hash values. */\n hashes: Record<string, string>;\n /** File MIME type. */\n mimeType?: string;\n /** Anti-malware scan result. */\n scanResult?: string;\n /** Anti-malware scan details. */\n scanDetails?: string;\n /** Optional file properties (not consumed by service but pass-through to device). */\n properties?: Record<string, string>;\n}\n\nexport interface UpdateFileDownloadHandlerOutput {\n /** Download handler identifier. */\n id: string;\n}\n\nexport interface UpdateOperationsListOutput {\n /** The collection of pageable items. */\n value: Array<UpdateOperationOutput>;\n /** The link to the next page of items. */\n nextLink?: string;\n}\n\nexport interface UpdateOperationOutput {\n /** Operation Id. */\n operationId: string;\n /** Operation status. */\n status: \"NotStarted\" | \"Running\" | \"Succeeded\" | \"Failed\";\n /** The update being imported or deleted. For import, this property will only be populated after import manifest is processed successfully. */\n update?: UpdateInfoOutput;\n /** Location of the imported update when operation is successful. */\n resourceLocation?: string;\n /** Operation error encountered, if any. */\n error?: ErrorModelOutput;\n /** Operation correlation identity that can used by Microsoft Support for troubleshooting. */\n traceId?: string;\n /** Date and time in UTC when the operation status was last updated. */\n lastActionDateTime: string;\n /** Date and time in UTC when the operation was created. */\n createdDateTime: string;\n /** Operation ETag. */\n etag?: string;\n}\n\nexport interface UpdateInfoOutput {\n /** Update identifier. */\n updateId: UpdateIdOutput;\n /** Update description. */\n description?: string;\n /** Friendly update name. */\n friendlyName?: string;\n}\n\nexport interface DeviceClassesListOutput {\n /** The collection of pageable items. */\n value: Array<DeviceClassOutput>;\n /** The link to the next page of items. */\n nextLink?: string;\n}\n\nexport interface DeviceClassOutput {\n /** The device class identifier. This is generated from the model Id and the compat properties reported by the device update agent in the Device Update PnP interface in IoT Hub. It is a hex-encoded SHA1 hash. */\n deviceClassId: string;\n /** The device class friendly name. This can be updated by callers after the device class has been automatically created. */\n friendlyName?: string;\n /** The device class properties that are used to calculate the device class Id */\n deviceClassProperties: DeviceClassPropertiesOutput;\n /** Update that is the highest version compatible with this device class. */\n bestCompatibleUpdate?: UpdateInfoOutput;\n}\n\nexport interface DeviceClassPropertiesOutput {\n /** The Device Update agent contract model. */\n contractModel?: ContractModelOutput;\n /** The compat properties of the device class. This object can be thought of as a set of key-value pairs where the key is the name of the compatibility property and the value is the value of the compatibility property. There will always be at least 1 compat property */\n compatProperties: Record<string, string>;\n}\n\nexport interface ContractModelOutput {\n /** The Device Update agent contract model Id of the device class. This is also used to calculate the device class Id. */\n id: string;\n /** The Device Update agent contract model name of the device class. Intended to be a more readable form of the contract model Id. */\n name: string;\n}\n\nexport interface UpdateInfoListOutput {\n /** The collection of pageable items. */\n value: Array<UpdateInfoOutput>;\n /** The link to the next page of items. */\n nextLink?: string;\n}\n\nexport interface DevicesListOutput {\n /** The collection of pageable items. */\n value: Array<DeviceOutput>;\n /** The link to the next page of items. */\n nextLink?: string;\n}\n\nexport interface DeviceOutput {\n /** Device identity. */\n deviceId: string;\n /** Device module identity. */\n moduleId?: string;\n /** Device class identity. */\n deviceClassId: string;\n /** Device group identity. */\n groupId?: string;\n /** The update that device last attempted to install. */\n lastAttemptedUpdate?: UpdateInfoOutput;\n /** State of the device in its last deployment. */\n deploymentStatus?: \"Succeeded\" | \"InProgress\" | \"Canceled\" | \"Failed\";\n /** Currently installed update on device. */\n installedUpdate?: UpdateInfoOutput;\n /** Boolean flag indicating whether the latest update (the best compatible update for the device's device class and group) is installed on the device */\n onLatestUpdate: boolean;\n /** The deployment identifier for the last deployment to the device */\n lastDeploymentId?: string;\n /** Last install result. */\n lastInstallResult?: InstallResultOutput;\n}\n\nexport interface InstallResultOutput {\n /** Install result code. */\n resultCode: number;\n /** Install extended result code */\n extendedResultCode: number;\n /** A string containing further details about the install result */\n resultDetails?: string;\n /** Array of step results */\n stepResults?: Array<StepResultOutput>;\n}\n\nexport interface StepResultOutput {\n /** The update that this step installs if it is of reference type. */\n update?: UpdateInfoOutput;\n /** Step description. */\n description?: string;\n /** Install result code. */\n resultCode: number;\n /** Install extended result code */\n extendedResultCode: number;\n /** A string containing further details about the install result */\n resultDetails?: string;\n}\n\nexport interface UpdateComplianceOutput {\n /** Total number of devices. */\n totalDeviceCount: number;\n /** Number of devices on the latest update. */\n onLatestUpdateDeviceCount: number;\n /** Number of devices with a newer update available. */\n newUpdatesAvailableDeviceCount: number;\n /** Number of devices with update in-progress. */\n updatesInProgressDeviceCount: number;\n}\n\nexport interface GroupsListOutput {\n /** The collection of pageable items. */\n value: Array<GroupOutput>;\n /** The link to the next page of items. */\n nextLink?: string;\n}\n\nexport interface GroupOutput {\n /** Group identity. This is created from the value of the ADUGroup tag in the Iot Hub's device/module twin or $default for devices with no tag. */\n groupId: string;\n /** Group type. */\n groupType: \"IoTHubTag\" | \"DefaultNoTag\";\n /** Date and time when the update was created. */\n createdDateTime: string;\n /** The number of devices in the group. */\n deviceCount?: number;\n /** The count of subgroups with new updates available. */\n subgroupsWithNewUpdatesAvailableCount?: number;\n /** The count of subgroups with updates in progress. */\n subgroupsWithUpdatesInProgressCount?: number;\n /** The count of subgroups with devices on the latest update. */\n subgroupsWithOnLatestUpdateCount?: number;\n /** The active deployment Ids for the group */\n deployments?: Array<string>;\n}\n\nexport interface DeviceClassSubgroupUpdatableDevicesListOutput {\n /** The collection of pageable items. */\n value: Array<DeviceClassSubgroupUpdatableDevicesOutput>;\n /** The link to the next page of items. */\n nextLink?: string;\n}\n\nexport interface DeviceClassSubgroupUpdatableDevicesOutput {\n /** The group Id */\n groupId: string;\n /** The device class subgroup's device class Id */\n deviceClassId: string;\n /** Update information. */\n update: UpdateInfoOutput;\n /** Total number of devices for which the update is applicable. */\n deviceCount: number;\n}\n\nexport interface DeploymentsListOutput {\n /** The collection of pageable items. */\n value: Array<DeploymentOutput>;\n /** The link to the next page of items. */\n nextLink?: string;\n}\n\nexport interface DeploymentOutput {\n /** The caller-provided deployment identifier. This cannot be longer than 73 characters, must be all lower-case, and cannot contain '&', '^', '[', ']', '{', '}', '|', '<', '>', forward slash, backslash, or double quote. The Updates view in the Azure Portal IoT Hub resource generates a GUID for deploymentId when you create a deployment. */\n deploymentId: string;\n /** The deployment start datetime. */\n startDateTime: string;\n /** Update information for the update in the deployment. */\n update: UpdateInfoOutput;\n /** The group identity for the devices the deployment is intended to update. */\n groupId: string;\n /** The device class subgroups the deployment is compatible with and subgroup deployments have been created for. This is not provided by the caller during CreateOrUpdateDeployment but is automatically determined by Device Update */\n deviceClassSubgroups?: Array<string>;\n /** Boolean flag indicating whether the deployment was canceled. */\n isCanceled?: boolean;\n /** Boolean flag indicating whether the deployment has been retried. */\n isRetried?: boolean;\n /** The rollback policy for the deployment. */\n rollbackPolicy?: CloudInitiatedRollbackPolicyOutput;\n /** Boolean flag indicating whether the deployment is a rollback deployment. */\n isCloudInitiatedRollback?: boolean;\n}\n\nexport interface CloudInitiatedRollbackPolicyOutput {\n /** Update to rollback to. */\n update: UpdateInfoOutput;\n /** Failure conditions to initiate rollback policy. */\n failure: CloudInitiatedRollbackPolicyFailureOutput;\n}\n\nexport interface CloudInitiatedRollbackPolicyFailureOutput {\n /** Percentage of devices that failed. */\n devicesFailedPercentage: number;\n /** Number of devices that failed. */\n devicesFailedCount: number;\n}\n\nexport interface DeploymentStatusOutput {\n /** The group identity */\n groupId: string;\n /** The state of the deployment. */\n deploymentState: \"Active\" | \"ActiveWithSubgroupFailures\" | \"Failed\" | \"Inactive\" | \"Canceled\";\n /** The error details of the Failed state. This is not present if the deployment state is not Failed. */\n error?: ErrorModelOutput;\n /** The collection of device class subgroup status objects */\n subgroupStatus: Array<DeviceClassSubgroupDeploymentStatusOutput>;\n}\n\nexport interface DeviceClassSubgroupDeploymentStatusOutput {\n /** The group identity */\n groupId: string;\n /** The device class subgroup identity */\n deviceClassId: string;\n /** The state of the subgroup deployment. */\n deploymentState: \"Active\" | \"Failed\" | \"Inactive\" | \"Canceled\";\n /** The error details of the Failed state. This is not present if the deployment state is not Failed. */\n error?: ErrorModelOutput;\n /** The total number of devices in the deployment. */\n totalDevices?: number;\n /** The number of devices that are currently in deployment. */\n devicesInProgressCount?: number;\n /** The number of devices that have completed deployment with a failure. */\n devicesCompletedFailedCount?: number;\n /** The number of devices which have successfully completed deployment. */\n devicesCompletedSucceededCount?: number;\n /** The number of devices which have had their deployment canceled. */\n devicesCanceledCount?: number;\n}\n\nexport interface DeviceClassSubgroupsListOutput {\n /** The collection of pageable items. */\n value: Array<DeviceClassSubgroupOutput>;\n /** The link to the next page of items. */\n nextLink?: string;\n}\n\nexport interface DeviceClassSubgroupOutput {\n /** Device class subgroup identity. This is generated from the model Id and the compat properties reported by the device update agent in the Device Update PnP interface in IoT Hub. It is a hex-encoded SHA1 hash. */\n deviceClassId: string;\n /** Group identity. */\n groupId: string;\n /** Date and time when the device class subgroup was created. */\n createdDateTime: string;\n /** The number of devices in the device class subgroup. */\n deviceCount?: number;\n /** The active deployment Id for the device class subgroup. */\n deploymentId?: string;\n}\n\nexport interface DeploymentDeviceStatesListOutput {\n /** The collection of pageable items. */\n value: Array<DeploymentDeviceStateOutput>;\n /** The link to the next page of items. */\n nextLink?: string;\n}\n\nexport interface DeploymentDeviceStateOutput {\n /** Device identity. */\n deviceId: string;\n /** Device module identity. */\n moduleId?: string;\n /** The number of times this deployment has been retried on this device. */\n retryCount: number;\n /** Boolean flag indicating whether this device is in a newer deployment and can no longer retry this deployment. */\n movedOnToNewDeployment: boolean;\n /** Deployment device state. */\n deviceState: \"Succeeded\" | \"InProgress\" | \"Canceled\" | \"Failed\";\n}\n\nexport interface DeviceOperationOutput {\n /** Operation Id. */\n operationId: string;\n /** Operation status. */\n status: \"NotStarted\" | \"Running\" | \"Succeeded\" | \"Failed\";\n /** Operation error encountered, if any. */\n error?: ErrorModelOutput;\n /** Operation correlation identity that can used by Microsoft Support for troubleshooting. */\n traceId?: string;\n /** Date and time in UTC when the operation status was last updated. */\n lastActionDateTime: string;\n /** Date and time in UTC when the operation was created. */\n createdDateTime: string;\n /** Operation ETag. */\n etag?: string;\n}\n\nexport interface DeviceOperationsListOutput {\n /** The collection of pageable items. */\n value: Array<DeviceOperationOutput>;\n /** The link to the next page of items. */\n nextLink?: string;\n}\n\nexport interface LogCollectionOutput {\n /** The log collection id. */\n operationId?: string;\n /** Array of Device Update agent ids */\n deviceList: Array<DeviceUpdateAgentIdOutput>;\n /** Description of the diagnostics operation. */\n description?: string;\n /** The timestamp when the operation was created. */\n createdDateTime?: string;\n /** A timestamp for when the current state was entered. */\n lastActionDateTime?: string;\n /** Operation status. */\n status?: \"NotStarted\" | \"Running\" | \"Succeeded\" | \"Failed\";\n}\n\nexport interface DeviceUpdateAgentIdOutput {\n /** Device Id */\n deviceId: string;\n /** Module Id */\n moduleId?: string;\n}\n\nexport interface LogCollectionListOutput {\n /** The collection of pageable items. */\n value: Array<LogCollectionOutput>;\n /** The link to the next page of items. */\n nextLink?: string;\n}\n\nexport interface LogCollectionOperationDetailedStatusOutput {\n /** The device diagnostics operation id. */\n operationId?: string;\n /** The timestamp when the operation was created. */\n createdDateTime?: string;\n /** A timestamp for when the current state was entered. */\n lastActionDateTime?: string;\n /** Operation status. */\n status?: \"NotStarted\" | \"Running\" | \"Succeeded\" | \"Failed\";\n /** Status of the devices in the operation */\n deviceStatus?: Array<LogCollectionOperationDeviceStatusOutput>;\n /** Device diagnostics operation description. */\n description?: string;\n}\n\nexport interface LogCollectionOperationDeviceStatusOutput {\n /** Device id */\n deviceId: string;\n /** Module id. */\n moduleId?: string;\n /** Log upload status */\n status: \"NotStarted\" | \"Running\" | \"Succeeded\" | \"Failed\";\n /** Log upload result code */\n resultCode?: string;\n /** Log upload extended result code */\n extendedResultCode?: string;\n /** Log upload location */\n logLocation?: string;\n}\n\nexport interface DeviceHealthListOutput {\n /** The collection of pageable items. */\n value: Array<DeviceHealthOutput>;\n /** The link to the next page of items. */\n nextLink?: string;\n}\n\nexport interface DeviceHealthOutput {\n /** Device id */\n deviceId: string;\n /** Module id */\n moduleId?: string;\n /** Aggregate device health state */\n state: \"healthy\" | \"unhealthy\";\n /** Digital twin model Id */\n digitalTwinModelId?: string;\n /** Array of health checks and their results */\n healthChecks: Array<HealthCheckOutput>;\n}\n\nexport interface HealthCheckOutput {\n /** Health check name */\n name?: string;\n /** Health check result */\n result?: \"success\" | \"userError\";\n}\n"]}
@@ -0,0 +1,3 @@
1
+ {
2
+ "type": "module"
3
+ }
@@ -0,0 +1,43 @@
1
+ import type { PagedAsyncIterableIterator } from "@azure/core-paging";
2
+ import type { Client, PathUncheckedResponse } from "@azure-rest/core-client";
3
+ /**
4
+ * Helper type to extract the type of an array
5
+ */
6
+ export type GetArrayType<T> = T extends Array<infer TData> ? TData : never;
7
+ /**
8
+ * The type of a custom function that defines how to get a page and a link to the next one if any.
9
+ */
10
+ export type GetPage<TPage> = (pageLink: string, maxPageSize?: number) => Promise<{
11
+ page: TPage;
12
+ nextPageLink?: string;
13
+ }>;
14
+ /**
15
+ * Options for the paging helper
16
+ */
17
+ export interface PagingOptions<TResponse> {
18
+ /**
19
+ * Custom function to extract pagination details for crating the PagedAsyncIterableIterator
20
+ */
21
+ customGetPage?: GetPage<PaginateReturn<TResponse>[]>;
22
+ }
23
+ /**
24
+ * Helper type to infer the Type of the paged elements from the response type
25
+ * This type is generated based on the swagger information for x-ms-pageable
26
+ * specifically on the itemName property which indicates the property of the response
27
+ * where the page items are found. The default value is `value`.
28
+ * This type will allow us to provide strongly typed Iterator based on the response we get as second parameter
29
+ */
30
+ export type PaginateReturn<TResult> = TResult extends {
31
+ body: {
32
+ value?: infer TPage;
33
+ };
34
+ } ? GetArrayType<TPage> : Array<unknown>;
35
+ /**
36
+ * Helper to paginate results from an initial response that follows the specification of Autorest `x-ms-pageable` extension
37
+ * @param client - Client to use for sending the next page requests
38
+ * @param initialResponse - Initial response containing the nextLink and current page of elements
39
+ * @param customGetPage - Optional - Function to define how to extract the page and next link to be used to paginate the results
40
+ * @returns - PagedAsyncIterableIterator to iterate the elements
41
+ */
42
+ export declare function paginate<TResponse extends PathUncheckedResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>;
43
+ //# sourceMappingURL=paginateHelper.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"paginateHelper.d.ts","sourceRoot":"","sources":["../../src/paginateHelper.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,0BAA0B,EAAe,MAAM,oBAAoB,CAAC;AAElF,OAAO,KAAK,EAAE,MAAM,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAG7E;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CAAC,MAAM,KAAK,CAAC,GAAG,KAAK,GAAG,KAAK,CAAC;AAE3E;;GAEG;AACH,MAAM,MAAM,OAAO,CAAC,KAAK,IAAI,CAC3B,QAAQ,EAAE,MAAM,EAChB,WAAW,CAAC,EAAE,MAAM,KACjB,OAAO,CAAC;IACX,IAAI,EAAE,KAAK,CAAC;IACZ,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,SAAS;IACtC;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;CACtD;AAED;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,CAAC,OAAO,IAAI,OAAO,SAAS;IACpD,IAAI,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,KAAK,CAAA;KAAE,CAAC;CAC/B,GACG,YAAY,CAAC,KAAK,CAAC,GACnB,KAAK,CAAC,OAAO,CAAC,CAAC;AAEnB;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,SAAS,SAAS,qBAAqB,EAC9D,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,SAAS,EAC1B,OAAO,GAAE,aAAa,CAAC,SAAS,CAAM,GACrC,0BAA0B,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CA0BvD"}