@azure/arm-deviceprovisioningservices 2.1.0 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (147) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/LICENSE +21 -0
  3. package/LICENSE.txt +21 -21
  4. package/README.md +98 -96
  5. package/dist/index.js +3108 -0
  6. package/dist/index.js.map +1 -0
  7. package/dist/index.min.js +1 -0
  8. package/dist/index.min.js.map +1 -0
  9. package/dist-esm/src/index.d.ts +5 -0
  10. package/dist-esm/src/index.d.ts.map +1 -0
  11. package/dist-esm/src/index.js +12 -0
  12. package/dist-esm/src/index.js.map +1 -0
  13. package/dist-esm/src/iotDpsClient.d.ts +20 -0
  14. package/dist-esm/src/iotDpsClient.d.ts.map +1 -0
  15. package/dist-esm/src/iotDpsClient.js +53 -0
  16. package/dist-esm/src/iotDpsClient.js.map +1 -0
  17. package/dist-esm/src/lroImpl.d.ts +16 -0
  18. package/dist-esm/src/lroImpl.d.ts.map +1 -0
  19. package/dist-esm/src/lroImpl.js +29 -0
  20. package/dist-esm/src/lroImpl.js.map +1 -0
  21. package/dist-esm/src/models/index.d.ts +825 -0
  22. package/dist-esm/src/models/index.d.ts.map +1 -0
  23. package/dist-esm/src/models/index.js +72 -0
  24. package/dist-esm/src/models/index.js.map +1 -0
  25. package/dist-esm/src/models/mappers.d.ts +36 -0
  26. package/dist-esm/src/models/mappers.d.ts.map +1 -0
  27. package/{esm → dist-esm/src}/models/mappers.js +565 -322
  28. package/dist-esm/src/models/mappers.js.map +1 -0
  29. package/dist-esm/src/models/parameters.d.ts +34 -0
  30. package/dist-esm/src/models/parameters.d.ts.map +1 -0
  31. package/dist-esm/src/models/parameters.js +293 -0
  32. package/dist-esm/src/models/parameters.js.map +1 -0
  33. package/dist-esm/src/operations/dpsCertificate.d.ts +70 -0
  34. package/dist-esm/src/operations/dpsCertificate.d.ts.map +1 -0
  35. package/dist-esm/src/operations/dpsCertificate.js +289 -0
  36. package/dist-esm/src/operations/dpsCertificate.js.map +1 -0
  37. package/{esm → dist-esm/src}/operations/index.d.ts +0 -0
  38. package/dist-esm/src/operations/index.d.ts.map +1 -0
  39. package/{esm → dist-esm/src}/operations/index.js +3 -5
  40. package/dist-esm/src/operations/index.js.map +1 -0
  41. package/dist-esm/src/operations/iotDpsResource.d.ts +253 -0
  42. package/dist-esm/src/operations/iotDpsResource.d.ts.map +1 -0
  43. package/dist-esm/src/operations/iotDpsResource.js +1154 -0
  44. package/dist-esm/src/operations/iotDpsResource.js.map +1 -0
  45. package/dist-esm/src/operations/operations.d.ts +32 -0
  46. package/dist-esm/src/operations/operations.d.ts.map +1 -0
  47. package/dist-esm/src/operations/operations.js +120 -0
  48. package/dist-esm/src/operations/operations.js.map +1 -0
  49. package/dist-esm/src/operationsInterfaces/dpsCertificate.d.ts +62 -0
  50. package/dist-esm/src/operationsInterfaces/dpsCertificate.d.ts.map +1 -0
  51. package/dist-esm/src/operationsInterfaces/dpsCertificate.js +9 -0
  52. package/dist-esm/src/operationsInterfaces/dpsCertificate.js.map +1 -0
  53. package/dist-esm/src/operationsInterfaces/index.d.ts +4 -0
  54. package/dist-esm/src/operationsInterfaces/index.d.ts.map +1 -0
  55. package/dist-esm/src/operationsInterfaces/index.js +11 -0
  56. package/dist-esm/src/operationsInterfaces/index.js.map +1 -0
  57. package/dist-esm/src/operationsInterfaces/iotDpsResource.d.ts +183 -0
  58. package/dist-esm/src/operationsInterfaces/iotDpsResource.d.ts.map +1 -0
  59. package/dist-esm/src/operationsInterfaces/iotDpsResource.js +9 -0
  60. package/dist-esm/src/operationsInterfaces/iotDpsResource.js.map +1 -0
  61. package/dist-esm/src/operationsInterfaces/operations.d.ts +11 -0
  62. package/dist-esm/src/operationsInterfaces/operations.d.ts.map +1 -0
  63. package/dist-esm/src/operationsInterfaces/operations.js +9 -0
  64. package/dist-esm/src/operationsInterfaces/operations.js.map +1 -0
  65. package/dist-esm/test/sampleTest.d.ts +2 -0
  66. package/dist-esm/test/sampleTest.d.ts.map +1 -0
  67. package/dist-esm/test/sampleTest.js +40 -0
  68. package/dist-esm/test/sampleTest.js.map +1 -0
  69. package/package.json +70 -34
  70. package/review/arm-deviceprovisioningservices.api.md +690 -0
  71. package/rollup.config.js +184 -27
  72. package/src/index.ts +12 -0
  73. package/src/iotDpsClient.ts +87 -0
  74. package/src/lroImpl.ts +34 -0
  75. package/src/models/index.ts +946 -0
  76. package/{lib → src}/models/mappers.ts +576 -323
  77. package/src/models/parameters.ts +337 -0
  78. package/src/operations/dpsCertificate.ts +374 -0
  79. package/{lib → src}/operations/index.ts +3 -5
  80. package/src/operations/iotDpsResource.ts +1595 -0
  81. package/src/operations/operations.ts +137 -0
  82. package/src/operationsInterfaces/dpsCertificate.ts +118 -0
  83. package/src/operationsInterfaces/index.ts +11 -0
  84. package/src/operationsInterfaces/iotDpsResource.ts +351 -0
  85. package/src/operationsInterfaces/operations.ts +22 -0
  86. package/tsconfig.json +4 -4
  87. package/types/arm-deviceprovisioningservices.d.ts +1205 -0
  88. package/types/tsdoc-metadata.json +11 -0
  89. package/dist/arm-deviceprovisioningservices.js +0 -2251
  90. package/dist/arm-deviceprovisioningservices.js.map +0 -1
  91. package/dist/arm-deviceprovisioningservices.min.js +0 -1
  92. package/dist/arm-deviceprovisioningservices.min.js.map +0 -1
  93. package/esm/iotDpsClient.d.ts +0 -20
  94. package/esm/iotDpsClient.d.ts.map +0 -1
  95. package/esm/iotDpsClient.js +0 -35
  96. package/esm/iotDpsClient.js.map +0 -1
  97. package/esm/iotDpsClientContext.d.ts +0 -16
  98. package/esm/iotDpsClientContext.d.ts.map +0 -1
  99. package/esm/iotDpsClientContext.js +0 -56
  100. package/esm/iotDpsClientContext.js.map +0 -1
  101. package/esm/models/dpsCertificateMappers.d.ts +0 -2
  102. package/esm/models/dpsCertificateMappers.d.ts.map +0 -1
  103. package/esm/models/dpsCertificateMappers.js +0 -11
  104. package/esm/models/dpsCertificateMappers.js.map +0 -1
  105. package/esm/models/index.d.ts +0 -1273
  106. package/esm/models/index.d.ts.map +0 -1
  107. package/esm/models/index.js +0 -10
  108. package/esm/models/index.js.map +0 -1
  109. package/esm/models/iotDpsResourceMappers.d.ts +0 -2
  110. package/esm/models/iotDpsResourceMappers.d.ts.map +0 -1
  111. package/esm/models/iotDpsResourceMappers.js +0 -11
  112. package/esm/models/iotDpsResourceMappers.js.map +0 -1
  113. package/esm/models/mappers.d.ts +0 -30
  114. package/esm/models/mappers.d.ts.map +0 -1
  115. package/esm/models/mappers.js.map +0 -1
  116. package/esm/models/operationsMappers.d.ts +0 -2
  117. package/esm/models/operationsMappers.d.ts.map +0 -1
  118. package/esm/models/operationsMappers.js +0 -11
  119. package/esm/models/operationsMappers.js.map +0 -1
  120. package/esm/models/parameters.d.ts +0 -23
  121. package/esm/models/parameters.d.ts.map +0 -1
  122. package/esm/models/parameters.js +0 -243
  123. package/esm/models/parameters.js.map +0 -1
  124. package/esm/operations/dpsCertificate.d.ts +0 -188
  125. package/esm/operations/dpsCertificate.d.ts.map +0 -1
  126. package/esm/operations/dpsCertificate.js +0 -265
  127. package/esm/operations/dpsCertificate.js.map +0 -1
  128. package/esm/operations/index.d.ts.map +0 -1
  129. package/esm/operations/index.js.map +0 -1
  130. package/esm/operations/iotDpsResource.d.ts +0 -337
  131. package/esm/operations/iotDpsResource.d.ts.map +0 -1
  132. package/esm/operations/iotDpsResource.js +0 -560
  133. package/esm/operations/iotDpsResource.js.map +0 -1
  134. package/esm/operations/operations.d.ts +0 -46
  135. package/esm/operations/operations.d.ts.map +0 -1
  136. package/esm/operations/operations.js +0 -77
  137. package/esm/operations/operations.js.map +0 -1
  138. package/lib/iotDpsClient.ts +0 -46
  139. package/lib/iotDpsClientContext.ts +0 -62
  140. package/lib/models/dpsCertificateMappers.ts +0 -28
  141. package/lib/models/index.ts +0 -1342
  142. package/lib/models/iotDpsResourceMappers.ts +0 -35
  143. package/lib/models/operationsMappers.ts +0 -17
  144. package/lib/models/parameters.ts +0 -245
  145. package/lib/operations/dpsCertificate.ts +0 -478
  146. package/lib/operations/iotDpsResource.ts +0 -907
  147. package/lib/operations/operations.ts +0 -123
