@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
@@ -1,2096 +0,0 @@
1
- import type { Client } from '@azure-rest/core-client';
2
- import type { ClientOptions } from '@azure-rest/core-client';
3
- import type { HttpResponse } from '@azure-rest/core-client';
4
- import type { LroEngineOptions } from '@azure/core-lro';
5
- import type { PagedAsyncIterableIterator } from '@azure/core-paging';
6
- import type { PathUncheckedResponse } from '@azure-rest/core-client';
7
- import type { PollerLike } from '@azure/core-lro';
8
- import type { PollOperationState } from '@azure/core-lro';
9
- import type { RawHttpHeaders } from '@azure/core-rest-pipeline';
10
- import type { RawHttpHeadersInput } from '@azure/core-rest-pipeline';
11
- import type { RequestParameters } from '@azure-rest/core-client';
12
- import type { StreamableMethod } from '@azure-rest/core-client';
13
- import type { TokenCredential } from '@azure/core-auth';
14
-
15
- export declare interface CloudInitiatedRollbackPolicy {
16
- /** Update to rollback to. */
17
- update: UpdateInfo;
18
- /** Failure conditions to initiate rollback policy. */
19
- failure: CloudInitiatedRollbackPolicyFailure;
20
- }
21
-
22
- export declare interface CloudInitiatedRollbackPolicyFailure {
23
- /** Percentage of devices that failed. */
24
- devicesFailedPercentage: number;
25
- /** Number of devices that failed. */
26
- devicesFailedCount: number;
27
- }
28
-
29
- export declare interface CloudInitiatedRollbackPolicyFailureOutput {
30
- /** Percentage of devices that failed. */
31
- devicesFailedPercentage: number;
32
- /** Number of devices that failed. */
33
- devicesFailedCount: number;
34
- }
35
-
36
- export declare interface CloudInitiatedRollbackPolicyOutput {
37
- /** Update to rollback to. */
38
- update: UpdateInfoOutput;
39
- /** Failure conditions to initiate rollback policy. */
40
- failure: CloudInitiatedRollbackPolicyFailureOutput;
41
- }
42
-
43
- export declare interface ContractModelOutput {
44
- /** The Device Update agent contract model Id of the device class. This is also used to calculate the device class Id. */
45
- id: string;
46
- /** The Device Update agent contract model name of the device class. Intended to be a more readable form of the contract model Id. */
47
- name: string;
48
- }
49
-
50
- declare function createClient(endpoint: string, credentials: TokenCredential, options?: ClientOptions): DeviceUpdateClient;
51
- export default createClient;
52
-
53
- export declare interface Deployment {
54
- /** 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. */
55
- deploymentId: string;
56
- /** The deployment start datetime. */
57
- startDateTime: Date | string;
58
- /** Update information for the update in the deployment. */
59
- update: UpdateInfo;
60
- /** The group identity for the devices the deployment is intended to update. */
61
- groupId: string;
62
- /** 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 */
63
- deviceClassSubgroups?: Array<string>;
64
- /** Boolean flag indicating whether the deployment was canceled. */
65
- isCanceled?: boolean;
66
- /** Boolean flag indicating whether the deployment has been retried. */
67
- isRetried?: boolean;
68
- /** The rollback policy for the deployment. */
69
- rollbackPolicy?: CloudInitiatedRollbackPolicy;
70
- /** Boolean flag indicating whether the deployment is a rollback deployment. */
71
- isCloudInitiatedRollback?: boolean;
72
- }
73
-
74
- export declare interface DeploymentDeviceStateOutput {
75
- /** Device identity. */
76
- deviceId: string;
77
- /** Device module identity. */
78
- moduleId?: string;
79
- /** The number of times this deployment has been retried on this device. */
80
- retryCount: number;
81
- /** Boolean flag indicating whether this device is in a newer deployment and can no longer retry this deployment. */
82
- movedOnToNewDeployment: boolean;
83
- /** Deployment device state. */
84
- deviceState: "Succeeded" | "InProgress" | "Canceled" | "Failed";
85
- }
86
-
87
- export declare interface DeploymentDeviceStatesListOutput {
88
- /** The collection of pageable items. */
89
- value: Array<DeploymentDeviceStateOutput>;
90
- /** The link to the next page of items. */
91
- nextLink?: string;
92
- }
93
-
94
- export declare interface DeploymentOutput {
95
- /** 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. */
96
- deploymentId: string;
97
- /** The deployment start datetime. */
98
- startDateTime: string;
99
- /** Update information for the update in the deployment. */
100
- update: UpdateInfoOutput;
101
- /** The group identity for the devices the deployment is intended to update. */
102
- groupId: string;
103
- /** 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 */
104
- deviceClassSubgroups?: Array<string>;
105
- /** Boolean flag indicating whether the deployment was canceled. */
106
- isCanceled?: boolean;
107
- /** Boolean flag indicating whether the deployment has been retried. */
108
- isRetried?: boolean;
109
- /** The rollback policy for the deployment. */
110
- rollbackPolicy?: CloudInitiatedRollbackPolicyOutput;
111
- /** Boolean flag indicating whether the deployment is a rollback deployment. */
112
- isCloudInitiatedRollback?: boolean;
113
- }
114
-
115
- export declare interface DeploymentsListOutput {
116
- /** The collection of pageable items. */
117
- value: Array<DeploymentOutput>;
118
- /** The link to the next page of items. */
119
- nextLink?: string;
120
- }
121
-
122
- export declare interface DeploymentStatusOutput {
123
- /** The group identity */
124
- groupId: string;
125
- /** The state of the deployment. */
126
- deploymentState: "Active" | "ActiveWithSubgroupFailures" | "Failed" | "Inactive" | "Canceled";
127
- /** The error details of the Failed state. This is not present if the deployment state is not Failed. */
128
- error?: ErrorModelOutput;
129
- /** The collection of device class subgroup status objects */
130
- subgroupStatus: Array<DeviceClassSubgroupDeploymentStatusOutput>;
131
- }
132
-
133
- export declare interface DeviceClassesListOutput {
134
- /** The collection of pageable items. */
135
- value: Array<DeviceClassOutput>;
136
- /** The link to the next page of items. */
137
- nextLink?: string;
138
- }
139
-
140
- export declare interface DeviceClassOutput {
141
- /** 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. */
142
- deviceClassId: string;
143
- /** The device class friendly name. This can be updated by callers after the device class has been automatically created. */
144
- friendlyName?: string;
145
- /** The device class properties that are used to calculate the device class Id */
146
- deviceClassProperties: DeviceClassPropertiesOutput;
147
- /** Update that is the highest version compatible with this device class. */
148
- bestCompatibleUpdate?: UpdateInfoOutput;
149
- }
150
-
151
- export declare interface DeviceClassPropertiesOutput {
152
- /** The Device Update agent contract model. */
153
- contractModel?: ContractModelOutput;
154
- /** 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 */
155
- compatProperties: Record<string, string>;
156
- }
157
-
158
- export declare interface DeviceClassSubgroupDeploymentStatusOutput {
159
- /** The group identity */
160
- groupId: string;
161
- /** The device class subgroup identity */
162
- deviceClassId: string;
163
- /** The state of the subgroup deployment. */
164
- deploymentState: "Active" | "Failed" | "Inactive" | "Canceled";
165
- /** The error details of the Failed state. This is not present if the deployment state is not Failed. */
166
- error?: ErrorModelOutput;
167
- /** The total number of devices in the deployment. */
168
- totalDevices?: number;
169
- /** The number of devices that are currently in deployment. */
170
- devicesInProgressCount?: number;
171
- /** The number of devices that have completed deployment with a failure. */
172
- devicesCompletedFailedCount?: number;
173
- /** The number of devices which have successfully completed deployment. */
174
- devicesCompletedSucceededCount?: number;
175
- /** The number of devices which have had their deployment canceled. */
176
- devicesCanceledCount?: number;
177
- }
178
-
179
- export declare interface DeviceClassSubgroupOutput {
180
- /** 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. */
181
- deviceClassId: string;
182
- /** Group identity. */
183
- groupId: string;
184
- /** Date and time when the device class subgroup was created. */
185
- createdDateTime: string;
186
- /** The number of devices in the device class subgroup. */
187
- deviceCount?: number;
188
- /** The active deployment Id for the device class subgroup. */
189
- deploymentId?: string;
190
- }
191
-
192
- export declare interface DeviceClassSubgroupsListOutput {
193
- /** The collection of pageable items. */
194
- value: Array<DeviceClassSubgroupOutput>;
195
- /** The link to the next page of items. */
196
- nextLink?: string;
197
- }
198
-
199
- export declare interface DeviceClassSubgroupUpdatableDevicesListOutput {
200
- /** The collection of pageable items. */
201
- value: Array<DeviceClassSubgroupUpdatableDevicesOutput>;
202
- /** The link to the next page of items. */
203
- nextLink?: string;
204
- }
205
-
206
- export declare interface DeviceClassSubgroupUpdatableDevicesOutput {
207
- /** The group Id */
208
- groupId: string;
209
- /** The device class subgroup's device class Id */
210
- deviceClassId: string;
211
- /** Update information. */
212
- update: UpdateInfoOutput;
213
- /** Total number of devices for which the update is applicable. */
214
- deviceCount: number;
215
- }
216
-
217
- export declare interface DeviceHealthListOutput {
218
- /** The collection of pageable items. */
219
- value: Array<DeviceHealthOutput>;
220
- /** The link to the next page of items. */
221
- nextLink?: string;
222
- }
223
-
224
- export declare interface DeviceHealthOutput {
225
- /** Device id */
226
- deviceId: string;
227
- /** Module id */
228
- moduleId?: string;
229
- /** Aggregate device health state */
230
- state: "healthy" | "unhealthy";
231
- /** Digital twin model Id */
232
- digitalTwinModelId?: string;
233
- /** Array of health checks and their results */
234
- healthChecks: Array<HealthCheckOutput>;
235
- }
236
-
237
- /** Creates or updates a deployment. */
238
- export declare interface DeviceManagementCreateOrUpdateDeployment200Response extends HttpResponse {
239
- status: "200";
240
- body: DeploymentOutput;
241
- }
242
-
243
- export declare interface DeviceManagementCreateOrUpdateDeploymentBodyParam {
244
- /** The deployment properties. */
245
- body: Deployment;
246
- }
247
-
248
- /** Creates or updates a deployment. */
249
- export declare interface DeviceManagementCreateOrUpdateDeploymentdefaultResponse extends HttpResponse {
250
- status: string;
251
- body: ErrorResponseOutput;
252
- }
253
-
254
- export declare interface DeviceManagementCreateOrUpdateDeploymentMediaTypesParam {
255
- /** Request content type */
256
- contentType?: "application/json";
257
- }
258
-
259
- export declare type DeviceManagementCreateOrUpdateDeploymentParameters = DeviceManagementCreateOrUpdateDeploymentMediaTypesParam & DeviceManagementCreateOrUpdateDeploymentBodyParam & RequestParameters;
260
-
261
- /** Deletes a deployment. */
262
- export declare interface DeviceManagementDeleteDeployment204Response extends HttpResponse {
263
- status: "204";
264
- body: Record<string, unknown>;
265
- }
266
-
267
- /** Deletes a deployment. */
268
- export declare interface DeviceManagementDeleteDeploymentdefaultResponse extends HttpResponse {
269
- status: string;
270
- body: ErrorResponseOutput;
271
- }
272
-
273
- /** Deletes a device class subgroup deployment. */
274
- export declare interface DeviceManagementDeleteDeploymentForDeviceClassSubgroup204Response extends HttpResponse {
275
- status: "204";
276
- body: Record<string, unknown>;
277
- }
278
-
279
- /** Deletes a device class subgroup deployment. */
280
- export declare interface DeviceManagementDeleteDeploymentForDeviceClassSubgroupdefaultResponse extends HttpResponse {
281
- status: string;
282
- body: ErrorResponseOutput;
283
- }
284
-
285
- export declare type DeviceManagementDeleteDeploymentForDeviceClassSubgroupParameters = RequestParameters;
286
-
287
- export declare type DeviceManagementDeleteDeploymentParameters = RequestParameters;
288
-
289
- /** Deletes a device class. Device classes are created automatically when Device Update-enabled devices are connected to the hub but are not automatically cleaned up since they are referenced by DeviceClassSubgroups. If the user has deleted all DeviceClassSubgroups for a device class they can also delete the device class to remove the records from the system and to stop checking the compatibility of this device class with new updates. If a device is ever reconnected for this device class it will be re-created. */
290
- export declare interface DeviceManagementDeleteDeviceClass204Response extends HttpResponse {
291
- status: "204";
292
- body: Record<string, unknown>;
293
- }
294
-
295
- /** Deletes a device class. Device classes are created automatically when Device Update-enabled devices are connected to the hub but are not automatically cleaned up since they are referenced by DeviceClassSubgroups. If the user has deleted all DeviceClassSubgroups for a device class they can also delete the device class to remove the records from the system and to stop checking the compatibility of this device class with new updates. If a device is ever reconnected for this device class it will be re-created. */
296
- export declare interface DeviceManagementDeleteDeviceClassdefaultResponse extends HttpResponse {
297
- status: string;
298
- body: ErrorResponseOutput;
299
- }
300
-
301
- export declare type DeviceManagementDeleteDeviceClassParameters = RequestParameters;
302
-
303
- /** Deletes a device class subgroup. This subgroup is automatically created when a Device Update-enabled device is connected to the hub and reports its properties. Groups, subgroups, and deployments are not automatically cleaned up but are retained for history purposes. Users can call this method to delete a subgroup if they do not need to retain any of the history of the subgroup and no longer need it. If a device is ever connected again for this subgroup after the subgroup was deleted it will be automatically re-created but there will be no history. */
304
- export declare interface DeviceManagementDeleteDeviceClassSubgroup204Response extends HttpResponse {
305
- status: "204";
306
- body: Record<string, unknown>;
307
- }
308
-
309
- /** Deletes a device class subgroup. This subgroup is automatically created when a Device Update-enabled device is connected to the hub and reports its properties. Groups, subgroups, and deployments are not automatically cleaned up but are retained for history purposes. Users can call this method to delete a subgroup if they do not need to retain any of the history of the subgroup and no longer need it. If a device is ever connected again for this subgroup after the subgroup was deleted it will be automatically re-created but there will be no history. */
310
- export declare interface DeviceManagementDeleteDeviceClassSubgroupdefaultResponse extends HttpResponse {
311
- status: string;
312
- body: ErrorResponseOutput;
313
- }
314
-
315
- export declare type DeviceManagementDeleteDeviceClassSubgroupParameters = RequestParameters;
316
-
317
- /** Deletes a device group. This group is automatically created when a Device Update-enabled device is connected to the hub and reports its properties. Groups, subgroups, and deployments are not automatically cleaned up but are retained for history purposes. Users can call this method to delete a group if they do not need to retain any of the history of the group and no longer need it. If a device is ever connected again for this group after the group was deleted it will be automatically re-created but there will be no history. */
318
- export declare interface DeviceManagementDeleteGroup204Response extends HttpResponse {
319
- status: "204";
320
- body: Record<string, unknown>;
321
- }
322
-
323
- /** Deletes a device group. This group is automatically created when a Device Update-enabled device is connected to the hub and reports its properties. Groups, subgroups, and deployments are not automatically cleaned up but are retained for history purposes. Users can call this method to delete a group if they do not need to retain any of the history of the group and no longer need it. If a device is ever connected again for this group after the group was deleted it will be automatically re-created but there will be no history. */
324
- export declare interface DeviceManagementDeleteGroupdefaultResponse extends HttpResponse {
325
- status: string;
326
- body: ErrorResponseOutput;
327
- }
328
-
329
- export declare type DeviceManagementDeleteGroupParameters = RequestParameters;
330
-
331
- export declare interface DeviceManagementGetBestUpdatesForDeviceClassSubgroup {
332
- /** Get the best available update for a device class subgroup and a count of how many devices need this update. */
333
- get(options?: DeviceManagementGetBestUpdatesForDeviceClassSubgroupParameters): StreamableMethod<DeviceManagementGetBestUpdatesForDeviceClassSubgroup200Response | DeviceManagementGetBestUpdatesForDeviceClassSubgroupdefaultResponse>;
334
- }
335
-
336
- /** Get the best available update for a device class subgroup and a count of how many devices need this update. */
337
- export declare interface DeviceManagementGetBestUpdatesForDeviceClassSubgroup200Response extends HttpResponse {
338
- status: "200";
339
- body: DeviceClassSubgroupUpdatableDevicesOutput;
340
- }
341
-
342
- /** Get the best available update for a device class subgroup and a count of how many devices need this update. */
343
- export declare interface DeviceManagementGetBestUpdatesForDeviceClassSubgroupdefaultResponse extends HttpResponse {
344
- status: string;
345
- body: ErrorResponseOutput;
346
- }
347
-
348
- export declare type DeviceManagementGetBestUpdatesForDeviceClassSubgroupParameters = RequestParameters;
349
-
350
- export declare interface DeviceManagementGetDeployment {
351
- /** Gets the deployment properties. */
352
- get(options?: DeviceManagementGetDeploymentParameters): StreamableMethod<DeviceManagementGetDeployment200Response | DeviceManagementGetDeploymentdefaultResponse>;
353
- /** Creates or updates a deployment. */
354
- put(options: DeviceManagementCreateOrUpdateDeploymentParameters): StreamableMethod<DeviceManagementCreateOrUpdateDeployment200Response | DeviceManagementCreateOrUpdateDeploymentdefaultResponse>;
355
- /** Deletes a deployment. */
356
- delete(options?: DeviceManagementDeleteDeploymentParameters): StreamableMethod<DeviceManagementDeleteDeployment204Response | DeviceManagementDeleteDeploymentdefaultResponse>;
357
- }
358
-
359
- /** Gets the deployment properties. */
360
- export declare interface DeviceManagementGetDeployment200Response extends HttpResponse {
361
- status: "200";
362
- body: DeploymentOutput;
363
- }
364
-
365
- /** Gets the deployment properties. */
366
- export declare interface DeviceManagementGetDeploymentdefaultResponse extends HttpResponse {
367
- status: string;
368
- body: ErrorResponseOutput;
369
- }
370
-
371
- export declare interface DeviceManagementGetDeploymentForDeviceClassSubgroup {
372
- /** Gets the deployment properties. */
373
- get(options?: DeviceManagementGetDeploymentForDeviceClassSubgroupParameters): StreamableMethod<DeviceManagementGetDeploymentForDeviceClassSubgroup200Response | DeviceManagementGetDeploymentForDeviceClassSubgroupdefaultResponse>;
374
- /** Deletes a device class subgroup deployment. */
375
- delete(options?: DeviceManagementDeleteDeploymentForDeviceClassSubgroupParameters): StreamableMethod<DeviceManagementDeleteDeploymentForDeviceClassSubgroup204Response | DeviceManagementDeleteDeploymentForDeviceClassSubgroupdefaultResponse>;
376
- }
377
-
378
- /** Gets the deployment properties. */
379
- export declare interface DeviceManagementGetDeploymentForDeviceClassSubgroup200Response extends HttpResponse {
380
- status: "200";
381
- body: DeploymentOutput;
382
- }
383
-
384
- /** Gets the deployment properties. */
385
- export declare interface DeviceManagementGetDeploymentForDeviceClassSubgroupdefaultResponse extends HttpResponse {
386
- status: string;
387
- body: ErrorResponseOutput;
388
- }
389
-
390
- export declare type DeviceManagementGetDeploymentForDeviceClassSubgroupParameters = RequestParameters;
391
-
392
- export declare type DeviceManagementGetDeploymentParameters = RequestParameters;
393
-
394
- export declare interface DeviceManagementGetDeploymentStatus {
395
- /** Gets the status of a deployment including a breakdown of how many devices in the deployment are in progress, completed, or failed. */
396
- get(options?: DeviceManagementGetDeploymentStatusParameters): StreamableMethod<DeviceManagementGetDeploymentStatus200Response | DeviceManagementGetDeploymentStatusdefaultResponse>;
397
- }
398
-
399
- /** Gets the status of a deployment including a breakdown of how many devices in the deployment are in progress, completed, or failed. */
400
- export declare interface DeviceManagementGetDeploymentStatus200Response extends HttpResponse {
401
- status: "200";
402
- body: DeploymentStatusOutput;
403
- }
404
-
405
- /** Gets the status of a deployment including a breakdown of how many devices in the deployment are in progress, completed, or failed. */
406
- export declare interface DeviceManagementGetDeploymentStatusdefaultResponse extends HttpResponse {
407
- status: string;
408
- body: ErrorResponseOutput;
409
- }
410
-
411
- export declare type DeviceManagementGetDeploymentStatusParameters = RequestParameters;
412
-
413
- export declare interface DeviceManagementGetDevice {
414
- /** Gets the device properties and latest deployment status for a device connected to Device Update for IoT Hub. */
415
- get(options?: DeviceManagementGetDeviceParameters): StreamableMethod<DeviceManagementGetDevice200Response | DeviceManagementGetDevicedefaultResponse>;
416
- }
417
-
418
- /** Gets the device properties and latest deployment status for a device connected to Device Update for IoT Hub. */
419
- export declare interface DeviceManagementGetDevice200Response extends HttpResponse {
420
- status: "200";
421
- body: DeviceOutput;
422
- }
423
-
424
- export declare interface DeviceManagementGetDeviceClass {
425
- /** Gets the properties of a device class. */
426
- get(options?: DeviceManagementGetDeviceClassParameters): StreamableMethod<DeviceManagementGetDeviceClass200Response | DeviceManagementGetDeviceClassdefaultResponse>;
427
- /** Update device class details. */
428
- patch(options: DeviceManagementUpdateDeviceClassParameters): StreamableMethod<DeviceManagementUpdateDeviceClass200Response | DeviceManagementUpdateDeviceClassdefaultResponse>;
429
- /** Deletes a device class. Device classes are created automatically when Device Update-enabled devices are connected to the hub but are not automatically cleaned up since they are referenced by DeviceClassSubgroups. If the user has deleted all DeviceClassSubgroups for a device class they can also delete the device class to remove the records from the system and to stop checking the compatibility of this device class with new updates. If a device is ever reconnected for this device class it will be re-created. */
430
- delete(options?: DeviceManagementDeleteDeviceClassParameters): StreamableMethod<DeviceManagementDeleteDeviceClass204Response | DeviceManagementDeleteDeviceClassdefaultResponse>;
431
- }
432
-
433
- /** Gets the properties of a device class. */
434
- export declare interface DeviceManagementGetDeviceClass200Response extends HttpResponse {
435
- status: "200";
436
- body: DeviceClassOutput;
437
- }
438
-
439
- /** Gets the properties of a device class. */
440
- export declare interface DeviceManagementGetDeviceClassdefaultResponse extends HttpResponse {
441
- status: string;
442
- body: ErrorResponseOutput;
443
- }
444
-
445
- export declare type DeviceManagementGetDeviceClassParameters = RequestParameters;
446
-
447
- export declare interface DeviceManagementGetDeviceClassSubgroup {
448
- /** Gets device class subgroup details. A device class subgroup is the set of devices within the group that share the same device class. All devices within the same device class are compatible with the same updates. */
449
- get(options?: DeviceManagementGetDeviceClassSubgroupParameters): StreamableMethod<DeviceManagementGetDeviceClassSubgroup200Response | DeviceManagementGetDeviceClassSubgroupdefaultResponse>;
450
- /** Deletes a device class subgroup. This subgroup is automatically created when a Device Update-enabled device is connected to the hub and reports its properties. Groups, subgroups, and deployments are not automatically cleaned up but are retained for history purposes. Users can call this method to delete a subgroup if they do not need to retain any of the history of the subgroup and no longer need it. If a device is ever connected again for this subgroup after the subgroup was deleted it will be automatically re-created but there will be no history. */
451
- delete(options?: DeviceManagementDeleteDeviceClassSubgroupParameters): StreamableMethod<DeviceManagementDeleteDeviceClassSubgroup204Response | DeviceManagementDeleteDeviceClassSubgroupdefaultResponse>;
452
- }
453
-
454
- /** Gets device class subgroup details. A device class subgroup is the set of devices within the group that share the same device class. All devices within the same device class are compatible with the same updates. */
455
- export declare interface DeviceManagementGetDeviceClassSubgroup200Response extends HttpResponse {
456
- status: "200";
457
- body: DeviceClassSubgroupOutput;
458
- }
459
-
460
- /** Gets device class subgroup details. A device class subgroup is the set of devices within the group that share the same device class. All devices within the same device class are compatible with the same updates. */
461
- export declare interface DeviceManagementGetDeviceClassSubgroupdefaultResponse extends HttpResponse {
462
- status: string;
463
- body: ErrorResponseOutput;
464
- }
465
-
466
- export declare interface DeviceManagementGetDeviceClassSubgroupDeploymentStatus {
467
- /** Gets the status of a deployment including a breakdown of how many devices in the deployment are in progress, completed, or failed. */
468
- get(options?: DeviceManagementGetDeviceClassSubgroupDeploymentStatusParameters): StreamableMethod<DeviceManagementGetDeviceClassSubgroupDeploymentStatus200Response | DeviceManagementGetDeviceClassSubgroupDeploymentStatusdefaultResponse>;
469
- }
470
-
471
- /** Gets the status of a deployment including a breakdown of how many devices in the deployment are in progress, completed, or failed. */
472
- export declare interface DeviceManagementGetDeviceClassSubgroupDeploymentStatus200Response extends HttpResponse {
473
- status: "200";
474
- body: DeviceClassSubgroupDeploymentStatusOutput;
475
- }
476
-
477
- /** Gets the status of a deployment including a breakdown of how many devices in the deployment are in progress, completed, or failed. */
478
- export declare interface DeviceManagementGetDeviceClassSubgroupDeploymentStatusdefaultResponse extends HttpResponse {
479
- status: string;
480
- body: ErrorResponseOutput;
481
- }
482
-
483
- export declare type DeviceManagementGetDeviceClassSubgroupDeploymentStatusParameters = RequestParameters;
484
-
485
- export declare type DeviceManagementGetDeviceClassSubgroupParameters = RequestParameters;
486
-
487
- export declare interface DeviceManagementGetDeviceClassSubgroupUpdateCompliance {
488
- /** Get device class subgroup update compliance information such as how many devices are on their latest update, how many need new updates, and how many are in progress on receiving a new update. */
489
- get(options?: DeviceManagementGetDeviceClassSubgroupUpdateComplianceParameters): StreamableMethod<DeviceManagementGetDeviceClassSubgroupUpdateCompliance200Response | DeviceManagementGetDeviceClassSubgroupUpdateCompliancedefaultResponse>;
490
- }
491
-
492
- /** Get device class subgroup update compliance information such as how many devices are on their latest update, how many need new updates, and how many are in progress on receiving a new update. */
493
- export declare interface DeviceManagementGetDeviceClassSubgroupUpdateCompliance200Response extends HttpResponse {
494
- status: "200";
495
- body: UpdateComplianceOutput;
496
- }
497
-
498
- /** Get device class subgroup update compliance information such as how many devices are on their latest update, how many need new updates, and how many are in progress on receiving a new update. */
499
- export declare interface DeviceManagementGetDeviceClassSubgroupUpdateCompliancedefaultResponse extends HttpResponse {
500
- status: string;
501
- body: ErrorResponseOutput;
502
- }
503
-
504
- export declare type DeviceManagementGetDeviceClassSubgroupUpdateComplianceParameters = RequestParameters;
505
-
506
- /** Gets the device properties and latest deployment status for a device connected to Device Update for IoT Hub. */
507
- export declare interface DeviceManagementGetDevicedefaultResponse extends HttpResponse {
508
- status: string;
509
- body: ErrorResponseOutput;
510
- }
511
-
512
- export declare interface DeviceManagementGetDeviceModule {
513
- /** Gets the device module properties and latest deployment status for a device module connected to Device Update for IoT Hub. */
514
- get(options?: DeviceManagementGetDeviceModuleParameters): StreamableMethod<DeviceManagementGetDeviceModule200Response | DeviceManagementGetDeviceModuledefaultResponse>;
515
- }
516
-
517
- /** Gets the device module properties and latest deployment status for a device module connected to Device Update for IoT Hub. */
518
- export declare interface DeviceManagementGetDeviceModule200Response extends HttpResponse {
519
- status: "200";
520
- body: DeviceOutput;
521
- }
522
-
523
- /** Gets the device module properties and latest deployment status for a device module connected to Device Update for IoT Hub. */
524
- export declare interface DeviceManagementGetDeviceModuledefaultResponse extends HttpResponse {
525
- status: string;
526
- body: ErrorResponseOutput;
527
- }
528
-
529
- export declare type DeviceManagementGetDeviceModuleParameters = RequestParameters;
530
-
531
- export declare type DeviceManagementGetDeviceParameters = RequestParameters;
532
-
533
- export declare interface DeviceManagementGetGroup {
534
- /** Gets the device group properties. */
535
- get(options?: DeviceManagementGetGroupParameters): StreamableMethod<DeviceManagementGetGroup200Response | DeviceManagementGetGroupdefaultResponse>;
536
- /** Deletes a device group. This group is automatically created when a Device Update-enabled device is connected to the hub and reports its properties. Groups, subgroups, and deployments are not automatically cleaned up but are retained for history purposes. Users can call this method to delete a group if they do not need to retain any of the history of the group and no longer need it. If a device is ever connected again for this group after the group was deleted it will be automatically re-created but there will be no history. */
537
- delete(options?: DeviceManagementDeleteGroupParameters): StreamableMethod<DeviceManagementDeleteGroup204Response | DeviceManagementDeleteGroupdefaultResponse>;
538
- }
539
-
540
- /** Gets the device group properties. */
541
- export declare interface DeviceManagementGetGroup200Response extends HttpResponse {
542
- status: "200";
543
- body: GroupOutput;
544
- }
545
-
546
- /** Gets the device group properties. */
547
- export declare interface DeviceManagementGetGroupdefaultResponse extends HttpResponse {
548
- status: string;
549
- body: ErrorResponseOutput;
550
- }
551
-
552
- export declare type DeviceManagementGetGroupParameters = RequestParameters;
553
-
554
- /** Get the device diagnostics log collection */
555
- export declare interface DeviceManagementGetLogCollection200Response extends HttpResponse {
556
- status: "200";
557
- body: LogCollectionOutput;
558
- }
559
-
560
- /** Get the device diagnostics log collection */
561
- export declare interface DeviceManagementGetLogCollectiondefaultResponse extends HttpResponse {
562
- status: string;
563
- body: ErrorResponseOutput;
564
- }
565
-
566
- export declare interface DeviceManagementGetLogCollectionDetailedStatus {
567
- /** Get log collection with detailed status */
568
- get(options?: DeviceManagementGetLogCollectionDetailedStatusParameters): StreamableMethod<DeviceManagementGetLogCollectionDetailedStatus200Response | DeviceManagementGetLogCollectionDetailedStatusdefaultResponse>;
569
- }
570
-
571
- /** Get log collection with detailed status */
572
- export declare interface DeviceManagementGetLogCollectionDetailedStatus200Response extends HttpResponse {
573
- status: "200";
574
- body: LogCollectionOperationDetailedStatusOutput;
575
- }
576
-
577
- /** Get log collection with detailed status */
578
- export declare interface DeviceManagementGetLogCollectionDetailedStatusdefaultResponse extends HttpResponse {
579
- status: string;
580
- body: ErrorResponseOutput;
581
- }
582
-
583
- export declare type DeviceManagementGetLogCollectionDetailedStatusParameters = RequestParameters;
584
-
585
- export declare type DeviceManagementGetLogCollectionParameters = RequestParameters;
586
-
587
- export declare interface DeviceManagementGetOperationStatus {
588
- /** Retrieve operation status. */
589
- get(options?: DeviceManagementGetOperationStatusParameters): StreamableMethod<DeviceManagementGetOperationStatus200Response | DeviceManagementGetOperationStatus304Response | DeviceManagementGetOperationStatusdefaultResponse>;
590
- }
591
-
592
- export declare interface DeviceManagementGetOperationStatus200Headers {
593
- /** Number of seconds to wait before checking the operation status again. */
594
- "retry-after"?: string;
595
- }
596
-
597
- /** Retrieve operation status. */
598
- export declare interface DeviceManagementGetOperationStatus200Response extends HttpResponse {
599
- status: "200";
600
- body: DeviceOperationOutput;
601
- headers: RawHttpHeaders & DeviceManagementGetOperationStatus200Headers;
602
- }
603
-
604
- /** Retrieve operation status. */
605
- export declare interface DeviceManagementGetOperationStatus304Response extends HttpResponse {
606
- status: "304";
607
- body: Record<string, unknown>;
608
- }
609
-
610
- /** Retrieve operation status. */
611
- export declare interface DeviceManagementGetOperationStatusdefaultResponse extends HttpResponse {
612
- status: string;
613
- body: ErrorResponseOutput;
614
- }
615
-
616
- export declare interface DeviceManagementGetOperationStatusHeaderParam {
617
- headers: RawHttpHeadersInput & DeviceManagementGetOperationStatusHeaders;
618
- }
619
-
620
- export declare interface DeviceManagementGetOperationStatusHeaders {
621
- /** Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. */
622
- "If-None-Match"?: string;
623
- }
624
-
625
- export declare type DeviceManagementGetOperationStatusParameters = DeviceManagementGetOperationStatusHeaderParam & RequestParameters;
626
-
627
- export declare interface DeviceManagementGetUpdateCompliance {
628
- /** Gets the breakdown of how many devices are on their latest update, have new updates available, or are in progress receiving new updates. */
629
- get(options?: DeviceManagementGetUpdateComplianceParameters): StreamableMethod<DeviceManagementGetUpdateCompliance200Response | DeviceManagementGetUpdateCompliancedefaultResponse>;
630
- }
631
-
632
- /** Gets the breakdown of how many devices are on their latest update, have new updates available, or are in progress receiving new updates. */
633
- export declare interface DeviceManagementGetUpdateCompliance200Response extends HttpResponse {
634
- status: "200";
635
- body: UpdateComplianceOutput;
636
- }
637
-
638
- /** Gets the breakdown of how many devices are on their latest update, have new updates available, or are in progress receiving new updates. */
639
- export declare interface DeviceManagementGetUpdateCompliancedefaultResponse extends HttpResponse {
640
- status: string;
641
- body: ErrorResponseOutput;
642
- }
643
-
644
- export declare interface DeviceManagementGetUpdateComplianceForGroup {
645
- /** Get device group update compliance information such as how many devices are on their latest update, how many need new updates, and how many are in progress on receiving a new update. */
646
- get(options?: DeviceManagementGetUpdateComplianceForGroupParameters): StreamableMethod<DeviceManagementGetUpdateComplianceForGroup200Response | DeviceManagementGetUpdateComplianceForGroupdefaultResponse>;
647
- }
648
-
649
- /** Get device group update compliance information such as how many devices are on their latest update, how many need new updates, and how many are in progress on receiving a new update. */
650
- export declare interface DeviceManagementGetUpdateComplianceForGroup200Response extends HttpResponse {
651
- status: "200";
652
- body: UpdateComplianceOutput;
653
- }
654
-
655
- /** Get device group update compliance information such as how many devices are on their latest update, how many need new updates, and how many are in progress on receiving a new update. */
656
- export declare interface DeviceManagementGetUpdateComplianceForGroupdefaultResponse extends HttpResponse {
657
- status: string;
658
- body: ErrorResponseOutput;
659
- }
660
-
661
- export declare type DeviceManagementGetUpdateComplianceForGroupParameters = RequestParameters;
662
-
663
- export declare type DeviceManagementGetUpdateComplianceParameters = RequestParameters;
664
-
665
- export declare interface DeviceManagementImportDevices {
666
- /** Import existing devices from IoT Hub. This is a long-running-operation; use Operation-Location response header value to check for operation status. */
667
- post(options: DeviceManagementImportDevicesParameters): StreamableMethod<DeviceManagementImportDevices202Response | DeviceManagementImportDevicesdefaultResponse>;
668
- }
669
-
670
- export declare interface DeviceManagementImportDevices202Headers {
671
- /** Url to retrieve the device import operation status. */
672
- "operation-location"?: string;
673
- }
674
-
675
- /** Import existing devices from IoT Hub. This is a long-running-operation; use Operation-Location response header value to check for operation status. */
676
- export declare interface DeviceManagementImportDevices202Response extends HttpResponse {
677
- status: "202";
678
- body: Record<string, unknown>;
679
- headers: RawHttpHeaders & DeviceManagementImportDevices202Headers;
680
- }
681
-
682
- export declare interface DeviceManagementImportDevicesBodyParam {
683
- /** The types of devices to import. */
684
- body: "Devices" | "Modules" | "All";
685
- }
686
-
687
- /** Import existing devices from IoT Hub. This is a long-running-operation; use Operation-Location response header value to check for operation status. */
688
- export declare interface DeviceManagementImportDevicesdefaultResponse extends HttpResponse {
689
- status: string;
690
- body: ErrorResponseOutput;
691
- }
692
-
693
- export declare interface DeviceManagementImportDevicesMediaTypesParam {
694
- /** Request content type */
695
- contentType?: "application/json";
696
- }
697
-
698
- export declare type DeviceManagementImportDevicesParameters = DeviceManagementImportDevicesMediaTypesParam & DeviceManagementImportDevicesBodyParam & RequestParameters;
699
-
700
- export declare interface DeviceManagementListBestUpdatesForGroup {
701
- /** Get the best available updates for a device group and a count of how many devices need each update. */
702
- get(options?: DeviceManagementListBestUpdatesForGroupParameters): StreamableMethod<DeviceManagementListBestUpdatesForGroup200Response | DeviceManagementListBestUpdatesForGroupdefaultResponse>;
703
- }
704
-
705
- /** Get the best available updates for a device group and a count of how many devices need each update. */
706
- export declare interface DeviceManagementListBestUpdatesForGroup200Response extends HttpResponse {
707
- status: "200";
708
- body: DeviceClassSubgroupUpdatableDevicesListOutput;
709
- }
710
-
711
- /** Get the best available updates for a device group and a count of how many devices need each update. */
712
- export declare interface DeviceManagementListBestUpdatesForGroupdefaultResponse extends HttpResponse {
713
- status: string;
714
- body: ErrorResponseOutput;
715
- }
716
-
717
- export declare type DeviceManagementListBestUpdatesForGroupParameters = RequestParameters;
718
-
719
- export declare interface DeviceManagementListDeploymentsForDeviceClassSubgroup {
720
- /** Gets a list of deployments for a device class subgroup. */
721
- get(options?: DeviceManagementListDeploymentsForDeviceClassSubgroupParameters): StreamableMethod<DeviceManagementListDeploymentsForDeviceClassSubgroup200Response | DeviceManagementListDeploymentsForDeviceClassSubgroupdefaultResponse>;
722
- }
723
-
724
- /** Gets a list of deployments for a device class subgroup. */
725
- export declare interface DeviceManagementListDeploymentsForDeviceClassSubgroup200Response extends HttpResponse {
726
- status: "200";
727
- body: DeploymentsListOutput;
728
- }
729
-
730
- /** Gets a list of deployments for a device class subgroup. */
731
- export declare interface DeviceManagementListDeploymentsForDeviceClassSubgroupdefaultResponse extends HttpResponse {
732
- status: string;
733
- body: ErrorResponseOutput;
734
- }
735
-
736
- export declare type DeviceManagementListDeploymentsForDeviceClassSubgroupParameters = DeviceManagementListDeploymentsForDeviceClassSubgroupQueryParam & RequestParameters;
737
-
738
- export declare interface DeviceManagementListDeploymentsForDeviceClassSubgroupQueryParam {
739
- queryParameters?: DeviceManagementListDeploymentsForDeviceClassSubgroupQueryParamProperties;
740
- }
741
-
742
- export declare interface DeviceManagementListDeploymentsForDeviceClassSubgroupQueryParamProperties {
743
- /** Orders the set of deployments returned. You can order by start date. */
744
- orderby?: string;
745
- }
746
-
747
- export declare interface DeviceManagementListDeploymentsForGroup {
748
- /** Gets a list of deployments for a device group. */
749
- get(options?: DeviceManagementListDeploymentsForGroupParameters): StreamableMethod<DeviceManagementListDeploymentsForGroup200Response | DeviceManagementListDeploymentsForGroupdefaultResponse>;
750
- }
751
-
752
- /** Gets a list of deployments for a device group. */
753
- export declare interface DeviceManagementListDeploymentsForGroup200Response extends HttpResponse {
754
- status: "200";
755
- body: DeploymentsListOutput;
756
- }
757
-
758
- /** Gets a list of deployments for a device group. */
759
- export declare interface DeviceManagementListDeploymentsForGroupdefaultResponse extends HttpResponse {
760
- status: string;
761
- body: ErrorResponseOutput;
762
- }
763
-
764
- export declare type DeviceManagementListDeploymentsForGroupParameters = DeviceManagementListDeploymentsForGroupQueryParam & RequestParameters;
765
-
766
- export declare interface DeviceManagementListDeploymentsForGroupQueryParam {
767
- queryParameters?: DeviceManagementListDeploymentsForGroupQueryParamProperties;
768
- }
769
-
770
- export declare interface DeviceManagementListDeploymentsForGroupQueryParamProperties {
771
- /** Orders the set of deployments returned. You can order by start date. */
772
- orderby?: string;
773
- }
774
-
775
- export declare interface DeviceManagementListDeviceClasses {
776
- /** Gets a list of all device classes (sets of devices compatible with the same updates based on the model Id and compat properties reported in the Device Update PnP interface in IoT Hub) for all devices connected to Device Update for IoT Hub. */
777
- get(options?: DeviceManagementListDeviceClassesParameters): StreamableMethod<DeviceManagementListDeviceClasses200Response | DeviceManagementListDeviceClassesdefaultResponse>;
778
- }
779
-
780
- /** Gets a list of all device classes (sets of devices compatible with the same updates based on the model Id and compat properties reported in the Device Update PnP interface in IoT Hub) for all devices connected to Device Update for IoT Hub. */
781
- export declare interface DeviceManagementListDeviceClasses200Response extends HttpResponse {
782
- status: "200";
783
- body: DeviceClassesListOutput;
784
- }
785
-
786
- /** Gets a list of all device classes (sets of devices compatible with the same updates based on the model Id and compat properties reported in the Device Update PnP interface in IoT Hub) for all devices connected to Device Update for IoT Hub. */
787
- export declare interface DeviceManagementListDeviceClassesdefaultResponse extends HttpResponse {
788
- status: string;
789
- body: ErrorResponseOutput;
790
- }
791
-
792
- export declare type DeviceManagementListDeviceClassesParameters = DeviceManagementListDeviceClassesQueryParam & RequestParameters;
793
-
794
- export declare interface DeviceManagementListDeviceClassesQueryParam {
795
- queryParameters?: DeviceManagementListDeviceClassesQueryParamProperties;
796
- }
797
-
798
- export declare interface DeviceManagementListDeviceClassesQueryParamProperties {
799
- /** Restricts the set of device classes returned. You can filter on friendly name. */
800
- filter?: string;
801
- }
802
-
803
- export declare interface DeviceManagementListDeviceClassSubgroupsForGroup {
804
- /** Get the device class subgroups for the group. A device class subgroup is the set of devices within the group that share the same device class. All devices within the same device class are compatible with the same updates. */
805
- get(options?: DeviceManagementListDeviceClassSubgroupsForGroupParameters): StreamableMethod<DeviceManagementListDeviceClassSubgroupsForGroup200Response | DeviceManagementListDeviceClassSubgroupsForGroupdefaultResponse>;
806
- }
807
-
808
- /** Get the device class subgroups for the group. A device class subgroup is the set of devices within the group that share the same device class. All devices within the same device class are compatible with the same updates. */
809
- export declare interface DeviceManagementListDeviceClassSubgroupsForGroup200Response extends HttpResponse {
810
- status: "200";
811
- body: DeviceClassSubgroupsListOutput;
812
- }
813
-
814
- /** Get the device class subgroups for the group. A device class subgroup is the set of devices within the group that share the same device class. All devices within the same device class are compatible with the same updates. */
815
- export declare interface DeviceManagementListDeviceClassSubgroupsForGroupdefaultResponse extends HttpResponse {
816
- status: string;
817
- body: ErrorResponseOutput;
818
- }
819
-
820
- export declare type DeviceManagementListDeviceClassSubgroupsForGroupParameters = DeviceManagementListDeviceClassSubgroupsForGroupQueryParam & RequestParameters;
821
-
822
- export declare interface DeviceManagementListDeviceClassSubgroupsForGroupQueryParam {
823
- queryParameters?: DeviceManagementListDeviceClassSubgroupsForGroupQueryParamProperties;
824
- }
825
-
826
- export declare interface DeviceManagementListDeviceClassSubgroupsForGroupQueryParamProperties {
827
- /** Restricts the set of device class subgroups returned. You can filter on compat properties by name and value. (i.e. filter=compatProperties/propertyName1 eq 'value1' and compatProperties/propertyName2 eq 'value2') */
828
- filter?: string;
829
- }
830
-
831
- export declare interface DeviceManagementListDevices {
832
- /** Gets a list of devices connected to Device Update for IoT Hub. */
833
- get(options?: DeviceManagementListDevicesParameters): StreamableMethod<DeviceManagementListDevices200Response | DeviceManagementListDevicesdefaultResponse>;
834
- }
835
-
836
- /** Gets a list of devices connected to Device Update for IoT Hub. */
837
- export declare interface DeviceManagementListDevices200Response extends HttpResponse {
838
- status: "200";
839
- body: DevicesListOutput;
840
- }
841
-
842
- /** Gets a list of devices connected to Device Update for IoT Hub. */
843
- export declare interface DeviceManagementListDevicesdefaultResponse extends HttpResponse {
844
- status: string;
845
- body: ErrorResponseOutput;
846
- }
847
-
848
- export declare type DeviceManagementListDevicesParameters = DeviceManagementListDevicesQueryParam & RequestParameters;
849
-
850
- export declare interface DeviceManagementListDevicesQueryParam {
851
- queryParameters?: DeviceManagementListDevicesQueryParamProperties;
852
- }
853
-
854
- export declare interface DeviceManagementListDevicesQueryParamProperties {
855
- /** Restricts the set of devices returned. You can filter on GroupId, DeviceClassId, or GroupId and DeploymentStatus. Use DeploymentStatus eq null to query for devices with no deployment status (that have never been deployed to). */
856
- filter?: string;
857
- }
858
-
859
- export declare interface DeviceManagementListDeviceStatesForDeviceClassSubgroupDeployment {
860
- /** Gets a list of devices in a deployment along with their state. Useful for getting a list of failed devices. */
861
- get(options?: DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentParameters): StreamableMethod<DeviceManagementListDeviceStatesForDeviceClassSubgroupDeployment200Response | DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentdefaultResponse>;
862
- }
863
-
864
- /** Gets a list of devices in a deployment along with their state. Useful for getting a list of failed devices. */
865
- export declare interface DeviceManagementListDeviceStatesForDeviceClassSubgroupDeployment200Response extends HttpResponse {
866
- status: "200";
867
- body: DeploymentDeviceStatesListOutput;
868
- }
869
-
870
- /** Gets a list of devices in a deployment along with their state. Useful for getting a list of failed devices. */
871
- export declare interface DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentdefaultResponse extends HttpResponse {
872
- status: string;
873
- body: ErrorResponseOutput;
874
- }
875
-
876
- export declare type DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentParameters = DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentQueryParam & RequestParameters;
877
-
878
- export declare interface DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentQueryParam {
879
- queryParameters?: DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentQueryParamProperties;
880
- }
881
-
882
- export declare interface DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentQueryParamProperties {
883
- /** Restricts the set of deployment device states returned. You can filter on deviceId and moduleId and/or deviceState. */
884
- filter?: string;
885
- }
886
-
887
- export declare interface DeviceManagementListGroups {
888
- /** Gets a list of all device groups. The $default group will always be returned first. */
889
- get(options?: DeviceManagementListGroupsParameters): StreamableMethod<DeviceManagementListGroups200Response | DeviceManagementListGroupsdefaultResponse>;
890
- }
891
-
892
- /** Gets a list of all device groups. The $default group will always be returned first. */
893
- export declare interface DeviceManagementListGroups200Response extends HttpResponse {
894
- status: "200";
895
- body: GroupsListOutput;
896
- }
897
-
898
- /** Gets a list of all device groups. The $default group will always be returned first. */
899
- export declare interface DeviceManagementListGroupsdefaultResponse extends HttpResponse {
900
- status: string;
901
- body: ErrorResponseOutput;
902
- }
903
-
904
- export declare type DeviceManagementListGroupsParameters = DeviceManagementListGroupsQueryParam & RequestParameters;
905
-
906
- export declare interface DeviceManagementListGroupsQueryParam {
907
- queryParameters?: DeviceManagementListGroupsQueryParamProperties;
908
- }
909
-
910
- export declare interface DeviceManagementListGroupsQueryParamProperties {
911
- /** Orders the set of groups returned. You can order by groupId, deviceCount, createdDate, subgroupsWithNewUpdatesAvailableCount, subgroupsWithUpdatesInProgressCount, or subgroupsOnLatestUpdateCount. */
912
- orderby?: string;
913
- }
914
-
915
- export declare interface DeviceManagementListHealthOfDevices {
916
- /** Get list of device health */
917
- get(options: DeviceManagementListHealthOfDevicesParameters): StreamableMethod<DeviceManagementListHealthOfDevices200Response | DeviceManagementListHealthOfDevicesdefaultResponse>;
918
- }
919
-
920
- /** Get list of device health */
921
- export declare interface DeviceManagementListHealthOfDevices200Response extends HttpResponse {
922
- status: "200";
923
- body: DeviceHealthListOutput;
924
- }
925
-
926
- /** Get list of device health */
927
- export declare interface DeviceManagementListHealthOfDevicesdefaultResponse extends HttpResponse {
928
- status: string;
929
- body: ErrorResponseOutput;
930
- }
931
-
932
- export declare type DeviceManagementListHealthOfDevicesParameters = DeviceManagementListHealthOfDevicesQueryParam & RequestParameters;
933
-
934
- export declare interface DeviceManagementListHealthOfDevicesQueryParam {
935
- queryParameters: DeviceManagementListHealthOfDevicesQueryParamProperties;
936
- }
937
-
938
- export declare interface DeviceManagementListHealthOfDevicesQueryParamProperties {
939
- /** Restricts the set of devices for which device health is returned. You can filter on status, device id and module id. */
940
- filter: string;
941
- }
942
-
943
- export declare interface DeviceManagementListInstallableUpdatesForDeviceClass {
944
- /** Gets a list of installable updates for a device class. */
945
- get(options?: DeviceManagementListInstallableUpdatesForDeviceClassParameters): StreamableMethod<DeviceManagementListInstallableUpdatesForDeviceClass200Response | DeviceManagementListInstallableUpdatesForDeviceClassdefaultResponse>;
946
- }
947
-
948
- /** Gets a list of installable updates for a device class. */
949
- export declare interface DeviceManagementListInstallableUpdatesForDeviceClass200Response extends HttpResponse {
950
- status: "200";
951
- body: UpdateInfoListOutput;
952
- }
953
-
954
- /** Gets a list of installable updates for a device class. */
955
- export declare interface DeviceManagementListInstallableUpdatesForDeviceClassdefaultResponse extends HttpResponse {
956
- status: string;
957
- body: ErrorResponseOutput;
958
- }
959
-
960
- export declare type DeviceManagementListInstallableUpdatesForDeviceClassParameters = RequestParameters;
961
-
962
- export declare interface DeviceManagementListLogCollections {
963
- /** Get all device diagnostics log collections */
964
- get(options?: DeviceManagementListLogCollectionsParameters): StreamableMethod<DeviceManagementListLogCollections200Response | DeviceManagementListLogCollectionsdefaultResponse>;
965
- }
966
-
967
- /** Get all device diagnostics log collections */
968
- export declare interface DeviceManagementListLogCollections200Response extends HttpResponse {
969
- status: "200";
970
- body: LogCollectionListOutput;
971
- }
972
-
973
- /** Get all device diagnostics log collections */
974
- export declare interface DeviceManagementListLogCollectionsdefaultResponse extends HttpResponse {
975
- status: string;
976
- body: ErrorResponseOutput;
977
- }
978
-
979
- export declare type DeviceManagementListLogCollectionsParameters = RequestParameters;
980
-
981
- export declare interface DeviceManagementListOperationStatuses {
982
- /** Get a list of all device import operations. Completed operations are kept for 7 days before auto-deleted. */
983
- get(options?: DeviceManagementListOperationStatusesParameters): StreamableMethod<DeviceManagementListOperationStatuses200Response | DeviceManagementListOperationStatusesdefaultResponse>;
984
- }
985
-
986
- /** Get a list of all device import operations. Completed operations are kept for 7 days before auto-deleted. */
987
- export declare interface DeviceManagementListOperationStatuses200Response extends HttpResponse {
988
- status: "200";
989
- body: DeviceOperationsListOutput;
990
- }
991
-
992
- /** Get a list of all device import operations. Completed operations are kept for 7 days before auto-deleted. */
993
- export declare interface DeviceManagementListOperationStatusesdefaultResponse extends HttpResponse {
994
- status: string;
995
- body: ErrorResponseOutput;
996
- }
997
-
998
- export declare type DeviceManagementListOperationStatusesParameters = DeviceManagementListOperationStatusesQueryParam & RequestParameters;
999
-
1000
- export declare interface DeviceManagementListOperationStatusesQueryParam {
1001
- queryParameters?: DeviceManagementListOperationStatusesQueryParamProperties;
1002
- }
1003
-
1004
- export declare interface DeviceManagementListOperationStatusesQueryParamProperties {
1005
- /** Restricts the set of operations returned. Only one specific filter is supported: "status eq 'NotStarted' or status eq 'Running'" */
1006
- filter?: string;
1007
- /** Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n. */
1008
- top?: number;
1009
- }
1010
-
1011
- export declare interface DeviceManagementRetryDeployment {
1012
- /** Retries a deployment with failed devices. */
1013
- post(options?: DeviceManagementRetryDeploymentParameters): StreamableMethod<DeviceManagementRetryDeployment200Response | DeviceManagementRetryDeploymentdefaultResponse>;
1014
- }
1015
-
1016
- /** Retries a deployment with failed devices. */
1017
- export declare interface DeviceManagementRetryDeployment200Response extends HttpResponse {
1018
- status: "200";
1019
- body: DeploymentOutput;
1020
- }
1021
-
1022
- /** Retries a deployment with failed devices. */
1023
- export declare interface DeviceManagementRetryDeploymentdefaultResponse extends HttpResponse {
1024
- status: string;
1025
- body: ErrorResponseOutput;
1026
- }
1027
-
1028
- export declare type DeviceManagementRetryDeploymentParameters = RequestParameters;
1029
-
1030
- export declare interface DeviceManagementStartLogCollection {
1031
- /** Start the device diagnostics log collection on specified devices. */
1032
- put(options: DeviceManagementStartLogCollectionParameters): StreamableMethod<DeviceManagementStartLogCollection201Response | DeviceManagementStartLogCollectiondefaultResponse>;
1033
- /** Get the device diagnostics log collection */
1034
- get(options?: DeviceManagementGetLogCollectionParameters): StreamableMethod<DeviceManagementGetLogCollection200Response | DeviceManagementGetLogCollectiondefaultResponse>;
1035
- }
1036
-
1037
- /** Start the device diagnostics log collection on specified devices. */
1038
- export declare interface DeviceManagementStartLogCollection201Response extends HttpResponse {
1039
- status: "201";
1040
- body: LogCollectionOutput;
1041
- }
1042
-
1043
- export declare interface DeviceManagementStartLogCollectionBodyParam {
1044
- /** The log collection properties. */
1045
- body: LogCollection;
1046
- }
1047
-
1048
- /** Start the device diagnostics log collection on specified devices. */
1049
- export declare interface DeviceManagementStartLogCollectiondefaultResponse extends HttpResponse {
1050
- status: string;
1051
- body: ErrorResponseOutput;
1052
- }
1053
-
1054
- export declare interface DeviceManagementStartLogCollectionMediaTypesParam {
1055
- /** Request content type */
1056
- contentType?: "application/json";
1057
- }
1058
-
1059
- export declare type DeviceManagementStartLogCollectionParameters = DeviceManagementStartLogCollectionMediaTypesParam & DeviceManagementStartLogCollectionBodyParam & RequestParameters;
1060
-
1061
- export declare interface DeviceManagementStopDeployment {
1062
- /** Stops a deployment. */
1063
- post(options?: DeviceManagementStopDeploymentParameters): StreamableMethod<DeviceManagementStopDeployment200Response | DeviceManagementStopDeploymentdefaultResponse>;
1064
- }
1065
-
1066
- /** Stops a deployment. */
1067
- export declare interface DeviceManagementStopDeployment200Response extends HttpResponse {
1068
- status: "200";
1069
- body: DeploymentOutput;
1070
- }
1071
-
1072
- /** Stops a deployment. */
1073
- export declare interface DeviceManagementStopDeploymentdefaultResponse extends HttpResponse {
1074
- status: string;
1075
- body: ErrorResponseOutput;
1076
- }
1077
-
1078
- export declare type DeviceManagementStopDeploymentParameters = RequestParameters;
1079
-
1080
- /** Update device class details. */
1081
- export declare interface DeviceManagementUpdateDeviceClass200Response extends HttpResponse {
1082
- status: "200";
1083
- body: DeviceClassOutput;
1084
- }
1085
-
1086
- export declare interface DeviceManagementUpdateDeviceClassBodyParam {
1087
- /** The device class json merge patch body. Currently only supports patching friendlyName. */
1088
- body: PatchBody;
1089
- }
1090
-
1091
- /** Update device class details. */
1092
- export declare interface DeviceManagementUpdateDeviceClassdefaultResponse extends HttpResponse {
1093
- status: string;
1094
- body: ErrorResponseOutput;
1095
- }
1096
-
1097
- export declare interface DeviceManagementUpdateDeviceClassMediaTypesParam {
1098
- /** Request content type */
1099
- contentType?: "application/merge-patch+json";
1100
- }
1101
-
1102
- export declare type DeviceManagementUpdateDeviceClassParameters = DeviceManagementUpdateDeviceClassMediaTypesParam & DeviceManagementUpdateDeviceClassBodyParam & RequestParameters;
1103
-
1104
- export declare interface DeviceOperationOutput {
1105
- /** Operation Id. */
1106
- operationId: string;
1107
- /** Operation status. */
1108
- status: "NotStarted" | "Running" | "Succeeded" | "Failed";
1109
- /** Operation error encountered, if any. */
1110
- error?: ErrorModelOutput;
1111
- /** Operation correlation identity that can used by Microsoft Support for troubleshooting. */
1112
- traceId?: string;
1113
- /** Date and time in UTC when the operation status was last updated. */
1114
- lastActionDateTime: string;
1115
- /** Date and time in UTC when the operation was created. */
1116
- createdDateTime: string;
1117
- /** Operation ETag. */
1118
- etag?: string;
1119
- }
1120
-
1121
- export declare interface DeviceOperationsListOutput {
1122
- /** The collection of pageable items. */
1123
- value: Array<DeviceOperationOutput>;
1124
- /** The link to the next page of items. */
1125
- nextLink?: string;
1126
- }
1127
-
1128
- export declare interface DeviceOutput {
1129
- /** Device identity. */
1130
- deviceId: string;
1131
- /** Device module identity. */
1132
- moduleId?: string;
1133
- /** Device class identity. */
1134
- deviceClassId: string;
1135
- /** Device group identity. */
1136
- groupId?: string;
1137
- /** The update that device last attempted to install. */
1138
- lastAttemptedUpdate?: UpdateInfoOutput;
1139
- /** State of the device in its last deployment. */
1140
- deploymentStatus?: "Succeeded" | "InProgress" | "Canceled" | "Failed";
1141
- /** Currently installed update on device. */
1142
- installedUpdate?: UpdateInfoOutput;
1143
- /** Boolean flag indicating whether the latest update (the best compatible update for the device's device class and group) is installed on the device */
1144
- onLatestUpdate: boolean;
1145
- /** The deployment identifier for the last deployment to the device */
1146
- lastDeploymentId?: string;
1147
- /** Last install result. */
1148
- lastInstallResult?: InstallResultOutput;
1149
- }
1150
-
1151
- export declare interface DevicesListOutput {
1152
- /** The collection of pageable items. */
1153
- value: Array<DeviceOutput>;
1154
- /** The link to the next page of items. */
1155
- nextLink?: string;
1156
- }
1157
-
1158
- export declare interface DeviceUpdateAgentId {
1159
- /** Device Id */
1160
- deviceId: string;
1161
- /** Module Id */
1162
- moduleId?: string;
1163
- }
1164
-
1165
- export declare interface DeviceUpdateAgentIdOutput {
1166
- /** Device Id */
1167
- deviceId: string;
1168
- /** Module Id */
1169
- moduleId?: string;
1170
- }
1171
-
1172
- export declare type DeviceUpdateClient = Client & {
1173
- path: Routes;
1174
- };
1175
-
1176
- export declare interface DeviceUpdateDeleteUpdate202Headers {
1177
- /** Url to retrieve the operation status */
1178
- "operation-location"?: string;
1179
- }
1180
-
1181
- /** Delete a specific update version. This is a long-running-operation; use Operation-Location response header value to check for operation status. */
1182
- export declare interface DeviceUpdateDeleteUpdate202Response extends HttpResponse {
1183
- status: "202";
1184
- body: Record<string, unknown>;
1185
- headers: RawHttpHeaders & DeviceUpdateDeleteUpdate202Headers;
1186
- }
1187
-
1188
- /** Delete a specific update version. This is a long-running-operation; use Operation-Location response header value to check for operation status. */
1189
- export declare interface DeviceUpdateDeleteUpdatedefaultResponse extends HttpResponse {
1190
- status: string;
1191
- body: ErrorResponseOutput;
1192
- }
1193
-
1194
- export declare type DeviceUpdateDeleteUpdateParameters = RequestParameters;
1195
-
1196
- export declare interface DeviceUpdateGetFile {
1197
- /** Get a specific update file from the version. */
1198
- get(options?: DeviceUpdateGetFileParameters): StreamableMethod<DeviceUpdateGetFile200Response | DeviceUpdateGetFile304Response | DeviceUpdateGetFiledefaultResponse>;
1199
- }
1200
-
1201
- /** Get a specific update file from the version. */
1202
- export declare interface DeviceUpdateGetFile200Response extends HttpResponse {
1203
- status: "200";
1204
- body: UpdateFileOutput;
1205
- }
1206
-
1207
- /** Get a specific update file from the version. */
1208
- export declare interface DeviceUpdateGetFile304Response extends HttpResponse {
1209
- status: "304";
1210
- body: Record<string, unknown>;
1211
- }
1212
-
1213
- /** Get a specific update file from the version. */
1214
- export declare interface DeviceUpdateGetFiledefaultResponse extends HttpResponse {
1215
- status: string;
1216
- body: ErrorResponseOutput;
1217
- }
1218
-
1219
- export declare interface DeviceUpdateGetFileHeaderParam {
1220
- headers: RawHttpHeadersInput & DeviceUpdateGetFileHeaders;
1221
- }
1222
-
1223
- export declare interface DeviceUpdateGetFileHeaders {
1224
- /** Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. */
1225
- "If-None-Match"?: string;
1226
- }
1227
-
1228
- export declare type DeviceUpdateGetFileParameters = DeviceUpdateGetFileHeaderParam & RequestParameters;
1229
-
1230
- export declare interface DeviceUpdateGetOperationStatus {
1231
- /** Retrieve operation status. */
1232
- get(options?: DeviceUpdateGetOperationStatusParameters): StreamableMethod<DeviceUpdateGetOperationStatus200Response | DeviceUpdateGetOperationStatus304Response | DeviceUpdateGetOperationStatusdefaultResponse>;
1233
- }
1234
-
1235
- export declare interface DeviceUpdateGetOperationStatus200Headers {
1236
- /** Number of seconds to wait before checking the operation status again. */
1237
- "retry-after"?: string;
1238
- }
1239
-
1240
- /** Retrieve operation status. */
1241
- export declare interface DeviceUpdateGetOperationStatus200Response extends HttpResponse {
1242
- status: "200";
1243
- body: UpdateOperationOutput;
1244
- headers: RawHttpHeaders & DeviceUpdateGetOperationStatus200Headers;
1245
- }
1246
-
1247
- /** Retrieve operation status. */
1248
- export declare interface DeviceUpdateGetOperationStatus304Response extends HttpResponse {
1249
- status: "304";
1250
- body: Record<string, unknown>;
1251
- }
1252
-
1253
- /** Retrieve operation status. */
1254
- export declare interface DeviceUpdateGetOperationStatusdefaultResponse extends HttpResponse {
1255
- status: string;
1256
- body: ErrorResponseOutput;
1257
- }
1258
-
1259
- export declare interface DeviceUpdateGetOperationStatusHeaderParam {
1260
- headers: RawHttpHeadersInput & DeviceUpdateGetOperationStatusHeaders;
1261
- }
1262
-
1263
- export declare interface DeviceUpdateGetOperationStatusHeaders {
1264
- /** Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. */
1265
- "If-None-Match"?: string;
1266
- }
1267
-
1268
- export declare type DeviceUpdateGetOperationStatusParameters = DeviceUpdateGetOperationStatusHeaderParam & RequestParameters;
1269
-
1270
- export declare interface DeviceUpdateGetUpdate {
1271
- /** Get a specific update version. */
1272
- get(options?: DeviceUpdateGetUpdateParameters): StreamableMethod<DeviceUpdateGetUpdate200Response | DeviceUpdateGetUpdate304Response | DeviceUpdateGetUpdatedefaultResponse>;
1273
- /** Delete a specific update version. This is a long-running-operation; use Operation-Location response header value to check for operation status. */
1274
- delete(options?: DeviceUpdateDeleteUpdateParameters): StreamableMethod<DeviceUpdateDeleteUpdate202Response | DeviceUpdateDeleteUpdatedefaultResponse>;
1275
- }
1276
-
1277
- /** Get a specific update version. */
1278
- export declare interface DeviceUpdateGetUpdate200Response extends HttpResponse {
1279
- status: "200";
1280
- body: UpdateOutput;
1281
- }
1282
-
1283
- /** Get a specific update version. */
1284
- export declare interface DeviceUpdateGetUpdate304Response extends HttpResponse {
1285
- status: "304";
1286
- body: Record<string, unknown>;
1287
- }
1288
-
1289
- /** Get a specific update version. */
1290
- export declare interface DeviceUpdateGetUpdatedefaultResponse extends HttpResponse {
1291
- status: string;
1292
- body: ErrorResponseOutput;
1293
- }
1294
-
1295
- export declare interface DeviceUpdateGetUpdateHeaderParam {
1296
- headers: RawHttpHeadersInput & DeviceUpdateGetUpdateHeaders;
1297
- }
1298
-
1299
- export declare interface DeviceUpdateGetUpdateHeaders {
1300
- /** Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. */
1301
- "If-None-Match"?: string;
1302
- }
1303
-
1304
- export declare type DeviceUpdateGetUpdateParameters = DeviceUpdateGetUpdateHeaderParam & RequestParameters;
1305
-
1306
- export declare interface DeviceUpdateImportUpdate {
1307
- /** Import new update version. This is a long-running-operation; use Operation-Location response header value to check for operation status. */
1308
- post(options: DeviceUpdateImportUpdateParameters): StreamableMethod<DeviceUpdateImportUpdate200Response | DeviceUpdateImportUpdate202Response | DeviceUpdateImportUpdatedefaultResponse>;
1309
- }
1310
-
1311
- /** Import new update version. This is a long-running-operation; use Operation-Location response header value to check for operation status. */
1312
- export declare interface DeviceUpdateImportUpdate200Response extends HttpResponse {
1313
- status: "200";
1314
- body: UpdateOutput;
1315
- }
1316
-
1317
- export declare interface DeviceUpdateImportUpdate202Headers {
1318
- /** Url to retrieve the import operation status. */
1319
- "operation-location"?: string;
1320
- }
1321
-
1322
- /** Import new update version. This is a long-running-operation; use Operation-Location response header value to check for operation status. */
1323
- export declare interface DeviceUpdateImportUpdate202Response extends HttpResponse {
1324
- status: "202";
1325
- body: Record<string, unknown>;
1326
- headers: RawHttpHeaders & DeviceUpdateImportUpdate202Headers;
1327
- }
1328
-
1329
- export declare interface DeviceUpdateImportUpdateBodyParam {
1330
- /** The update to be imported (see schema https://json.schemastore.org/azure-deviceupdate-import-manifest-5.0.json for details). */
1331
- body: Array<ImportUpdateInputItem>;
1332
- }
1333
-
1334
- /** Import new update version. This is a long-running-operation; use Operation-Location response header value to check for operation status. */
1335
- export declare interface DeviceUpdateImportUpdatedefaultResponse extends HttpResponse {
1336
- status: string;
1337
- body: ErrorResponseOutput;
1338
- }
1339
-
1340
- export declare interface DeviceUpdateImportUpdateMediaTypesParam {
1341
- /** Request content type */
1342
- contentType?: "application/json";
1343
- }
1344
-
1345
- export declare type DeviceUpdateImportUpdateParameters = DeviceUpdateImportUpdateMediaTypesParam & DeviceUpdateImportUpdateBodyParam & RequestParameters;
1346
-
1347
- export declare interface DeviceUpdateListFiles {
1348
- /** Get a list of all update file identifiers for the specified version. */
1349
- get(options?: DeviceUpdateListFilesParameters): StreamableMethod<DeviceUpdateListFiles200Response | DeviceUpdateListFilesdefaultResponse>;
1350
- }
1351
-
1352
- /** Get a list of all update file identifiers for the specified version. */
1353
- export declare interface DeviceUpdateListFiles200Response extends HttpResponse {
1354
- status: "200";
1355
- body: StringsListOutput;
1356
- }
1357
-
1358
- /** Get a list of all update file identifiers for the specified version. */
1359
- export declare interface DeviceUpdateListFilesdefaultResponse extends HttpResponse {
1360
- status: string;
1361
- body: ErrorResponseOutput;
1362
- }
1363
-
1364
- export declare type DeviceUpdateListFilesParameters = RequestParameters;
1365
-
1366
- export declare interface DeviceUpdateListNames {
1367
- /** Get a list of all update names that match the specified provider. */
1368
- get(options?: DeviceUpdateListNamesParameters): StreamableMethod<DeviceUpdateListNames200Response | DeviceUpdateListNamesdefaultResponse>;
1369
- }
1370
-
1371
- /** Get a list of all update names that match the specified provider. */
1372
- export declare interface DeviceUpdateListNames200Response extends HttpResponse {
1373
- status: "200";
1374
- body: StringsListOutput;
1375
- }
1376
-
1377
- /** Get a list of all update names that match the specified provider. */
1378
- export declare interface DeviceUpdateListNamesdefaultResponse extends HttpResponse {
1379
- status: string;
1380
- body: ErrorResponseOutput;
1381
- }
1382
-
1383
- export declare type DeviceUpdateListNamesParameters = RequestParameters;
1384
-
1385
- export declare interface DeviceUpdateListOperationStatuses {
1386
- /** Get a list of all import update operations. Completed operations are kept for 7 days before auto-deleted. Delete operations are not returned by this API version. */
1387
- get(options?: DeviceUpdateListOperationStatusesParameters): StreamableMethod<DeviceUpdateListOperationStatuses200Response | DeviceUpdateListOperationStatusesdefaultResponse>;
1388
- }
1389
-
1390
- /** Get a list of all import update operations. Completed operations are kept for 7 days before auto-deleted. Delete operations are not returned by this API version. */
1391
- export declare interface DeviceUpdateListOperationStatuses200Response extends HttpResponse {
1392
- status: "200";
1393
- body: UpdateOperationsListOutput;
1394
- }
1395
-
1396
- /** Get a list of all import update operations. Completed operations are kept for 7 days before auto-deleted. Delete operations are not returned by this API version. */
1397
- export declare interface DeviceUpdateListOperationStatusesdefaultResponse extends HttpResponse {
1398
- status: string;
1399
- body: ErrorResponseOutput;
1400
- }
1401
-
1402
- export declare type DeviceUpdateListOperationStatusesParameters = DeviceUpdateListOperationStatusesQueryParam & RequestParameters;
1403
-
1404
- export declare interface DeviceUpdateListOperationStatusesQueryParam {
1405
- queryParameters?: DeviceUpdateListOperationStatusesQueryParamProperties;
1406
- }
1407
-
1408
- export declare interface DeviceUpdateListOperationStatusesQueryParamProperties {
1409
- /** Optional to filter operations by status property. Only one specific filter is supported: "status eq 'NotStarted' or status eq 'Running'" */
1410
- filter?: string;
1411
- /** Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n. */
1412
- top?: number;
1413
- }
1414
-
1415
- export declare interface DeviceUpdateListProviders {
1416
- /** Get a list of all update providers that have been imported to Device Update for IoT Hub. */
1417
- get(options?: DeviceUpdateListProvidersParameters): StreamableMethod<DeviceUpdateListProviders200Response | DeviceUpdateListProvidersdefaultResponse>;
1418
- }
1419
-
1420
- /** Get a list of all update providers that have been imported to Device Update for IoT Hub. */
1421
- export declare interface DeviceUpdateListProviders200Response extends HttpResponse {
1422
- status: "200";
1423
- body: StringsListOutput;
1424
- }
1425
-
1426
- /** Get a list of all update providers that have been imported to Device Update for IoT Hub. */
1427
- export declare interface DeviceUpdateListProvidersdefaultResponse extends HttpResponse {
1428
- status: string;
1429
- body: ErrorResponseOutput;
1430
- }
1431
-
1432
- export declare type DeviceUpdateListProvidersParameters = RequestParameters;
1433
-
1434
- export declare interface DeviceUpdateListUpdates {
1435
- /** Get a list of all updates that have been imported to Device Update for IoT Hub. */
1436
- get(options?: DeviceUpdateListUpdatesParameters): StreamableMethod<DeviceUpdateListUpdates200Response | DeviceUpdateListUpdatesdefaultResponse>;
1437
- }
1438
-
1439
- /** Get a list of all updates that have been imported to Device Update for IoT Hub. */
1440
- export declare interface DeviceUpdateListUpdates200Response extends HttpResponse {
1441
- status: "200";
1442
- body: UpdateListOutput;
1443
- }
1444
-
1445
- /** Get a list of all updates that have been imported to Device Update for IoT Hub. */
1446
- export declare interface DeviceUpdateListUpdatesdefaultResponse extends HttpResponse {
1447
- status: string;
1448
- body: ErrorResponseOutput;
1449
- }
1450
-
1451
- export declare type DeviceUpdateListUpdatesParameters = DeviceUpdateListUpdatesQueryParam & RequestParameters;
1452
-
1453
- export declare interface DeviceUpdateListUpdatesQueryParam {
1454
- queryParameters?: DeviceUpdateListUpdatesQueryParamProperties;
1455
- }
1456
-
1457
- export declare interface DeviceUpdateListUpdatesQueryParamProperties {
1458
- /** Request updates matching a free-text search expression. */
1459
- search?: string;
1460
- /** Optional to filter updates by isDeployable property. */
1461
- filter?: string;
1462
- }
1463
-
1464
- export declare interface DeviceUpdateListVersions {
1465
- /** Get a list of all update versions that match the specified provider and name. */
1466
- get(options?: DeviceUpdateListVersionsParameters): StreamableMethod<DeviceUpdateListVersions200Response | DeviceUpdateListVersionsdefaultResponse>;
1467
- }
1468
-
1469
- /** Get a list of all update versions that match the specified provider and name. */
1470
- export declare interface DeviceUpdateListVersions200Response extends HttpResponse {
1471
- status: "200";
1472
- body: StringsListOutput;
1473
- }
1474
-
1475
- /** Get a list of all update versions that match the specified provider and name. */
1476
- export declare interface DeviceUpdateListVersionsdefaultResponse extends HttpResponse {
1477
- status: string;
1478
- body: ErrorResponseOutput;
1479
- }
1480
-
1481
- export declare type DeviceUpdateListVersionsParameters = DeviceUpdateListVersionsQueryParam & RequestParameters;
1482
-
1483
- export declare interface DeviceUpdateListVersionsQueryParam {
1484
- queryParameters?: DeviceUpdateListVersionsQueryParamProperties;
1485
- }
1486
-
1487
- export declare interface DeviceUpdateListVersionsQueryParamProperties {
1488
- /** Optional to filter updates by isDeployable property. */
1489
- filter?: string;
1490
- }
1491
-
1492
- export declare interface ErrorModelOutput {
1493
- /** Server defined error code. */
1494
- code: string;
1495
- /** A human-readable representation of the error. */
1496
- message: string;
1497
- /** The target of the error. */
1498
- target?: string;
1499
- /** An array of errors that led to the reported error. */
1500
- details?: Array<ErrorModelOutput>;
1501
- /** An object containing more specific information than the current object about the error. */
1502
- innererror?: InnerErrorOutput;
1503
- /** Date and time in UTC when the error occurred. */
1504
- occurredDateTime?: string;
1505
- }
1506
-
1507
- export declare interface ErrorResponseOutput {
1508
- /** The error details. */
1509
- error: ErrorModelOutput;
1510
- }
1511
-
1512
- export declare interface FileImportMetadata {
1513
- /** Update file name as specified inside import manifest. */
1514
- filename: string;
1515
- /** Azure Blob location from which the update file can be downloaded by Device Update for IoT Hub. This is typically a read-only SAS-protected blob URL with an expiration set to at least 4 hours. */
1516
- url: string;
1517
- }
1518
-
1519
- /**
1520
- * Helper type to extract the type of an array
1521
- */
1522
- export declare type GetArrayType<T> = T extends Array<infer TData> ? TData : never;
1523
-
1524
- /**
1525
- * Helper function that builds a Poller object to help polling a long running operation.
1526
- * @param client - Client to use for sending the request to get additional pages.
1527
- * @param initialResponse - The initial response.
1528
- * @param options - Options to set a resume state or custom polling interval.
1529
- * @returns - A poller object to poll for operation state updates and eventually get the final response.
1530
- */
1531
- export declare function getLongRunningPoller<TResult extends HttpResponse>(client: Client, initialResponse: TResult, options?: LroEngineOptions<TResult, PollOperationState<TResult>>): PollerLike<PollOperationState<TResult>, TResult>;
1532
-
1533
- /**
1534
- * The type of a custom function that defines how to get a page and a link to the next one if any.
1535
- */
1536
- export declare type GetPage<TPage> = (pageLink: string, maxPageSize?: number) => Promise<{
1537
- page: TPage;
1538
- nextPageLink?: string;
1539
- }>;
1540
-
1541
- export declare interface GroupOutput {
1542
- /** 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. */
1543
- groupId: string;
1544
- /** Group type. */
1545
- groupType: "IoTHubTag" | "DefaultNoTag";
1546
- /** Date and time when the update was created. */
1547
- createdDateTime: string;
1548
- /** The number of devices in the group. */
1549
- deviceCount?: number;
1550
- /** The count of subgroups with new updates available. */
1551
- subgroupsWithNewUpdatesAvailableCount?: number;
1552
- /** The count of subgroups with updates in progress. */
1553
- subgroupsWithUpdatesInProgressCount?: number;
1554
- /** The count of subgroups with devices on the latest update. */
1555
- subgroupsWithOnLatestUpdateCount?: number;
1556
- /** The active deployment Ids for the group */
1557
- deployments?: Array<string>;
1558
- }
1559
-
1560
- export declare interface GroupsListOutput {
1561
- /** The collection of pageable items. */
1562
- value: Array<GroupOutput>;
1563
- /** The link to the next page of items. */
1564
- nextLink?: string;
1565
- }
1566
-
1567
- export declare interface HealthCheckOutput {
1568
- /** Health check name */
1569
- name?: string;
1570
- /** Health check result */
1571
- result?: "success" | "userError";
1572
- }
1573
-
1574
- export declare interface ImportManifestMetadata {
1575
- /** Azure Blob location from which the import manifest can be downloaded by Device Update for IoT Hub. This is typically a read-only SAS-protected blob URL with an expiration set to at least 4 hours. */
1576
- url: string;
1577
- /** File size in number of bytes. */
1578
- sizeInBytes: number;
1579
- /** A JSON object containing the hash(es) of the file. At least SHA256 hash is required. This object can be thought of as a set of key-value pairs where the key is the hash algorithm, and the value is the hash of the file calculated using that algorithm. */
1580
- hashes: Record<string, string>;
1581
- }
1582
-
1583
- export declare interface ImportUpdateInputItem {
1584
- /** Import manifest metadata like source URL, file size/hashes, etc. */
1585
- importManifest: ImportManifestMetadata;
1586
- /** Friendly update name. */
1587
- friendlyName?: string;
1588
- /** One or more update file properties like filename and source URL. */
1589
- files?: Array<FileImportMetadata>;
1590
- }
1591
-
1592
- export declare interface InnerErrorOutput {
1593
- /** A more specific error code than what was provided by the containing error. */
1594
- code: string;
1595
- /** A human-readable representation of the error. */
1596
- message?: string;
1597
- /** The internal error or exception message. */
1598
- errorDetail?: string;
1599
- /** An object containing more specific information than the current object about the error. */
1600
- innerError?: InnerErrorOutput;
1601
- }
1602
-
1603
- export declare interface InstallResultOutput {
1604
- /** Install result code. */
1605
- resultCode: number;
1606
- /** Install extended result code */
1607
- extendedResultCode: number;
1608
- /** A string containing further details about the install result */
1609
- resultDetails?: string;
1610
- /** Array of step results */
1611
- stepResults?: Array<StepResultOutput>;
1612
- }
1613
-
1614
- export declare interface InstructionsOutput {
1615
- /** Collection of installation steps. */
1616
- steps: Array<StepOutput>;
1617
- }
1618
-
1619
- export declare function isUnexpected(response: DeviceUpdateListUpdates200Response | DeviceUpdateListUpdatesdefaultResponse): response is DeviceUpdateListUpdatesdefaultResponse;
1620
-
1621
- export declare function isUnexpected(response: DeviceUpdateImportUpdate200Response | DeviceUpdateImportUpdate202Response | DeviceUpdateImportUpdatedefaultResponse): response is DeviceUpdateImportUpdatedefaultResponse;
1622
-
1623
- export declare function isUnexpected(response: DeviceUpdateGetUpdate200Response | DeviceUpdateGetUpdate304Response | DeviceUpdateGetUpdatedefaultResponse): response is DeviceUpdateGetUpdatedefaultResponse;
1624
-
1625
- export declare function isUnexpected(response: DeviceUpdateDeleteUpdate202Response | DeviceUpdateDeleteUpdatedefaultResponse): response is DeviceUpdateDeleteUpdatedefaultResponse;
1626
-
1627
- export declare function isUnexpected(response: DeviceUpdateListProviders200Response | DeviceUpdateListProvidersdefaultResponse): response is DeviceUpdateListProvidersdefaultResponse;
1628
-
1629
- export declare function isUnexpected(response: DeviceUpdateListNames200Response | DeviceUpdateListNamesdefaultResponse): response is DeviceUpdateListNamesdefaultResponse;
1630
-
1631
- export declare function isUnexpected(response: DeviceUpdateListVersions200Response | DeviceUpdateListVersionsdefaultResponse): response is DeviceUpdateListVersionsdefaultResponse;
1632
-
1633
- export declare function isUnexpected(response: DeviceUpdateListFiles200Response | DeviceUpdateListFilesdefaultResponse): response is DeviceUpdateListFilesdefaultResponse;
1634
-
1635
- export declare function isUnexpected(response: DeviceUpdateGetFile200Response | DeviceUpdateGetFile304Response | DeviceUpdateGetFiledefaultResponse): response is DeviceUpdateGetFiledefaultResponse;
1636
-
1637
- export declare function isUnexpected(response: DeviceUpdateListOperationStatuses200Response | DeviceUpdateListOperationStatusesdefaultResponse): response is DeviceUpdateListOperationStatusesdefaultResponse;
1638
-
1639
- export declare function isUnexpected(response: DeviceUpdateGetOperationStatus200Response | DeviceUpdateGetOperationStatus304Response | DeviceUpdateGetOperationStatusdefaultResponse): response is DeviceUpdateGetOperationStatusdefaultResponse;
1640
-
1641
- export declare function isUnexpected(response: DeviceManagementListDeviceClasses200Response | DeviceManagementListDeviceClassesdefaultResponse): response is DeviceManagementListDeviceClassesdefaultResponse;
1642
-
1643
- export declare function isUnexpected(response: DeviceManagementGetDeviceClass200Response | DeviceManagementGetDeviceClassdefaultResponse): response is DeviceManagementGetDeviceClassdefaultResponse;
1644
-
1645
- export declare function isUnexpected(response: DeviceManagementUpdateDeviceClass200Response | DeviceManagementUpdateDeviceClassdefaultResponse): response is DeviceManagementUpdateDeviceClassdefaultResponse;
1646
-
1647
- export declare function isUnexpected(response: DeviceManagementDeleteDeviceClass204Response | DeviceManagementDeleteDeviceClassdefaultResponse): response is DeviceManagementDeleteDeviceClassdefaultResponse;
1648
-
1649
- export declare function isUnexpected(response: DeviceManagementListInstallableUpdatesForDeviceClass200Response | DeviceManagementListInstallableUpdatesForDeviceClassdefaultResponse): response is DeviceManagementListInstallableUpdatesForDeviceClassdefaultResponse;
1650
-
1651
- export declare function isUnexpected(response: DeviceManagementListDevices200Response | DeviceManagementListDevicesdefaultResponse): response is DeviceManagementListDevicesdefaultResponse;
1652
-
1653
- export declare function isUnexpected(response: DeviceManagementImportDevices202Response | DeviceManagementImportDevicesdefaultResponse): response is DeviceManagementImportDevicesdefaultResponse;
1654
-
1655
- export declare function isUnexpected(response: DeviceManagementGetDevice200Response | DeviceManagementGetDevicedefaultResponse): response is DeviceManagementGetDevicedefaultResponse;
1656
-
1657
- export declare function isUnexpected(response: DeviceManagementGetDeviceModule200Response | DeviceManagementGetDeviceModuledefaultResponse): response is DeviceManagementGetDeviceModuledefaultResponse;
1658
-
1659
- export declare function isUnexpected(response: DeviceManagementGetUpdateCompliance200Response | DeviceManagementGetUpdateCompliancedefaultResponse): response is DeviceManagementGetUpdateCompliancedefaultResponse;
1660
-
1661
- export declare function isUnexpected(response: DeviceManagementListGroups200Response | DeviceManagementListGroupsdefaultResponse): response is DeviceManagementListGroupsdefaultResponse;
1662
-
1663
- export declare function isUnexpected(response: DeviceManagementGetGroup200Response | DeviceManagementGetGroupdefaultResponse): response is DeviceManagementGetGroupdefaultResponse;
1664
-
1665
- export declare function isUnexpected(response: DeviceManagementDeleteGroup204Response | DeviceManagementDeleteGroupdefaultResponse): response is DeviceManagementDeleteGroupdefaultResponse;
1666
-
1667
- export declare function isUnexpected(response: DeviceManagementGetUpdateComplianceForGroup200Response | DeviceManagementGetUpdateComplianceForGroupdefaultResponse): response is DeviceManagementGetUpdateComplianceForGroupdefaultResponse;
1668
-
1669
- export declare function isUnexpected(response: DeviceManagementListBestUpdatesForGroup200Response | DeviceManagementListBestUpdatesForGroupdefaultResponse): response is DeviceManagementListBestUpdatesForGroupdefaultResponse;
1670
-
1671
- export declare function isUnexpected(response: DeviceManagementListDeploymentsForGroup200Response | DeviceManagementListDeploymentsForGroupdefaultResponse): response is DeviceManagementListDeploymentsForGroupdefaultResponse;
1672
-
1673
- export declare function isUnexpected(response: DeviceManagementGetDeployment200Response | DeviceManagementGetDeploymentdefaultResponse): response is DeviceManagementGetDeploymentdefaultResponse;
1674
-
1675
- export declare function isUnexpected(response: DeviceManagementCreateOrUpdateDeployment200Response | DeviceManagementCreateOrUpdateDeploymentdefaultResponse): response is DeviceManagementCreateOrUpdateDeploymentdefaultResponse;
1676
-
1677
- export declare function isUnexpected(response: DeviceManagementDeleteDeployment204Response | DeviceManagementDeleteDeploymentdefaultResponse): response is DeviceManagementDeleteDeploymentdefaultResponse;
1678
-
1679
- export declare function isUnexpected(response: DeviceManagementGetDeploymentStatus200Response | DeviceManagementGetDeploymentStatusdefaultResponse): response is DeviceManagementGetDeploymentStatusdefaultResponse;
1680
-
1681
- export declare function isUnexpected(response: DeviceManagementListDeviceClassSubgroupsForGroup200Response | DeviceManagementListDeviceClassSubgroupsForGroupdefaultResponse): response is DeviceManagementListDeviceClassSubgroupsForGroupdefaultResponse;
1682
-
1683
- export declare function isUnexpected(response: DeviceManagementGetDeviceClassSubgroup200Response | DeviceManagementGetDeviceClassSubgroupdefaultResponse): response is DeviceManagementGetDeviceClassSubgroupdefaultResponse;
1684
-
1685
- export declare function isUnexpected(response: DeviceManagementDeleteDeviceClassSubgroup204Response | DeviceManagementDeleteDeviceClassSubgroupdefaultResponse): response is DeviceManagementDeleteDeviceClassSubgroupdefaultResponse;
1686
-
1687
- export declare function isUnexpected(response: DeviceManagementGetDeviceClassSubgroupUpdateCompliance200Response | DeviceManagementGetDeviceClassSubgroupUpdateCompliancedefaultResponse): response is DeviceManagementGetDeviceClassSubgroupUpdateCompliancedefaultResponse;
1688
-
1689
- export declare function isUnexpected(response: DeviceManagementGetBestUpdatesForDeviceClassSubgroup200Response | DeviceManagementGetBestUpdatesForDeviceClassSubgroupdefaultResponse): response is DeviceManagementGetBestUpdatesForDeviceClassSubgroupdefaultResponse;
1690
-
1691
- export declare function isUnexpected(response: DeviceManagementListDeploymentsForDeviceClassSubgroup200Response | DeviceManagementListDeploymentsForDeviceClassSubgroupdefaultResponse): response is DeviceManagementListDeploymentsForDeviceClassSubgroupdefaultResponse;
1692
-
1693
- export declare function isUnexpected(response: DeviceManagementGetDeploymentForDeviceClassSubgroup200Response | DeviceManagementGetDeploymentForDeviceClassSubgroupdefaultResponse): response is DeviceManagementGetDeploymentForDeviceClassSubgroupdefaultResponse;
1694
-
1695
- export declare function isUnexpected(response: DeviceManagementDeleteDeploymentForDeviceClassSubgroup204Response | DeviceManagementDeleteDeploymentForDeviceClassSubgroupdefaultResponse): response is DeviceManagementDeleteDeploymentForDeviceClassSubgroupdefaultResponse;
1696
-
1697
- export declare function isUnexpected(response: DeviceManagementStopDeployment200Response | DeviceManagementStopDeploymentdefaultResponse): response is DeviceManagementStopDeploymentdefaultResponse;
1698
-
1699
- export declare function isUnexpected(response: DeviceManagementRetryDeployment200Response | DeviceManagementRetryDeploymentdefaultResponse): response is DeviceManagementRetryDeploymentdefaultResponse;
1700
-
1701
- export declare function isUnexpected(response: DeviceManagementGetDeviceClassSubgroupDeploymentStatus200Response | DeviceManagementGetDeviceClassSubgroupDeploymentStatusdefaultResponse): response is DeviceManagementGetDeviceClassSubgroupDeploymentStatusdefaultResponse;
1702
-
1703
- export declare function isUnexpected(response: DeviceManagementListDeviceStatesForDeviceClassSubgroupDeployment200Response | DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentdefaultResponse): response is DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentdefaultResponse;
1704
-
1705
- export declare function isUnexpected(response: DeviceManagementGetOperationStatus200Response | DeviceManagementGetOperationStatus304Response | DeviceManagementGetOperationStatusdefaultResponse): response is DeviceManagementGetOperationStatusdefaultResponse;
1706
-
1707
- export declare function isUnexpected(response: DeviceManagementListOperationStatuses200Response | DeviceManagementListOperationStatusesdefaultResponse): response is DeviceManagementListOperationStatusesdefaultResponse;
1708
-
1709
- export declare function isUnexpected(response: DeviceManagementStartLogCollection201Response | DeviceManagementStartLogCollectiondefaultResponse): response is DeviceManagementStartLogCollectiondefaultResponse;
1710
-
1711
- export declare function isUnexpected(response: DeviceManagementGetLogCollection200Response | DeviceManagementGetLogCollectiondefaultResponse): response is DeviceManagementGetLogCollectiondefaultResponse;
1712
-
1713
- export declare function isUnexpected(response: DeviceManagementListLogCollections200Response | DeviceManagementListLogCollectionsdefaultResponse): response is DeviceManagementListLogCollectionsdefaultResponse;
1714
-
1715
- export declare function isUnexpected(response: DeviceManagementGetLogCollectionDetailedStatus200Response | DeviceManagementGetLogCollectionDetailedStatusdefaultResponse): response is DeviceManagementGetLogCollectionDetailedStatusdefaultResponse;
1716
-
1717
- export declare function isUnexpected(response: DeviceManagementListHealthOfDevices200Response | DeviceManagementListHealthOfDevicesdefaultResponse): response is DeviceManagementListHealthOfDevicesdefaultResponse;
1718
-
1719
- export declare interface LogCollection {
1720
- /** The log collection id. */
1721
- operationId?: string;
1722
- /** Array of Device Update agent ids */
1723
- deviceList: Array<DeviceUpdateAgentId>;
1724
- /** Description of the diagnostics operation. */
1725
- description?: string;
1726
- /** The timestamp when the operation was created. */
1727
- createdDateTime?: string;
1728
- /** A timestamp for when the current state was entered. */
1729
- lastActionDateTime?: string;
1730
- /** Operation status. */
1731
- status?: "NotStarted" | "Running" | "Succeeded" | "Failed";
1732
- }
1733
-
1734
- export declare interface LogCollectionListOutput {
1735
- /** The collection of pageable items. */
1736
- value: Array<LogCollectionOutput>;
1737
- /** The link to the next page of items. */
1738
- nextLink?: string;
1739
- }
1740
-
1741
- export declare interface LogCollectionOperationDetailedStatusOutput {
1742
- /** The device diagnostics operation id. */
1743
- operationId?: string;
1744
- /** The timestamp when the operation was created. */
1745
- createdDateTime?: string;
1746
- /** A timestamp for when the current state was entered. */
1747
- lastActionDateTime?: string;
1748
- /** Operation status. */
1749
- status?: "NotStarted" | "Running" | "Succeeded" | "Failed";
1750
- /** Status of the devices in the operation */
1751
- deviceStatus?: Array<LogCollectionOperationDeviceStatusOutput>;
1752
- /** Device diagnostics operation description. */
1753
- description?: string;
1754
- }
1755
-
1756
- export declare interface LogCollectionOperationDeviceStatusOutput {
1757
- /** Device id */
1758
- deviceId: string;
1759
- /** Module id. */
1760
- moduleId?: string;
1761
- /** Log upload status */
1762
- status: "NotStarted" | "Running" | "Succeeded" | "Failed";
1763
- /** Log upload result code */
1764
- resultCode?: string;
1765
- /** Log upload extended result code */
1766
- extendedResultCode?: string;
1767
- /** Log upload location */
1768
- logLocation?: string;
1769
- }
1770
-
1771
- export declare interface LogCollectionOutput {
1772
- /** The log collection id. */
1773
- operationId?: string;
1774
- /** Array of Device Update agent ids */
1775
- deviceList: Array<DeviceUpdateAgentIdOutput>;
1776
- /** Description of the diagnostics operation. */
1777
- description?: string;
1778
- /** The timestamp when the operation was created. */
1779
- createdDateTime?: string;
1780
- /** A timestamp for when the current state was entered. */
1781
- lastActionDateTime?: string;
1782
- /** Operation status. */
1783
- status?: "NotStarted" | "Running" | "Succeeded" | "Failed";
1784
- }
1785
-
1786
- /**
1787
- * Helper to paginate results from an initial response that follows the specification of Autorest `x-ms-pageable` extension
1788
- * @param client - Client to use for sending the next page requests
1789
- * @param initialResponse - Initial response containing the nextLink and current page of elements
1790
- * @param customGetPage - Optional - Function to define how to extract the page and next link to be used to paginate the results
1791
- * @returns - PagedAsyncIterableIterator to iterate the elements
1792
- */
1793
- export declare function paginate<TResponse extends PathUncheckedResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>;
1794
-
1795
- /**
1796
- * Helper type to infer the Type of the paged elements from the response type
1797
- * This type is generated based on the swagger information for x-ms-pageable
1798
- * specifically on the itemName property which indicates the property of the response
1799
- * where the page items are found. The default value is `value`.
1800
- * This type will allow us to provide strongly typed Iterator based on the response we get as second parameter
1801
- */
1802
- export declare type PaginateReturn<TResult> = TResult extends {
1803
- body: {
1804
- value?: infer TPage;
1805
- };
1806
- } ? GetArrayType<TPage> : Array<unknown>;
1807
-
1808
- /**
1809
- * Options for the paging helper
1810
- */
1811
- export declare interface PagingOptions<TResponse> {
1812
- /**
1813
- * Custom function to extract pagination details for crating the PagedAsyncIterableIterator
1814
- */
1815
- customGetPage?: GetPage<PaginateReturn<TResponse>[]>;
1816
- }
1817
-
1818
- export declare interface PatchBody {
1819
- /** The device class friendly name. Friendly name can be 1-100 characters, alphanumeric, dot, and dash. */
1820
- friendlyName: string;
1821
- }
1822
-
1823
- export declare interface Routes {
1824
- /** Resource for '/deviceUpdate/\{instanceId\}/updates' has methods for the following verbs: get */
1825
- (path: "/deviceUpdate/{instanceId}/updates", instanceId: string): DeviceUpdateListUpdates;
1826
- /** Resource for '/deviceUpdate/\{instanceId\}/updates:import' has methods for the following verbs: post */
1827
- (path: "/deviceUpdate/{instanceId}/updates:import", instanceId: string): DeviceUpdateImportUpdate;
1828
- /** Resource for '/deviceUpdate/\{instanceId\}/updates/providers/\{provider\}/names/\{name\}/versions/\{version\}' has methods for the following verbs: get, delete */
1829
- (path: "/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions/{version}", instanceId: string, provider: string, name: string, version: string): DeviceUpdateGetUpdate;
1830
- /** Resource for '/deviceUpdate/\{instanceId\}/updates/providers' has methods for the following verbs: get */
1831
- (path: "/deviceUpdate/{instanceId}/updates/providers", instanceId: string): DeviceUpdateListProviders;
1832
- /** Resource for '/deviceUpdate/\{instanceId\}/updates/providers/\{provider\}/names' has methods for the following verbs: get */
1833
- (path: "/deviceUpdate/{instanceId}/updates/providers/{provider}/names", instanceId: string, provider: string): DeviceUpdateListNames;
1834
- /** Resource for '/deviceUpdate/\{instanceId\}/updates/providers/\{provider\}/names/\{name\}/versions' has methods for the following verbs: get */
1835
- (path: "/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions", instanceId: string, provider: string, name: string): DeviceUpdateListVersions;
1836
- /** Resource for '/deviceUpdate/\{instanceId\}/updates/providers/\{provider\}/names/\{name\}/versions/\{version\}/files' has methods for the following verbs: get */
1837
- (path: "/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions/{version}/files", instanceId: string, provider: string, name: string, version: string): DeviceUpdateListFiles;
1838
- /** Resource for '/deviceUpdate/\{instanceId\}/updates/providers/\{provider\}/names/\{name\}/versions/\{version\}/files/\{fileId\}' has methods for the following verbs: get */
1839
- (path: "/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions/{version}/files/{fileId}", instanceId: string, provider: string, name: string, version: string, fileId: string): DeviceUpdateGetFile;
1840
- /** Resource for '/deviceUpdate/\{instanceId\}/updates/operations' has methods for the following verbs: get */
1841
- (path: "/deviceUpdate/{instanceId}/updates/operations", instanceId: string): DeviceUpdateListOperationStatuses;
1842
- /** Resource for '/deviceUpdate/\{instanceId\}/updates/operations/\{operationId\}' has methods for the following verbs: get */
1843
- (path: "/deviceUpdate/{instanceId}/updates/operations/{operationId}", instanceId: string, operationId: string): DeviceUpdateGetOperationStatus;
1844
- /** Resource for '/deviceUpdate/\{instanceId\}/management/deviceClasses' has methods for the following verbs: get */
1845
- (path: "/deviceUpdate/{instanceId}/management/deviceClasses", instanceId: string): DeviceManagementListDeviceClasses;
1846
- /** Resource for '/deviceUpdate/\{instanceId\}/management/deviceClasses/\{deviceClassId\}' has methods for the following verbs: get, patch, delete */
1847
- (path: "/deviceUpdate/{instanceId}/management/deviceClasses/{deviceClassId}", instanceId: string, deviceClassId: string): DeviceManagementGetDeviceClass;
1848
- /** Resource for '/deviceUpdate/\{instanceId\}/management/deviceClasses/\{deviceClassId\}/installableUpdates' has methods for the following verbs: get */
1849
- (path: "/deviceUpdate/{instanceId}/management/deviceClasses/{deviceClassId}/installableUpdates", instanceId: string, deviceClassId: string): DeviceManagementListInstallableUpdatesForDeviceClass;
1850
- /** Resource for '/deviceUpdate/\{instanceId\}/management/devices' has methods for the following verbs: get */
1851
- (path: "/deviceUpdate/{instanceId}/management/devices", instanceId: string): DeviceManagementListDevices;
1852
- /** Resource for '/deviceUpdate/\{instanceId\}/management/devices:import' has methods for the following verbs: post */
1853
- (path: "/deviceUpdate/{instanceId}/management/devices:import", instanceId: string): DeviceManagementImportDevices;
1854
- /** Resource for '/deviceUpdate/\{instanceId\}/management/devices/\{deviceId\}' has methods for the following verbs: get */
1855
- (path: "/deviceUpdate/{instanceId}/management/devices/{deviceId}", instanceId: string, deviceId: string): DeviceManagementGetDevice;
1856
- /** Resource for '/deviceUpdate/\{instanceId\}/management/devices/\{deviceId\}/modules/\{moduleId\}' has methods for the following verbs: get */
1857
- (path: "/deviceUpdate/{instanceId}/management/devices/{deviceId}/modules/{moduleId}", instanceId: string, deviceId: string, moduleId: string): DeviceManagementGetDeviceModule;
1858
- /** Resource for '/deviceUpdate/\{instanceId\}/management/updateCompliance' has methods for the following verbs: get */
1859
- (path: "/deviceUpdate/{instanceId}/management/updateCompliance", instanceId: string): DeviceManagementGetUpdateCompliance;
1860
- /** Resource for '/deviceUpdate/\{instanceId\}/management/groups' has methods for the following verbs: get */
1861
- (path: "/deviceUpdate/{instanceId}/management/groups", instanceId: string): DeviceManagementListGroups;
1862
- /** Resource for '/deviceUpdate/\{instanceId\}/management/groups/\{groupId\}' has methods for the following verbs: get, delete */
1863
- (path: "/deviceUpdate/{instanceId}/management/groups/{groupId}", instanceId: string, groupId: string): DeviceManagementGetGroup;
1864
- /** Resource for '/deviceUpdate/\{instanceId\}/management/groups/\{groupId\}/updateCompliance' has methods for the following verbs: get */
1865
- (path: "/deviceUpdate/{instanceId}/management/groups/{groupId}/updateCompliance", instanceId: string, groupId: string): DeviceManagementGetUpdateComplianceForGroup;
1866
- /** Resource for '/deviceUpdate/\{instanceId\}/management/groups/\{groupId\}/bestUpdates' has methods for the following verbs: get */
1867
- (path: "/deviceUpdate/{instanceId}/management/groups/{groupId}/bestUpdates", instanceId: string, groupId: string): DeviceManagementListBestUpdatesForGroup;
1868
- /** Resource for '/deviceUpdate/\{instanceId\}/management/groups/\{groupId\}/deployments' has methods for the following verbs: get */
1869
- (path: "/deviceUpdate/{instanceId}/management/groups/{groupId}/deployments", instanceId: string, groupId: string): DeviceManagementListDeploymentsForGroup;
1870
- /** Resource for '/deviceUpdate/\{instanceId\}/management/groups/\{groupId\}/deployments/\{deploymentId\}' has methods for the following verbs: get, put, delete */
1871
- (path: "/deviceUpdate/{instanceId}/management/groups/{groupId}/deployments/{deploymentId}", instanceId: string, groupId: string, deploymentId: string): DeviceManagementGetDeployment;
1872
- /** Resource for '/deviceUpdate/\{instanceId\}/management/groups/\{groupId\}/deployments/\{deploymentId\}/status' has methods for the following verbs: get */
1873
- (path: "/deviceUpdate/{instanceId}/management/groups/{groupId}/deployments/{deploymentId}/status", instanceId: string, groupId: string, deploymentId: string): DeviceManagementGetDeploymentStatus;
1874
- /** Resource for '/deviceUpdate/\{instanceId\}/management/groups/\{groupId\}/deviceClassSubgroups' has methods for the following verbs: get */
1875
- (path: "/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups", instanceId: string, groupId: string): DeviceManagementListDeviceClassSubgroupsForGroup;
1876
- /** Resource for '/deviceUpdate/\{instanceId\}/management/groups/\{groupId\}/deviceClassSubgroups/\{deviceClassId\}' has methods for the following verbs: get, delete */
1877
- (path: "/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}", instanceId: string, groupId: string, deviceClassId: string): DeviceManagementGetDeviceClassSubgroup;
1878
- /** Resource for '/deviceUpdate/\{instanceId\}/management/groups/\{groupId\}/deviceClassSubgroups/\{deviceClassId\}/updateCompliance' has methods for the following verbs: get */
1879
- (path: "/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/updateCompliance", instanceId: string, groupId: string, deviceClassId: string): DeviceManagementGetDeviceClassSubgroupUpdateCompliance;
1880
- /** Resource for '/deviceUpdate/\{instanceId\}/management/groups/\{groupId\}/deviceClassSubgroups/\{deviceClassId\}/bestUpdates' has methods for the following verbs: get */
1881
- (path: "/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/bestUpdates", instanceId: string, groupId: string, deviceClassId: string): DeviceManagementGetBestUpdatesForDeviceClassSubgroup;
1882
- /** Resource for '/deviceUpdate/\{instanceId\}/management/groups/\{groupId\}/deviceClassSubgroups/\{deviceClassId\}/deployments' has methods for the following verbs: get */
1883
- (path: "/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/deployments", instanceId: string, groupId: string, deviceClassId: string): DeviceManagementListDeploymentsForDeviceClassSubgroup;
1884
- /** Resource for '/deviceUpdate/\{instanceId\}/management/groups/\{groupId\}/deviceClassSubgroups/\{deviceClassId\}/deployments/\{deploymentId\}' has methods for the following verbs: get, delete */
1885
- (path: "/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/deployments/{deploymentId}", instanceId: string, groupId: string, deviceClassId: string, deploymentId: string): DeviceManagementGetDeploymentForDeviceClassSubgroup;
1886
- /** Resource for '/deviceUpdate/\{instanceId\}/management/groups/\{groupId\}/deviceClassSubgroups/\{deviceClassId\}/deployments/\{deploymentId\}:cancel' has methods for the following verbs: post */
1887
- (path: "/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/deployments/{deploymentId}:cancel", instanceId: string, groupId: string, deviceClassId: string, deploymentId: string): DeviceManagementStopDeployment;
1888
- /** Resource for '/deviceUpdate/\{instanceId\}/management/groups/\{groupId\}/deviceClassSubgroups/\{deviceClassId\}/deployments/\{deploymentId\}:retry' has methods for the following verbs: post */
1889
- (path: "/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/deployments/{deploymentId}:retry", instanceId: string, groupId: string, deviceClassId: string, deploymentId: string): DeviceManagementRetryDeployment;
1890
- /** Resource for '/deviceUpdate/\{instanceId\}/management/groups/\{groupId\}/deviceClassSubgroups/\{deviceClassId\}/deployments/\{deploymentId\}/status' has methods for the following verbs: get */
1891
- (path: "/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/deployments/{deploymentId}/status", instanceId: string, groupId: string, deviceClassId: string, deploymentId: string): DeviceManagementGetDeviceClassSubgroupDeploymentStatus;
1892
- /** Resource for '/deviceUpdate/\{instanceId\}/management/groups/\{groupId\}/deviceClassSubgroups/\{deviceClassId\}/deployments/\{deploymentId\}/devicestates' has methods for the following verbs: get */
1893
- (path: "/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/deployments/{deploymentId}/devicestates", instanceId: string, groupId: string, deviceClassId: string, deploymentId: string): DeviceManagementListDeviceStatesForDeviceClassSubgroupDeployment;
1894
- /** Resource for '/deviceUpdate/\{instanceId\}/management/operations/\{operationId\}' has methods for the following verbs: get */
1895
- (path: "/deviceUpdate/{instanceId}/management/operations/{operationId}", instanceId: string, operationId: string): DeviceManagementGetOperationStatus;
1896
- /** Resource for '/deviceUpdate/\{instanceId\}/management/operations' has methods for the following verbs: get */
1897
- (path: "/deviceUpdate/{instanceId}/management/operations", instanceId: string): DeviceManagementListOperationStatuses;
1898
- /** Resource for '/deviceUpdate/\{instanceId\}/management/deviceDiagnostics/logCollections/\{operationId\}' has methods for the following verbs: put, get */
1899
- (path: "/deviceUpdate/{instanceId}/management/deviceDiagnostics/logCollections/{operationId}", instanceId: string, operationId: string): DeviceManagementStartLogCollection;
1900
- /** Resource for '/deviceUpdate/\{instanceId\}/management/deviceDiagnostics/logCollections' has methods for the following verbs: get */
1901
- (path: "/deviceUpdate/{instanceId}/management/deviceDiagnostics/logCollections", instanceId: string): DeviceManagementListLogCollections;
1902
- /** Resource for '/deviceUpdate/\{instanceId\}/management/deviceDiagnostics/logCollections/\{operationId\}/detailedStatus' has methods for the following verbs: get */
1903
- (path: "/deviceUpdate/{instanceId}/management/deviceDiagnostics/logCollections/{operationId}/detailedStatus", instanceId: string, operationId: string): DeviceManagementGetLogCollectionDetailedStatus;
1904
- /** Resource for '/deviceUpdate/\{instanceId\}/management/deviceDiagnostics/deviceHealth' has methods for the following verbs: get */
1905
- (path: "/deviceUpdate/{instanceId}/management/deviceDiagnostics/deviceHealth", instanceId: string): DeviceManagementListHealthOfDevices;
1906
- }
1907
-
1908
- export declare interface StepOutput {
1909
- /** Step type. */
1910
- type?: "Inline" | "Reference";
1911
- /** Step description. */
1912
- description?: string;
1913
- /** Identity of handler that will execute this step. Required if step type is inline. */
1914
- handler?: string;
1915
- /** Parameters to be passed to handler during execution. */
1916
- handlerProperties?: Record<string, unknown>;
1917
- /** Collection of file names to be passed to handler during execution. Required if step type is inline. */
1918
- files?: Array<string>;
1919
- /** Referenced child update identity. Required if step type is reference. */
1920
- updateId?: UpdateIdOutput;
1921
- }
1922
-
1923
- export declare interface StepResultOutput {
1924
- /** The update that this step installs if it is of reference type. */
1925
- update?: UpdateInfoOutput;
1926
- /** Step description. */
1927
- description?: string;
1928
- /** Install result code. */
1929
- resultCode: number;
1930
- /** Install extended result code */
1931
- extendedResultCode: number;
1932
- /** A string containing further details about the install result */
1933
- resultDetails?: string;
1934
- }
1935
-
1936
- export declare interface StringsListOutput {
1937
- /** The collection of pageable items. */
1938
- value: Array<string>;
1939
- /** The link to the next page of items. */
1940
- nextLink?: string;
1941
- }
1942
-
1943
- export declare interface UpdateComplianceOutput {
1944
- /** Total number of devices. */
1945
- totalDeviceCount: number;
1946
- /** Number of devices on the latest update. */
1947
- onLatestUpdateDeviceCount: number;
1948
- /** Number of devices with a newer update available. */
1949
- newUpdatesAvailableDeviceCount: number;
1950
- /** Number of devices with update in-progress. */
1951
- updatesInProgressDeviceCount: number;
1952
- }
1953
-
1954
- export declare interface UpdateFileBaseOutput {
1955
- /** File name. */
1956
- fileName: string;
1957
- /** File size in number of bytes. */
1958
- sizeInBytes: number;
1959
- /** Mapping of hashing algorithm to base64 encoded hash values. */
1960
- hashes: Record<string, string>;
1961
- /** File MIME type. */
1962
- mimeType?: string;
1963
- /** Anti-malware scan result. */
1964
- scanResult?: string;
1965
- /** Anti-malware scan details. */
1966
- scanDetails?: string;
1967
- /** Optional file properties (not consumed by service but pass-through to device). */
1968
- properties?: Record<string, string>;
1969
- }
1970
-
1971
- export declare interface UpdateFileDownloadHandlerOutput {
1972
- /** Download handler identifier. */
1973
- id: string;
1974
- }
1975
-
1976
- export declare interface UpdateFileOutput extends UpdateFileBaseOutput {
1977
- /** File identity, generated by server at import time. */
1978
- fileId: string;
1979
- /** Optional related files metadata used together DownloadHandler metadata to download payload file. */
1980
- relatedFiles?: Array<UpdateFileBaseOutput>;
1981
- /** Optional download handler for utilizing related files to download payload file. */
1982
- downloadHandler?: UpdateFileDownloadHandlerOutput;
1983
- /** File ETag. */
1984
- etag?: string;
1985
- }
1986
-
1987
- export declare interface UpdateId {
1988
- /** Update provider. */
1989
- provider: string;
1990
- /** Update name. */
1991
- name: string;
1992
- /** Update version. */
1993
- version: string;
1994
- }
1995
-
1996
- export declare interface UpdateIdOutput {
1997
- /** Update provider. */
1998
- provider: string;
1999
- /** Update name. */
2000
- name: string;
2001
- /** Update version. */
2002
- version: string;
2003
- }
2004
-
2005
- export declare interface UpdateInfo {
2006
- /** Update identifier. */
2007
- updateId: UpdateId;
2008
- /** Update description. */
2009
- description?: string;
2010
- /** Friendly update name. */
2011
- friendlyName?: string;
2012
- }
2013
-
2014
- export declare interface UpdateInfoListOutput {
2015
- /** The collection of pageable items. */
2016
- value: Array<UpdateInfoOutput>;
2017
- /** The link to the next page of items. */
2018
- nextLink?: string;
2019
- }
2020
-
2021
- export declare interface UpdateInfoOutput {
2022
- /** Update identifier. */
2023
- updateId: UpdateIdOutput;
2024
- /** Update description. */
2025
- description?: string;
2026
- /** Friendly update name. */
2027
- friendlyName?: string;
2028
- }
2029
-
2030
- export declare interface UpdateListOutput {
2031
- /** The collection of pageable items. */
2032
- value: Array<UpdateOutput>;
2033
- /** The link to the next page of items. */
2034
- nextLink?: string;
2035
- }
2036
-
2037
- export declare interface UpdateOperationOutput {
2038
- /** Operation Id. */
2039
- operationId: string;
2040
- /** Operation status. */
2041
- status: "NotStarted" | "Running" | "Succeeded" | "Failed";
2042
- /** The update being imported or deleted. For import, this property will only be populated after import manifest is processed successfully. */
2043
- update?: UpdateInfoOutput;
2044
- /** Location of the imported update when operation is successful. */
2045
- resourceLocation?: string;
2046
- /** Operation error encountered, if any. */
2047
- error?: ErrorModelOutput;
2048
- /** Operation correlation identity that can used by Microsoft Support for troubleshooting. */
2049
- traceId?: string;
2050
- /** Date and time in UTC when the operation status was last updated. */
2051
- lastActionDateTime: string;
2052
- /** Date and time in UTC when the operation was created. */
2053
- createdDateTime: string;
2054
- /** Operation ETag. */
2055
- etag?: string;
2056
- }
2057
-
2058
- export declare interface UpdateOperationsListOutput {
2059
- /** The collection of pageable items. */
2060
- value: Array<UpdateOperationOutput>;
2061
- /** The link to the next page of items. */
2062
- nextLink?: string;
2063
- }
2064
-
2065
- export declare interface UpdateOutput {
2066
- /** Update identity. */
2067
- updateId: UpdateIdOutput;
2068
- /** Update description specified by creator. */
2069
- description?: string;
2070
- /** Friendly update name specified by importer. */
2071
- friendlyName?: string;
2072
- /** Whether the update can be deployed to a device on its own. */
2073
- isDeployable?: boolean;
2074
- /** Update type. Deprecated in latest import manifest schema. */
2075
- updateType?: string;
2076
- /** String interpreted by Device Update client to determine if the update is installed on the device. Deprecated in latest import manifest schema. */
2077
- installedCriteria?: string;
2078
- /** List of update compatibility information. */
2079
- compatibility: Array<Record<string, string>>;
2080
- /** Update install instructions. */
2081
- instructions?: InstructionsOutput;
2082
- /** List of update identities that reference this update. */
2083
- referencedBy?: Array<UpdateIdOutput>;
2084
- /** Update aggregate scan result (calculated from payload file scan results). */
2085
- scanResult?: string;
2086
- /** Schema version of manifest used to import the update. */
2087
- manifestVersion: string;
2088
- /** Date and time in UTC when the update was imported. */
2089
- importedDateTime: string;
2090
- /** Date and time in UTC when the update was created. */
2091
- createdDateTime: string;
2092
- /** Update ETag. */
2093
- etag?: string;
2094
- }
2095
-
2096
- export { }