@@ -0,0 +1,1205 @@
1
+ import * as coreAuth from '@azure/core-auth';
2
+ import * as coreClient from '@azure/core-client';
3
+ import { PagedAsyncIterableIterator } from '@azure/core-paging';
4
+ import { PollerLike } from '@azure/core-lro';
5
+ import { PollOperationState } from '@azure/core-lro';
6
+
7
+ /**
8
+ * Defines values for AccessRightsDescription. \
9
+ * {@link KnownAccessRightsDescription} can be used interchangeably with AccessRightsDescription,
10
+ * this enum contains the known values that the service supports.
11
+ * ### Known values supported by the service
12
+ * **ServiceConfig** \
13
+ * **EnrollmentRead** \
14
+ * **EnrollmentWrite** \
15
+ * **DeviceConnect** \
16
+ * **RegistrationStatusRead** \
17
+ * **RegistrationStatusWrite**
18
+ */
19
+ export declare type AccessRightsDescription = string;
20
+
21
+ /**
22
+ * Defines values for AllocationPolicy. \
23
+ * {@link KnownAllocationPolicy} can be used interchangeably with AllocationPolicy,
24
+ * this enum contains the known values that the service supports.
25
+ * ### Known values supported by the service
26
+ * **Hashed** \
27
+ * **GeoLatency** \
28
+ * **Static**
29
+ */
30
+ export declare type AllocationPolicy = string;
31
+
32
+ /** Result of a long running operation. */
33
+ export declare interface AsyncOperationResult {
34
+ /** current status of a long running operation. */
35
+ status?: string;
36
+ /** Error message containing code, description and details */
37
+ error?: ErrorMesssage;
38
+ }
39
+
40
+ /** The JSON-serialized X509 Certificate. */
41
+ export declare interface CertificateBodyDescription {
42
+ /** Base-64 representation of the X509 leaf certificate .cer file or just .pem file content. */
43
+ certificate?: string;
44
+ /** True indicates that the certificate will be created in verified state and proof of possession will not be required. */
45
+ isVerified?: boolean;
46
+ }
47
+
48
+ /** The JSON-serialized array of Certificate objects. */
49
+ export declare interface CertificateListDescription {
50
+ /** The array of Certificate objects. */
51
+ value?: CertificateResponse[];
52
+ }
53
+
54
+ /** The description of an X509 CA Certificate. */
55
+ export declare interface CertificateProperties {
56
+ /**
57
+ * The certificate's subject name.
58
+ * NOTE: This property will not be serialized. It can only be populated by the server.
59
+ */
60
+ readonly subject?: string;
61
+ /**
62
+ * The certificate's expiration date and time.
63
+ * NOTE: This property will not be serialized. It can only be populated by the server.
64
+ */
65
+ readonly expiry?: Date;
66
+ /**
67
+ * The certificate's thumbprint.
68
+ * NOTE: This property will not be serialized. It can only be populated by the server.
69
+ */
70
+ readonly thumbprint?: string;
71
+ /**
72
+ * Determines whether certificate has been verified.
73
+ * NOTE: This property will not be serialized. It can only be populated by the server.
74
+ */
75
+ readonly isVerified?: boolean;
76
+ /**
77
+ * base-64 representation of X509 certificate .cer file or just .pem file content.
78
+ * NOTE: This property will not be serialized. It can only be populated by the server.
79
+ */
80
+ readonly certificate?: Uint8Array;
81
+ /**
82
+ * The certificate's creation date and time.
83
+ * NOTE: This property will not be serialized. It can only be populated by the server.
84
+ */
85
+ readonly created?: Date;
86
+ /**
87
+ * The certificate's last update date and time.
88
+ * NOTE: This property will not be serialized. It can only be populated by the server.
89
+ */
90
+ readonly updated?: Date;
91
+ }
92
+
93
+ /**
94
+ * Defines values for CertificatePurpose. \
95
+ * {@link KnownCertificatePurpose} can be used interchangeably with CertificatePurpose,
96
+ * this enum contains the known values that the service supports.
97
+ * ### Known values supported by the service
98
+ * **clientAuthentication** \
99
+ * **serverAuthentication**
100
+ */
101
+ export declare type CertificatePurpose = string;
102
+
103
+ /** The X509 Certificate. */
104
+ export declare interface CertificateResponse {
105
+ /** properties of a certificate */
106
+ properties?: CertificateProperties;
107
+ /**
108
+ * The resource identifier.
109
+ * NOTE: This property will not be serialized. It can only be populated by the server.
110
+ */
111
+ readonly id?: string;
112
+ /**
113
+ * The name of the certificate.
114
+ * NOTE: This property will not be serialized. It can only be populated by the server.
115
+ */
116
+ readonly name?: string;
117
+ /**
118
+ * The entity tag.
119
+ * NOTE: This property will not be serialized. It can only be populated by the server.
120
+ */
121
+ readonly etag?: string;
122
+ /**
123
+ * The resource type.
124
+ * NOTE: This property will not be serialized. It can only be populated by the server.
125
+ */
126
+ readonly type?: string;
127
+ }
128
+
129
+ /** Interface representing a DpsCertificate. */
130
+ export declare interface DpsCertificate {
131
+ /**
132
+ * Get the certificate from the provisioning service.
133
+ * @param certificateName Name of the certificate to retrieve.
134
+ * @param resourceGroupName Resource group identifier.
135
+ * @param provisioningServiceName Name of the provisioning service the certificate is associated with.
136
+ * @param options The options parameters.
137
+ */
138
+ get(certificateName: string, resourceGroupName: string, provisioningServiceName: string, options?: DpsCertificateGetOptionalParams): Promise<DpsCertificateGetResponse>;
139
+ /**
140
+ * Add new certificate or update an existing certificate.
141
+ * @param resourceGroupName Resource group identifier.
142
+ * @param provisioningServiceName The name of the provisioning service.
143
+ * @param certificateName The name of the certificate create or update.
144
+ * @param certificateDescription The certificate body.
145
+ * @param options The options parameters.
146
+ */
147
+ createOrUpdate(resourceGroupName: string, provisioningServiceName: string, certificateName: string, certificateDescription: CertificateBodyDescription, options?: DpsCertificateCreateOrUpdateOptionalParams): Promise<DpsCertificateCreateOrUpdateResponse>;
148
+ /**
149
+ * Deletes the specified certificate associated with the Provisioning Service
150
+ * @param resourceGroupName Resource group identifier.
151
+ * @param ifMatch ETag of the certificate
152
+ * @param provisioningServiceName The name of the provisioning service.
153
+ * @param certificateName This is a mandatory field, and is the logical name of the certificate that
154
+ * the provisioning service will access by.
155
+ * @param options The options parameters.
156
+ */
157
+ delete(resourceGroupName: string, ifMatch: string, provisioningServiceName: string, certificateName: string, options?: DpsCertificateDeleteOptionalParams): Promise<void>;
158
+ /**
159
+ * Get all the certificates tied to the provisioning service.
160
+ * @param resourceGroupName Name of resource group.
161
+ * @param provisioningServiceName Name of provisioning service to retrieve certificates for.
162
+ * @param options The options parameters.
163
+ */
164
+ list(resourceGroupName: string, provisioningServiceName: string, options?: DpsCertificateListOptionalParams): Promise<DpsCertificateListResponse>;
165
+ /**
166
+ * Generate verification code for Proof of Possession.
167
+ * @param certificateName The mandatory logical name of the certificate, that the provisioning service
168
+ * uses to access.
169
+ * @param ifMatch ETag of the certificate. This is required to update an existing certificate, and
170
+ * ignored while creating a brand new certificate.
171
+ * @param resourceGroupName name of resource group.
172
+ * @param provisioningServiceName Name of provisioning service.
173
+ * @param options The options parameters.
174
+ */
175
+ generateVerificationCode(certificateName: string, ifMatch: string, resourceGroupName: string, provisioningServiceName: string, options?: DpsCertificateGenerateVerificationCodeOptionalParams): Promise<DpsCertificateGenerateVerificationCodeResponse>;
176
+ /**
177
+ * Verifies the certificate's private key possession by providing the leaf cert issued by the verifying
178
+ * pre uploaded certificate.
179
+ * @param certificateName The mandatory logical name of the certificate, that the provisioning service
180
+ * uses to access.
181
+ * @param ifMatch ETag of the certificate.
182
+ * @param resourceGroupName Resource group name.
183
+ * @param provisioningServiceName Provisioning service name.
184
+ * @param request The name of the certificate
185
+ * @param options The options parameters.
186
+ */
187
+ verifyCertificate(certificateName: string, ifMatch: string, resourceGroupName: string, provisioningServiceName: string, request: VerificationCodeRequest, options?: DpsCertificateVerifyCertificateOptionalParams): Promise<DpsCertificateVerifyCertificateResponse>;
188
+ }
189
+
190
+ /** Optional parameters. */
191
+ export declare interface DpsCertificateCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
192
+ /** ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate. */
193
+ ifMatch?: string;
194
+ }
195
+
196
+ /** Contains response data for the createOrUpdate operation. */
197
+ export declare type DpsCertificateCreateOrUpdateResponse = CertificateResponse;
198
+
199
+ /** Optional parameters. */
200
+ export declare interface DpsCertificateDeleteOptionalParams extends coreClient.OperationOptions {
201
+ /** This is optional, and it is the Common Name of the certificate. */
202
+ certificateName1?: string;
203
+ /** Raw data within the certificate. */
204
+ certificateRawBytes?: Uint8Array;
205
+ /** Indicates if certificate has been verified by owner of the private key. */
206
+ certificateIsVerified?: boolean;
207
+ /** A description that mentions the purpose of the certificate. */
208
+ certificatePurpose?: CertificatePurpose;
209
+ /** Time the certificate is created. */
210
+ certificateCreated?: Date;
211
+ /** Time the certificate is last updated. */
212
+ certificateLastUpdated?: Date;
213
+ /** Indicates if the certificate contains a private key. */
214
+ certificateHasPrivateKey?: boolean;
215
+ /** Random number generated to indicate Proof of Possession. */
216
+ certificateNonce?: string;
217
+ }
218
+
219
+ /** Optional parameters. */
220
+ export declare interface DpsCertificateGenerateVerificationCodeOptionalParams extends coreClient.OperationOptions {
221
+ /** Common Name for the certificate. */
222
+ certificateName1?: string;
223
+ /** Raw data of certificate. */
224
+ certificateRawBytes?: Uint8Array;
225
+ /** Indicates if the certificate has been verified by owner of the private key. */
226
+ certificateIsVerified?: boolean;
227
+ /** Description mentioning the purpose of the certificate. */
228
+ certificatePurpose?: CertificatePurpose;
229
+ /** Certificate creation time. */
230
+ certificateCreated?: Date;
231
+ /** Certificate last updated time. */
232
+ certificateLastUpdated?: Date;
233
+ /** Indicates if the certificate contains private key. */
234
+ certificateHasPrivateKey?: boolean;
235
+ /** Random number generated to indicate Proof of Possession. */
236
+ certificateNonce?: string;
237
+ }
238
+
239
+ /** Contains response data for the generateVerificationCode operation. */
240
+ export declare type DpsCertificateGenerateVerificationCodeResponse = VerificationCodeResponse;
241
+
242
+ /** Optional parameters. */
243
+ export declare interface DpsCertificateGetOptionalParams extends coreClient.OperationOptions {
244
+ /** ETag of the certificate. */
245
+ ifMatch?: string;
246
+ }
247
+
248
+ /** Contains response data for the get operation. */
249
+ export declare type DpsCertificateGetResponse = CertificateResponse;
250
+
251
+ /** Optional parameters. */
252
+ export declare interface DpsCertificateListOptionalParams extends coreClient.OperationOptions {
253
+ }
254
+
255
+ /** Contains response data for the list operation. */
256
+ export declare type DpsCertificateListResponse = CertificateListDescription;
257
+
258
+ /** Optional parameters. */
259
+ export declare interface DpsCertificateVerifyCertificateOptionalParams extends coreClient.OperationOptions {
260
+ /** Common Name for the certificate. */
261
+ certificateName1?: string;
262
+ /** Raw data of certificate. */
263
+ certificateRawBytes?: Uint8Array;
264
+ /** Indicates if the certificate has been verified by owner of the private key. */
265
+ certificateIsVerified?: boolean;
266
+ /** Describe the purpose of the certificate. */
267
+ certificatePurpose?: CertificatePurpose;
268
+ /** Certificate creation time. */
269
+ certificateCreated?: Date;
270
+ /** Certificate last updated time. */
271
+ certificateLastUpdated?: Date;
272
+ /** Indicates if the certificate contains private key. */
273
+ certificateHasPrivateKey?: boolean;
274
+ /** Random number generated to indicate Proof of Possession. */
275
+ certificateNonce?: string;
276
+ }
277
+
278
+ /** Contains response data for the verifyCertificate operation. */
279
+ export declare type DpsCertificateVerifyCertificateResponse = CertificateResponse;
280
+
281
+ /** Error details. */
282
+ export declare interface ErrorDetails {
283
+ /**
284
+ * The error code.
285
+ * NOTE: This property will not be serialized. It can only be populated by the server.
286
+ */
287
+ readonly code?: string;
288
+ /**
289
+ * The HTTP status code.
290
+ * NOTE: This property will not be serialized. It can only be populated by the server.
291
+ */
292
+ readonly httpStatusCode?: string;
293
+ /**
294
+ * The error message.
295
+ * NOTE: This property will not be serialized. It can only be populated by the server.
296
+ */
297
+ readonly message?: string;
298
+ /**
299
+ * The error details.
300
+ * NOTE: This property will not be serialized. It can only be populated by the server.
301
+ */
302
+ readonly details?: string;
303
+ }
304
+
305
+ /** Error response containing message and code. */
306
+ export declare interface ErrorMesssage {
307
+ /** standard error code */
308
+ code?: string;
309
+ /** standard error description */
310
+ message?: string;
311
+ /** detailed summary of error */
312
+ details?: string;
313
+ }
314
+
315
+ /** The group information for creating a private endpoint on a provisioning service */
316
+ export declare interface GroupIdInformation {
317
+ /**
318
+ * The resource identifier.
319
+ * NOTE: This property will not be serialized. It can only be populated by the server.
320
+ */
321
+ readonly id?: string;
322
+ /**
323
+ * The resource name.
324
+ * NOTE: This property will not be serialized. It can only be populated by the server.
325
+ */
326
+ readonly name?: string;
327
+ /**
328
+ * The resource type.
329
+ * NOTE: This property will not be serialized. It can only be populated by the server.
330
+ */
331
+ readonly type?: string;
332
+ /** The properties for a group information object */
333
+ properties: GroupIdInformationProperties;
334
+ }
335
+
336
+ /** The properties for a group information object */
337
+ export declare interface GroupIdInformationProperties {
338
+ /** The group id */
339
+ groupId?: string;
340
+ /** The required members for a specific group id */
341
+ requiredMembers?: string[];
342
+ /** The required DNS zones for a specific group id */
343
+ requiredZoneNames?: string[];
344
+ }
345
+
346
+ export declare class IotDpsClient extends coreClient.ServiceClient {
347
+ $host: string;
348
+ apiVersion: string;
349
+ subscriptionId: string;
350
+ /**
351
+ * Initializes a new instance of the IotDpsClient class.
352
+ * @param credentials Subscription credentials which uniquely identify client subscription.
353
+ * @param subscriptionId The subscription identifier.
354
+ * @param options The parameter options
355
+ */
356
+ constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: IotDpsClientOptionalParams);
357
+ operations: Operations;
358
+ dpsCertificate: DpsCertificate;
359
+ iotDpsResource: IotDpsResource;
360
+ }
361
+
362
+ /** Optional parameters. */
363
+ export declare interface IotDpsClientOptionalParams extends coreClient.ServiceClientOptions {
364
+ /** server parameter */
365
+ $host?: string;
366
+ /** Api Version */
367
+ apiVersion?: string;
368
+ /** Overrides client endpoint. */
369
+ endpoint?: string;
370
+ }
371
+
372
+ /** the service specific properties of a provisioning service, including keys, linked iot hubs, current state, and system generated properties such as hostname and idScope */
373
+ export declare interface IotDpsPropertiesDescription {
374
+ /** Current state of the provisioning service. */
375
+ state?: State;
376
+ /** Whether requests from Public Network are allowed */
377
+ publicNetworkAccess?: PublicNetworkAccess;
378
+ /** The IP filter rules. */
379
+ ipFilterRules?: IpFilterRule[];
380
+ /** Private endpoint connections created on this IotHub */
381
+ privateEndpointConnections?: PrivateEndpointConnection[];
382
+ /** The ARM provisioning state of the provisioning service. */
383
+ provisioningState?: string;
384
+ /** List of IoT hubs associated with this provisioning service. */
385
+ iotHubs?: IotHubDefinitionDescription[];
386
+ /** Allocation policy to be used by this provisioning service. */
387
+ allocationPolicy?: AllocationPolicy;
388
+ /**
389
+ * Service endpoint for provisioning service.
390
+ * NOTE: This property will not be serialized. It can only be populated by the server.
391
+ */
392
+ readonly serviceOperationsHostName?: string;
393
+ /**
394
+ * Device endpoint for this provisioning service.
395
+ * NOTE: This property will not be serialized. It can only be populated by the server.
396
+ */
397
+ readonly deviceProvisioningHostName?: string;
398
+ /**
399
+ * Unique identifier of this provisioning service.
400
+ * NOTE: This property will not be serialized. It can only be populated by the server.
401
+ */
402
+ readonly idScope?: string;
403
+ /** List of authorization keys for a provisioning service. */
404
+ authorizationPolicies?: SharedAccessSignatureAuthorizationRuleAccessRightsDescription[];
405
+ }
406
+
407
+ /** Interface representing a IotDpsResource. */
408
+ export declare interface IotDpsResource {
409
+ /**
410
+ * List all the provisioning services for a given subscription id.
411
+ * @param options The options parameters.
412
+ */
413
+ listBySubscription(options?: IotDpsResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ProvisioningServiceDescription>;
414
+ /**
415
+ * Get a list of all provisioning services in the given resource group.
416
+ * @param resourceGroupName Resource group identifier.
417
+ * @param options The options parameters.
418
+ */
419
+ listByResourceGroup(resourceGroupName: string, options?: IotDpsResourceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ProvisioningServiceDescription>;
420
+ /**
421
+ * Gets the list of valid SKUs and tiers for a provisioning service.
422
+ * @param provisioningServiceName Name of provisioning service.
423
+ * @param resourceGroupName Name of resource group.
424
+ * @param options The options parameters.
425
+ */
426
+ listValidSkus(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceListValidSkusOptionalParams): PagedAsyncIterableIterator<IotDpsSkuDefinition>;
427
+ /**
428
+ * List the primary and secondary keys for a provisioning service.
429
+ * @param provisioningServiceName The provisioning service name to get the shared access keys for.
430
+ * @param resourceGroupName resource group name
431
+ * @param options The options parameters.
432
+ */
433
+ listKeys(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceListKeysOptionalParams): PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRuleAccessRightsDescription>;
434
+ /**
435
+ * Get the metadata of the provisioning service without SAS keys.
436
+ * @param provisioningServiceName Name of the provisioning service to retrieve.
437
+ * @param resourceGroupName Resource group name.
438
+ * @param options The options parameters.
439
+ */
440
+ get(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceGetOptionalParams): Promise<IotDpsResourceGetResponse>;
441
+ /**
442
+ * Create or update the metadata of the provisioning service. The usual pattern to modify a property is
443
+ * to retrieve the provisioning service metadata and security metadata, and then combine them with the
444
+ * modified values in a new body to update the provisioning service.
445
+ * @param resourceGroupName Resource group identifier.
446
+ * @param provisioningServiceName Name of provisioning service to create or update.
447
+ * @param iotDpsDescription Description of the provisioning service to create or update.
448
+ * @param options The options parameters.
449
+ */
450
+ beginCreateOrUpdate(resourceGroupName: string, provisioningServiceName: string, iotDpsDescription: ProvisioningServiceDescription, options?: IotDpsResourceCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<IotDpsResourceCreateOrUpdateResponse>, IotDpsResourceCreateOrUpdateResponse>>;
451
+ /**
452
+ * Create or update the metadata of the provisioning service. The usual pattern to modify a property is
453
+ * to retrieve the provisioning service metadata and security metadata, and then combine them with the
454
+ * modified values in a new body to update the provisioning service.
455
+ * @param resourceGroupName Resource group identifier.
456
+ * @param provisioningServiceName Name of provisioning service to create or update.
457
+ * @param iotDpsDescription Description of the provisioning service to create or update.
458
+ * @param options The options parameters.
459
+ */
460
+ beginCreateOrUpdateAndWait(resourceGroupName: string, provisioningServiceName: string, iotDpsDescription: ProvisioningServiceDescription, options?: IotDpsResourceCreateOrUpdateOptionalParams): Promise<IotDpsResourceCreateOrUpdateResponse>;
461
+ /**
462
+ * Update an existing provisioning service's tags. to update other fields use the CreateOrUpdate method
463
+ * @param resourceGroupName Resource group identifier.
464
+ * @param provisioningServiceName Name of provisioning service to create or update.
465
+ * @param provisioningServiceTags Updated tag information to set into the provisioning service
466
+ * instance.
467
+ * @param options The options parameters.
468
+ */
469
+ beginUpdate(resourceGroupName: string, provisioningServiceName: string, provisioningServiceTags: TagsResource, options?: IotDpsResourceUpdateOptionalParams): Promise<PollerLike<PollOperationState<IotDpsResourceUpdateResponse>, IotDpsResourceUpdateResponse>>;
470
+ /**
471
+ * Update an existing provisioning service's tags. to update other fields use the CreateOrUpdate method
472
+ * @param resourceGroupName Resource group identifier.
473
+ * @param provisioningServiceName Name of provisioning service to create or update.
474
+ * @param provisioningServiceTags Updated tag information to set into the provisioning service
475
+ * instance.
476
+ * @param options The options parameters.
477
+ */
478
+ beginUpdateAndWait(resourceGroupName: string, provisioningServiceName: string, provisioningServiceTags: TagsResource, options?: IotDpsResourceUpdateOptionalParams): Promise<IotDpsResourceUpdateResponse>;
479
+ /**
480
+ * Deletes the Provisioning Service.
481
+ * @param provisioningServiceName Name of provisioning service to delete.
482
+ * @param resourceGroupName Resource group identifier.
483
+ * @param options The options parameters.
484
+ */
485
+ beginDelete(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
486
+ /**
487
+ * Deletes the Provisioning Service.
488
+ * @param provisioningServiceName Name of provisioning service to delete.
489
+ * @param resourceGroupName Resource group identifier.
490
+ * @param options The options parameters.
491
+ */
492
+ beginDeleteAndWait(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceDeleteOptionalParams): Promise<void>;
493
+ /**
494
+ * Gets the status of a long running operation, such as create, update or delete a provisioning
495
+ * service.
496
+ * @param operationId Operation id corresponding to long running operation. Use this to poll for the
497
+ * status.
498
+ * @param resourceGroupName Resource group identifier.
499
+ * @param provisioningServiceName Name of provisioning service that the operation is running on.
500
+ * @param asyncinfo Async header used to poll on the status of the operation, obtained while creating
501
+ * the long running operation.
502
+ * @param options The options parameters.
503
+ */
504
+ getOperationResult(operationId: string, resourceGroupName: string, provisioningServiceName: string, asyncinfo: string, options?: IotDpsResourceGetOperationResultOptionalParams): Promise<IotDpsResourceGetOperationResultResponse>;
505
+ /**
506
+ * Check if a provisioning service name is available. This will validate if the name is syntactically
507
+ * valid and if the name is usable
508
+ * @param argumentsParam Set the name parameter in the OperationInputs structure to the name of the
509
+ * provisioning service to check.
510
+ * @param options The options parameters.
511
+ */
512
+ checkProvisioningServiceNameAvailability(argumentsParam: OperationInputs, options?: IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams): Promise<IotDpsResourceCheckProvisioningServiceNameAvailabilityResponse>;
513
+ /**
514
+ * List primary and secondary keys for a specific key name
515
+ * @param provisioningServiceName Name of the provisioning service.
516
+ * @param keyName Logical key name to get key-values for.
517
+ * @param resourceGroupName The name of the resource group that contains the provisioning service.
518
+ * @param options The options parameters.
519
+ */
520
+ listKeysForKeyName(provisioningServiceName: string, keyName: string, resourceGroupName: string, options?: IotDpsResourceListKeysForKeyNameOptionalParams): Promise<IotDpsResourceListKeysForKeyNameResponse>;
521
+ /**
522
+ * List private link resources for the given provisioning service
523
+ * @param resourceGroupName The name of the resource group that contains the provisioning service.
524
+ * @param resourceName The name of the provisioning service.
525
+ * @param options The options parameters.
526
+ */
527
+ listPrivateLinkResources(resourceGroupName: string, resourceName: string, options?: IotDpsResourceListPrivateLinkResourcesOptionalParams): Promise<IotDpsResourceListPrivateLinkResourcesResponse>;
528
+ /**
529
+ * Get the specified private link resource for the given provisioning service
530
+ * @param resourceGroupName The name of the resource group that contains the provisioning service.
531
+ * @param resourceName The name of the provisioning service.
532
+ * @param groupId The name of the private link resource
533
+ * @param options The options parameters.
534
+ */
535
+ getPrivateLinkResources(resourceGroupName: string, resourceName: string, groupId: string, options?: IotDpsResourceGetPrivateLinkResourcesOptionalParams): Promise<IotDpsResourceGetPrivateLinkResourcesResponse>;
536
+ /**
537
+ * List private endpoint connection properties
538
+ * @param resourceGroupName The name of the resource group that contains the provisioning service.
539
+ * @param resourceName The name of the provisioning service.
540
+ * @param options The options parameters.
541
+ */
542
+ listPrivateEndpointConnections(resourceGroupName: string, resourceName: string, options?: IotDpsResourceListPrivateEndpointConnectionsOptionalParams): Promise<IotDpsResourceListPrivateEndpointConnectionsResponse>;
543
+ /**
544
+ * Get private endpoint connection properties
545
+ * @param resourceGroupName The name of the resource group that contains the provisioning service.
546
+ * @param resourceName The name of the provisioning service.
547
+ * @param privateEndpointConnectionName The name of the private endpoint connection
548
+ * @param options The options parameters.
549
+ */
550
+ getPrivateEndpointConnection(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceGetPrivateEndpointConnectionOptionalParams): Promise<IotDpsResourceGetPrivateEndpointConnectionResponse>;
551
+ /**
552
+ * Create or update the status of a private endpoint connection with the specified name
553
+ * @param resourceGroupName The name of the resource group that contains the provisioning service.
554
+ * @param resourceName The name of the provisioning service.
555
+ * @param privateEndpointConnectionName The name of the private endpoint connection
556
+ * @param privateEndpointConnection The private endpoint connection with updated properties
557
+ * @param options The options parameters.
558
+ */
559
+ beginCreateOrUpdatePrivateEndpointConnection(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams): Promise<PollerLike<PollOperationState<IotDpsResourceCreateOrUpdatePrivateEndpointConnectionResponse>, IotDpsResourceCreateOrUpdatePrivateEndpointConnectionResponse>>;
560
+ /**
561
+ * Create or update the status of a private endpoint connection with the specified name
562
+ * @param resourceGroupName The name of the resource group that contains the provisioning service.
563
+ * @param resourceName The name of the provisioning service.
564
+ * @param privateEndpointConnectionName The name of the private endpoint connection
565
+ * @param privateEndpointConnection The private endpoint connection with updated properties
566
+ * @param options The options parameters.
567
+ */
568
+ beginCreateOrUpdatePrivateEndpointConnectionAndWait(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams): Promise<IotDpsResourceCreateOrUpdatePrivateEndpointConnectionResponse>;
569
+ /**
570
+ * Delete private endpoint connection with the specified name
571
+ * @param resourceGroupName The name of the resource group that contains the provisioning service.
572
+ * @param resourceName The name of the provisioning service.
573
+ * @param privateEndpointConnectionName The name of the private endpoint connection
574
+ * @param options The options parameters.
575
+ */
576
+ beginDeletePrivateEndpointConnection(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceDeletePrivateEndpointConnectionOptionalParams): Promise<PollerLike<PollOperationState<IotDpsResourceDeletePrivateEndpointConnectionResponse>, IotDpsResourceDeletePrivateEndpointConnectionResponse>>;
577
+ /**
578
+ * Delete private endpoint connection with the specified name
579
+ * @param resourceGroupName The name of the resource group that contains the provisioning service.
580
+ * @param resourceName The name of the provisioning service.
581
+ * @param privateEndpointConnectionName The name of the private endpoint connection
582
+ * @param options The options parameters.
583
+ */
584
+ beginDeletePrivateEndpointConnectionAndWait(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceDeletePrivateEndpointConnectionOptionalParams): Promise<IotDpsResourceDeletePrivateEndpointConnectionResponse>;
585
+ }
586
+
587
+ /** Optional parameters. */
588
+ export declare interface IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams extends coreClient.OperationOptions {
589
+ }
590
+
591
+ /** Contains response data for the checkProvisioningServiceNameAvailability operation. */
592
+ export declare type IotDpsResourceCheckProvisioningServiceNameAvailabilityResponse = NameAvailabilityInfo;
593
+
594
+ /** Optional parameters. */
595
+ export declare interface IotDpsResourceCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
596
+ /** Delay to wait until next poll, in milliseconds. */
597
+ updateIntervalInMs?: number;
598
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
599
+ resumeFrom?: string;
600
+ }
601
+
602
+ /** Optional parameters. */
603
+ export declare interface IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams extends coreClient.OperationOptions {
604
+ /** Delay to wait until next poll, in milliseconds. */
605
+ updateIntervalInMs?: number;
606
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
607
+ resumeFrom?: string;
608
+ }
609
+
610
+ /** Contains response data for the createOrUpdatePrivateEndpointConnection operation. */
611
+ export declare type IotDpsResourceCreateOrUpdatePrivateEndpointConnectionResponse = PrivateEndpointConnection;
612
+
613
+ /** Contains response data for the createOrUpdate operation. */
614
+ export declare type IotDpsResourceCreateOrUpdateResponse = ProvisioningServiceDescription;
615
+
616
+ /** Optional parameters. */
617
+ export declare interface IotDpsResourceDeleteOptionalParams extends coreClient.OperationOptions {
618
+ /** Delay to wait until next poll, in milliseconds. */
619
+ updateIntervalInMs?: number;
620
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
621
+ resumeFrom?: string;
622
+ }
623
+
624
+ /** Optional parameters. */
625
+ export declare interface IotDpsResourceDeletePrivateEndpointConnectionOptionalParams extends coreClient.OperationOptions {
626
+ /** Delay to wait until next poll, in milliseconds. */
627
+ updateIntervalInMs?: number;
628
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
629
+ resumeFrom?: string;
630
+ }
631
+
632
+ /** Contains response data for the deletePrivateEndpointConnection operation. */
633
+ export declare type IotDpsResourceDeletePrivateEndpointConnectionResponse = PrivateEndpointConnection;
634
+
635
+ /** Optional parameters. */
636
+ export declare interface IotDpsResourceGetOperationResultOptionalParams extends coreClient.OperationOptions {
637
+ }
638
+
639
+ /** Contains response data for the getOperationResult operation. */
640
+ export declare type IotDpsResourceGetOperationResultResponse = AsyncOperationResult;
641
+
642
+ /** Optional parameters. */
643
+ export declare interface IotDpsResourceGetOptionalParams extends coreClient.OperationOptions {
644
+ }
645
+
646
+ /** Optional parameters. */
647
+ export declare interface IotDpsResourceGetPrivateEndpointConnectionOptionalParams extends coreClient.OperationOptions {
648
+ }
649
+
650
+ /** Contains response data for the getPrivateEndpointConnection operation. */
651
+ export declare type IotDpsResourceGetPrivateEndpointConnectionResponse = PrivateEndpointConnection;
652
+
653
+ /** Optional parameters. */
654
+ export declare interface IotDpsResourceGetPrivateLinkResourcesOptionalParams extends coreClient.OperationOptions {
655
+ }
656
+
657
+ /** Contains response data for the getPrivateLinkResources operation. */
658
+ export declare type IotDpsResourceGetPrivateLinkResourcesResponse = GroupIdInformation;
659
+
660
+ /** Contains response data for the get operation. */
661
+ export declare type IotDpsResourceGetResponse = ProvisioningServiceDescription;
662
+
663
+ /** Optional parameters. */
664
+ export declare interface IotDpsResourceListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
665
+ }
666
+
667
+ /** Contains response data for the listByResourceGroupNext operation. */
668
+ export declare type IotDpsResourceListByResourceGroupNextResponse = ProvisioningServiceDescriptionListResult;
669
+
670
+ /** Optional parameters. */
671
+ export declare interface IotDpsResourceListByResourceGroupOptionalParams extends coreClient.OperationOptions {
672
+ }
673
+
674
+ /** Contains response data for the listByResourceGroup operation. */
675
+ export declare type IotDpsResourceListByResourceGroupResponse = ProvisioningServiceDescriptionListResult;
676
+
677
+ /** Optional parameters. */
678
+ export declare interface IotDpsResourceListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
679
+ }
680
+
681
+ /** Contains response data for the listBySubscriptionNext operation. */
682
+ export declare type IotDpsResourceListBySubscriptionNextResponse = ProvisioningServiceDescriptionListResult;
683
+
684
+ /** Optional parameters. */
685
+ export declare interface IotDpsResourceListBySubscriptionOptionalParams extends coreClient.OperationOptions {
686
+ }
687
+
688
+ /** Contains response data for the listBySubscription operation. */
689
+ export declare type IotDpsResourceListBySubscriptionResponse = ProvisioningServiceDescriptionListResult;
690
+
691
+ /** Optional parameters. */
692
+ export declare interface IotDpsResourceListKeysForKeyNameOptionalParams extends coreClient.OperationOptions {
693
+ }
694
+
695
+ /** Contains response data for the listKeysForKeyName operation. */
696
+ export declare type IotDpsResourceListKeysForKeyNameResponse = SharedAccessSignatureAuthorizationRuleAccessRightsDescription;
697
+
698
+ /** Optional parameters. */
699
+ export declare interface IotDpsResourceListKeysNextOptionalParams extends coreClient.OperationOptions {
700
+ }
701
+
702
+ /** Contains response data for the listKeysNext operation. */
703
+ export declare type IotDpsResourceListKeysNextResponse = SharedAccessSignatureAuthorizationRuleListResult;
704
+
705
+ /** Optional parameters. */
706
+ export declare interface IotDpsResourceListKeysOptionalParams extends coreClient.OperationOptions {
707
+ }
708
+
709
+ /** Contains response data for the listKeys operation. */
710
+ export declare type IotDpsResourceListKeysResponse = SharedAccessSignatureAuthorizationRuleListResult;
711
+
712
+ /** Optional parameters. */
713
+ export declare interface IotDpsResourceListPrivateEndpointConnectionsOptionalParams extends coreClient.OperationOptions {
714
+ }
715
+
716
+ /** Contains response data for the listPrivateEndpointConnections operation. */
717
+ export declare type IotDpsResourceListPrivateEndpointConnectionsResponse = PrivateEndpointConnection[];
718
+
719
+ /** Optional parameters. */
720
+ export declare interface IotDpsResourceListPrivateLinkResourcesOptionalParams extends coreClient.OperationOptions {
721
+ }
722
+
723
+ /** Contains response data for the listPrivateLinkResources operation. */
724
+ export declare type IotDpsResourceListPrivateLinkResourcesResponse = PrivateLinkResources;
725
+
726
+ /** Optional parameters. */
727
+ export declare interface IotDpsResourceListValidSkusNextOptionalParams extends coreClient.OperationOptions {
728
+ }
729
+
730
+ /** Contains response data for the listValidSkusNext operation. */
731
+ export declare type IotDpsResourceListValidSkusNextResponse = IotDpsSkuDefinitionListResult;
732
+
733
+ /** Optional parameters. */
734
+ export declare interface IotDpsResourceListValidSkusOptionalParams extends coreClient.OperationOptions {
735
+ }
736
+
737
+ /** Contains response data for the listValidSkus operation. */
738
+ export declare type IotDpsResourceListValidSkusResponse = IotDpsSkuDefinitionListResult;
739
+
740
+ /** Optional parameters. */
741
+ export declare interface IotDpsResourceUpdateOptionalParams extends coreClient.OperationOptions {
742
+ /** Delay to wait until next poll, in milliseconds. */
743
+ updateIntervalInMs?: number;
744
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
745
+ resumeFrom?: string;
746
+ }
747
+
748
+ /** Contains response data for the update operation. */
749
+ export declare type IotDpsResourceUpdateResponse = ProvisioningServiceDescription;
750
+
751
+ /**
752
+ * Defines values for IotDpsSku. \
753
+ * {@link KnownIotDpsSku} can be used interchangeably with IotDpsSku,
754
+ * this enum contains the known values that the service supports.
755
+ * ### Known values supported by the service
756
+ * **S1**
757
+ */
758
+ export declare type IotDpsSku = string;
759
+
760
+ /** Available SKUs of tier and units. */
761
+ export declare interface IotDpsSkuDefinition {
762
+ /** Sku name. */
763
+ name?: IotDpsSku;
764
+ }
765
+
766
+ /** List of available SKUs. */
767
+ export declare interface IotDpsSkuDefinitionListResult {
768
+ /** The list of SKUs */
769
+ value?: IotDpsSkuDefinition[];
770
+ /**
771
+ * The next link.
772
+ * NOTE: This property will not be serialized. It can only be populated by the server.
773
+ */
774
+ readonly nextLink?: string;
775
+ }
776
+
777
+ /** List of possible provisioning service SKUs. */
778
+ export declare interface IotDpsSkuInfo {
779
+ /** Sku name. */
780
+ name?: IotDpsSku;
781
+ /**
782
+ * Pricing tier name of the provisioning service.
783
+ * NOTE: This property will not be serialized. It can only be populated by the server.
784
+ */
785
+ readonly tier?: string;
786
+ /** The number of units to provision */
787
+ capacity?: number;
788
+ }
789
+
790
+ /** Description of the IoT hub. */
791
+ export declare interface IotHubDefinitionDescription {
792
+ /** flag for applying allocationPolicy or not for a given iot hub. */
793
+ applyAllocationPolicy?: boolean;
794
+ /** weight to apply for a given iot h. */
795
+ allocationWeight?: number;
796
+ /**
797
+ * Host name of the IoT hub.
798
+ * NOTE: This property will not be serialized. It can only be populated by the server.
799
+ */
800
+ readonly name?: string;
801
+ /** Connection string of the IoT hub. */
802
+ connectionString: string;
803
+ /** ARM region of the IoT hub. */
804
+ location: string;
805
+ }
806
+
807
+ /** Defines values for IpFilterActionType. */
808
+ export declare type IpFilterActionType = "Accept" | "Reject";
809
+
810
+ /** The IP filter rules for a provisioning Service. */
811
+ export declare interface IpFilterRule {
812
+ /** The name of the IP filter rule. */
813
+ filterName: string;
814
+ /** The desired action for requests captured by this rule. */
815
+ action: IpFilterActionType;
816
+ /** A string that contains the IP address range in CIDR notation for the rule. */
817
+ ipMask: string;
818
+ /** Target for requests captured by this rule. */
819
+ target?: IpFilterTargetType;
820
+ }
821
+
822
+ /** Defines values for IpFilterTargetType. */
823
+ export declare type IpFilterTargetType = "all" | "serviceApi" | "deviceApi";
824
+
825
+ /** Known values of {@link AccessRightsDescription} that the service accepts. */
826
+ export declare enum KnownAccessRightsDescription {
827
+ ServiceConfig = "ServiceConfig",
828
+ EnrollmentRead = "EnrollmentRead",
829
+ EnrollmentWrite = "EnrollmentWrite",
830
+ DeviceConnect = "DeviceConnect",
831
+ RegistrationStatusRead = "RegistrationStatusRead",
832
+ RegistrationStatusWrite = "RegistrationStatusWrite"
833
+ }
834
+
835
+ /** Known values of {@link AllocationPolicy} that the service accepts. */
836
+ export declare enum KnownAllocationPolicy {
837
+ Hashed = "Hashed",
838
+ GeoLatency = "GeoLatency",
839
+ Static = "Static"
840
+ }
841
+
842
+ /** Known values of {@link CertificatePurpose} that the service accepts. */
843
+ export declare enum KnownCertificatePurpose {
844
+ ClientAuthentication = "clientAuthentication",
845
+ ServerAuthentication = "serverAuthentication"
846
+ }
847
+
848
+ /** Known values of {@link IotDpsSku} that the service accepts. */
849
+ export declare enum KnownIotDpsSku {
850
+ S1 = "S1"
851
+ }
852
+
853
+ /** Known values of {@link NameUnavailabilityReason} that the service accepts. */
854
+ export declare enum KnownNameUnavailabilityReason {
855
+ Invalid = "Invalid",
856
+ AlreadyExists = "AlreadyExists"
857
+ }
858
+
859
+ /** Known values of {@link PrivateLinkServiceConnectionStatus} that the service accepts. */
860
+ export declare enum KnownPrivateLinkServiceConnectionStatus {
861
+ Pending = "Pending",
862
+ Approved = "Approved",
863
+ Rejected = "Rejected",
864
+ Disconnected = "Disconnected"
865
+ }
866
+
867
+ /** Known values of {@link PublicNetworkAccess} that the service accepts. */
868
+ export declare enum KnownPublicNetworkAccess {
869
+ Enabled = "Enabled",
870
+ Disabled = "Disabled"
871
+ }
872
+
873
+ /** Known values of {@link State} that the service accepts. */
874
+ export declare enum KnownState {
875
+ Activating = "Activating",
876
+ Active = "Active",
877
+ Deleting = "Deleting",
878
+ Deleted = "Deleted",
879
+ ActivationFailed = "ActivationFailed",
880
+ DeletionFailed = "DeletionFailed",
881
+ Transitioning = "Transitioning",
882
+ Suspending = "Suspending",
883
+ Suspended = "Suspended",
884
+ Resuming = "Resuming",
885
+ FailingOver = "FailingOver",
886
+ FailoverFailed = "FailoverFailed"
887
+ }
888
+
889
+ /** Description of name availability. */
890
+ export declare interface NameAvailabilityInfo {
891
+ /** specifies if a name is available or not */
892
+ nameAvailable?: boolean;
893
+ /** specifies the reason a name is unavailable */
894
+ reason?: NameUnavailabilityReason;
895
+ /** message containing a detailed reason name is unavailable */
896
+ message?: string;
897
+ }
898
+
899
+ /**
900
+ * Defines values for NameUnavailabilityReason. \
901
+ * {@link KnownNameUnavailabilityReason} can be used interchangeably with NameUnavailabilityReason,
902
+ * this enum contains the known values that the service supports.
903
+ * ### Known values supported by the service
904
+ * **Invalid** \
905
+ * **AlreadyExists**
906
+ */
907
+ export declare type NameUnavailabilityReason = string;
908
+
909
+ /** Provisioning Service REST API operation. */
910
+ export declare interface Operation {
911
+ /**
912
+ * Operation name: {provider}/{resource}/{read | write | action | delete}
913
+ * NOTE: This property will not be serialized. It can only be populated by the server.
914
+ */
915
+ readonly name?: string;
916
+ /** The object that represents the operation. */
917
+ display?: OperationDisplay;
918
+ }
919
+
920
+ /** The object that represents the operation. */
921
+ export declare interface OperationDisplay {
922
+ /**
923
+ * Service provider: Microsoft Devices.
924
+ * NOTE: This property will not be serialized. It can only be populated by the server.
925
+ */
926
+ readonly provider?: string;
927
+ /**
928
+ * Resource Type: ProvisioningServices.
929
+ * NOTE: This property will not be serialized. It can only be populated by the server.
930
+ */
931
+ readonly resource?: string;
932
+ /**
933
+ * Name of the operation.
934
+ * NOTE: This property will not be serialized. It can only be populated by the server.
935
+ */
936
+ readonly operation?: string;
937
+ }
938
+
939
+ /** Input values for operation results call. */
940
+ export declare interface OperationInputs {
941
+ /** The name of the Provisioning Service to check. */
942
+ name: string;
943
+ }
944
+
945
+ /** Result of the request to list provisioning service operations. It contains a list of operations and a URL link to get the next set of results. */
946
+ export declare interface OperationListResult {
947
+ /**
948
+ * Provisioning service operations supported by the Microsoft.Devices resource provider.
949
+ * NOTE: This property will not be serialized. It can only be populated by the server.
950
+ */
951
+ readonly value?: Operation[];
952
+ /**
953
+ * URL to get the next set of operation list results if there are any.
954
+ * NOTE: This property will not be serialized. It can only be populated by the server.
955
+ */
956
+ readonly nextLink?: string;
957
+ }
958
+
959
+ /** Interface representing a Operations. */
960
+ export declare interface Operations {
961
+ /**
962
+ * Lists all of the available Microsoft.Devices REST API operations.
963
+ * @param options The options parameters.
964
+ */
965
+ list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
966
+ }
967
+
968
+ /** Optional parameters. */
969
+ export declare interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
970
+ }
971
+
972
+ /** Contains response data for the listNext operation. */
973
+ export declare type OperationsListNextResponse = OperationListResult;
974
+
975
+ /** Optional parameters. */
976
+ export declare interface OperationsListOptionalParams extends coreClient.OperationOptions {
977
+ }
978
+
979
+ /** Contains response data for the list operation. */
980
+ export declare type OperationsListResponse = OperationListResult;
981
+
982
+ /** The private endpoint property of a private endpoint connection */
983
+ export declare interface PrivateEndpoint {
984
+ /**
985
+ * The resource identifier.
986
+ * NOTE: This property will not be serialized. It can only be populated by the server.
987
+ */
988
+ readonly id?: string;
989
+ }
990
+
991
+ /** The private endpoint connection of a provisioning service */
992
+ export declare interface PrivateEndpointConnection {
993
+ /**
994
+ * The resource identifier.
995
+ * NOTE: This property will not be serialized. It can only be populated by the server.
996
+ */
997
+ readonly id?: string;
998
+ /**
999
+ * The resource name.
1000
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1001
+ */
1002
+ readonly name?: string;
1003
+ /**
1004
+ * The resource type.
1005
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1006
+ */
1007
+ readonly type?: string;
1008
+ /** The properties of a private endpoint connection */
1009
+ properties: PrivateEndpointConnectionProperties;
1010
+ }
1011
+
1012
+ /** The properties of a private endpoint connection */
1013
+ export declare interface PrivateEndpointConnectionProperties {
1014
+ /** The private endpoint property of a private endpoint connection */
1015
+ privateEndpoint?: PrivateEndpoint;
1016
+ /** The current state of a private endpoint connection */
1017
+ privateLinkServiceConnectionState: PrivateLinkServiceConnectionState;
1018
+ }
1019
+
1020
+ /** The available private link resources for a provisioning service */
1021
+ export declare interface PrivateLinkResources {
1022
+ /** The list of available private link resources for a provisioning service */
1023
+ value?: GroupIdInformation[];
1024
+ }
1025
+
1026
+ /** The current state of a private endpoint connection */
1027
+ export declare interface PrivateLinkServiceConnectionState {
1028
+ /** The status of a private endpoint connection */
1029
+ status: PrivateLinkServiceConnectionStatus;
1030
+ /** The description for the current state of a private endpoint connection */
1031
+ description: string;
1032
+ /** Actions required for a private endpoint connection */
1033
+ actionsRequired?: string;
1034
+ }
1035
+
1036
+ /**
1037
+ * Defines values for PrivateLinkServiceConnectionStatus. \
1038
+ * {@link KnownPrivateLinkServiceConnectionStatus} can be used interchangeably with PrivateLinkServiceConnectionStatus,
1039
+ * this enum contains the known values that the service supports.
1040
+ * ### Known values supported by the service
1041
+ * **Pending** \
1042
+ * **Approved** \
1043
+ * **Rejected** \
1044
+ * **Disconnected**
1045
+ */
1046
+ export declare type PrivateLinkServiceConnectionStatus = string;
1047
+
1048
+ /** The description of the provisioning service. */
1049
+ export declare type ProvisioningServiceDescription = Resource & {
1050
+ /** The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. */
1051
+ etag?: string;
1052
+ /** Service specific properties for a provisioning service */
1053
+ properties: IotDpsPropertiesDescription;
1054
+ /** Sku info for a provisioning Service. */
1055
+ sku: IotDpsSkuInfo;
1056
+ };
1057
+
1058
+ /** List of provisioning service descriptions. */
1059
+ export declare interface ProvisioningServiceDescriptionListResult {
1060
+ /** List of provisioning service descriptions. */
1061
+ value?: ProvisioningServiceDescription[];
1062
+ /**
1063
+ * the next link
1064
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1065
+ */
1066
+ readonly nextLink?: string;
1067
+ }
1068
+
1069
+ /**
1070
+ * Defines values for PublicNetworkAccess. \
1071
+ * {@link KnownPublicNetworkAccess} can be used interchangeably with PublicNetworkAccess,
1072
+ * this enum contains the known values that the service supports.
1073
+ * ### Known values supported by the service
1074
+ * **Enabled** \
1075
+ * **Disabled**
1076
+ */
1077
+ export declare type PublicNetworkAccess = string;
1078
+
1079
+ /** The common properties of an Azure resource. */
1080
+ export declare interface Resource {
1081
+ /**
1082
+ * The resource identifier.
1083
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1084
+ */
1085
+ readonly id?: string;
1086
+ /**
1087
+ * The resource name.
1088
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1089
+ */
1090
+ readonly name?: string;
1091
+ /**
1092
+ * The resource type.
1093
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1094
+ */
1095
+ readonly type?: string;
1096
+ /** The resource location. */
1097
+ location: string;
1098
+ /** The resource tags. */
1099
+ tags?: {
1100
+ [propertyName: string]: string;
1101
+ };
1102
+ }
1103
+
1104
+ /** Description of the shared access key. */
1105
+ export declare interface SharedAccessSignatureAuthorizationRuleAccessRightsDescription {
1106
+ /** Name of the key. */
1107
+ keyName: string;
1108
+ /** Primary SAS key value. */
1109
+ primaryKey?: string;
1110
+ /** Secondary SAS key value. */
1111
+ secondaryKey?: string;
1112
+ /** Rights that this key has. */
1113
+ rights: AccessRightsDescription;
1114
+ }
1115
+
1116
+ /** List of shared access keys. */
1117
+ export declare interface SharedAccessSignatureAuthorizationRuleListResult {
1118
+ /** The list of shared access policies. */
1119
+ value?: SharedAccessSignatureAuthorizationRuleAccessRightsDescription[];
1120
+ /**
1121
+ * The next link.
1122
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1123
+ */
1124
+ readonly nextLink?: string;
1125
+ }
1126
+
1127
+ /**
1128
+ * Defines values for State. \
1129
+ * {@link KnownState} can be used interchangeably with State,
1130
+ * this enum contains the known values that the service supports.
1131
+ * ### Known values supported by the service
1132
+ * **Activating** \
1133
+ * **Active** \
1134
+ * **Deleting** \
1135
+ * **Deleted** \
1136
+ * **ActivationFailed** \
1137
+ * **DeletionFailed** \
1138
+ * **Transitioning** \
1139
+ * **Suspending** \
1140
+ * **Suspended** \
1141
+ * **Resuming** \
1142
+ * **FailingOver** \
1143
+ * **FailoverFailed**
1144
+ */
1145
+ export declare type State = string;
1146
+
1147
+ /** A container holding only the Tags for a resource, allowing the user to update the tags on a Provisioning Service instance. */
1148
+ export declare interface TagsResource {
1149
+ /** Resource tags */
1150
+ tags?: {
1151
+ [propertyName: string]: string;
1152
+ };
1153
+ }
1154
+
1155
+ /** The JSON-serialized leaf certificate */
1156
+ export declare interface VerificationCodeRequest {
1157
+ /** base-64 representation of X509 certificate .cer file or just .pem file content. */
1158
+ certificate?: string;
1159
+ }
1160
+
1161
+ /** Description of the response of the verification code. */
1162
+ export declare interface VerificationCodeResponse {
1163
+ /**
1164
+ * Name of certificate.
1165
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1166
+ */
1167
+ readonly name?: string;
1168
+ /**
1169
+ * Request etag.
1170
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1171
+ */
1172
+ readonly etag?: string;
1173
+ /**
1174
+ * The resource identifier.
1175
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1176
+ */
1177
+ readonly id?: string;
1178
+ /**
1179
+ * The resource type.
1180
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1181
+ */
1182
+ readonly type?: string;
1183
+ properties?: VerificationCodeResponseProperties;
1184
+ }
1185
+
1186
+ export declare interface VerificationCodeResponseProperties {
1187
+ /** Verification code. */
1188
+ verificationCode?: string;
1189
+ /** Certificate subject. */
1190
+ subject?: string;
1191
+ /** Code expiry. */
1192
+ expiry?: string;
1193
+ /** Certificate thumbprint. */
1194
+ thumbprint?: string;
1195
+ /** Indicate if the certificate is verified by owner of private key. */
1196
+ isVerified?: boolean;
1197
+ /** base-64 representation of X509 certificate .cer file or just .pem file content. */
1198
+ certificate?: Uint8Array;
1199
+ /** Certificate created time. */
1200
+ created?: string;
1201
+ /** Certificate updated time. */
1202
+ updated?: string;
1203
+ }
1204
+
1205
+ export { }