@azure/arm-deviceprovisioningservices 3.0.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 (137) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/LICENSE +21 -0
  3. package/LICENSE.txt +1 -1
  4. package/README.md +70 -78
  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 +440 -498
  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/{esm → dist-esm/src}/models/parameters.js +136 -115
  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 +1 -2
  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/{esm/models/operationsMappers.js → dist-esm/src/operationsInterfaces/dpsCertificate.js} +2 -2
  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/{esm/models/index.js → dist-esm/src/operationsInterfaces/operations.js} +2 -1
  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 +65 -32
  70. package/review/arm-deviceprovisioningservices.api.md +690 -0
  71. package/rollup.config.js +181 -30
  72. package/src/index.ts +12 -0
  73. package/src/iotDpsClient.ts +72 -36
  74. package/src/lroImpl.ts +34 -0
  75. package/src/models/index.ts +686 -1289
  76. package/src/models/mappers.ts +449 -505
  77. package/src/models/parameters.ts +179 -116
  78. package/src/operations/dpsCertificate.ts +201 -304
  79. package/src/operations/index.ts +1 -2
  80. package/src/operations/iotDpsResource.ts +1157 -872
  81. package/src/operations/operations.ts +85 -73
  82. package/src/operationsInterfaces/dpsCertificate.ts +118 -0
  83. package/src/{models/operationsMappers.ts → operationsInterfaces/index.ts} +3 -6
  84. package/src/operationsInterfaces/iotDpsResource.ts +351 -0
  85. package/src/operationsInterfaces/operations.ts +22 -0
  86. package/tsconfig.json +3 -3
  87. package/types/arm-deviceprovisioningservices.d.ts +1205 -0
  88. package/types/tsdoc-metadata.json +11 -0
  89. package/dist/arm-deviceprovisioningservices.js +0 -2869
  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 -26
  94. package/esm/iotDpsClient.d.ts.map +0 -1
  95. package/esm/iotDpsClient.js +0 -39
  96. package/esm/iotDpsClient.js.map +0 -1
  97. package/esm/iotDpsClientContext.d.ts +0 -22
  98. package/esm/iotDpsClientContext.d.ts.map +0 -1
  99. package/esm/iotDpsClientContext.js +0 -60
  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 -9
  104. package/esm/models/dpsCertificateMappers.js.map +0 -1
  105. package/esm/models/index.d.ts +0 -1433
  106. package/esm/models/index.d.ts.map +0 -1
  107. package/esm/models/index.js.map +0 -1
  108. package/esm/models/iotDpsResourceMappers.d.ts +0 -2
  109. package/esm/models/iotDpsResourceMappers.d.ts.map +0 -1
  110. package/esm/models/iotDpsResourceMappers.js +0 -9
  111. package/esm/models/iotDpsResourceMappers.js.map +0 -1
  112. package/esm/models/mappers.d.ts +0 -38
  113. package/esm/models/mappers.d.ts.map +0 -1
  114. package/esm/models/mappers.js.map +0 -1
  115. package/esm/models/operationsMappers.d.ts +0 -2
  116. package/esm/models/operationsMappers.d.ts.map +0 -1
  117. package/esm/models/operationsMappers.js.map +0 -1
  118. package/esm/models/parameters.d.ts +0 -26
  119. package/esm/models/parameters.d.ts.map +0 -1
  120. package/esm/models/parameters.js.map +0 -1
  121. package/esm/operations/dpsCertificate.d.ts +0 -188
  122. package/esm/operations/dpsCertificate.d.ts.map +0 -1
  123. package/esm/operations/dpsCertificate.js +0 -264
  124. package/esm/operations/dpsCertificate.js.map +0 -1
  125. package/esm/operations/index.d.ts.map +0 -1
  126. package/esm/operations/index.js.map +0 -1
  127. package/esm/operations/iotDpsResource.d.ts +0 -473
  128. package/esm/operations/iotDpsResource.d.ts.map +0 -1
  129. package/esm/operations/iotDpsResource.js +0 -834
  130. package/esm/operations/iotDpsResource.js.map +0 -1
  131. package/esm/operations/operations.d.ts +0 -46
  132. package/esm/operations/operations.d.ts.map +0 -1
  133. package/esm/operations/operations.js +0 -79
  134. package/esm/operations/operations.js.map +0 -1
  135. package/src/iotDpsClientContext.ts +0 -67
  136. package/src/models/dpsCertificateMappers.ts +0 -30
  137. package/src/models/iotDpsResourceMappers.ts +0 -40
@@ -6,1544 +6,941 @@
6
6
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
7
7
  */
8
8
 
9
- import { BaseResource, CloudError, AzureServiceClientOptions } from "@azure/ms-rest-azure-js";
10
- import * as msRest from "@azure/ms-rest-js";
9
+ import * as coreClient from "@azure/core-client";
11
10
 
12
- export { BaseResource, CloudError };
13
-
14
- /**
15
- * Error response containing message and code.
16
- */
17
- export interface ErrorMesssage {
11
+ /** 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. */
12
+ export interface OperationListResult {
18
13
  /**
19
- * standard error code
14
+ * Provisioning service operations supported by the Microsoft.Devices resource provider.
15
+ * NOTE: This property will not be serialized. It can only be populated by the server.
20
16
  */
21
- code?: string;
22
- /**
23
- * standard error description
24
- */
25
- message?: string;
17
+ readonly value?: Operation[];
26
18
  /**
27
- * detailed summary of error
19
+ * URL to get the next set of operation list results if there are any.
20
+ * NOTE: This property will not be serialized. It can only be populated by the server.
28
21
  */
29
- details?: string;
22
+ readonly nextLink?: string;
30
23
  }
31
24
 
32
- /**
33
- * Result of a long running operation.
34
- */
35
- export interface AsyncOperationResult {
36
- /**
37
- * current status of a long running operation.
38
- */
39
- status?: string;
25
+ /** Provisioning Service REST API operation. */
26
+ export interface Operation {
40
27
  /**
41
- * Error message containing code, description and details
28
+ * Operation name: {provider}/{resource}/{read | write | action | delete}
29
+ * NOTE: This property will not be serialized. It can only be populated by the server.
42
30
  */
43
- error?: ErrorMesssage;
31
+ readonly name?: string;
32
+ /** The object that represents the operation. */
33
+ display?: OperationDisplay;
44
34
  }
45
35
 
46
- /**
47
- * The description of an X509 CA Certificate.
48
- */
49
- export interface CertificateProperties {
36
+ /** The object that represents the operation. */
37
+ export interface OperationDisplay {
50
38
  /**
51
- * The certificate's subject name.
52
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
39
+ * Service provider: Microsoft Devices.
40
+ * NOTE: This property will not be serialized. It can only be populated by the server.
53
41
  */
54
- readonly subject?: string;
42
+ readonly provider?: string;
55
43
  /**
56
- * The certificate's expiration date and time.
57
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
44
+ * Resource Type: ProvisioningServices.
45
+ * NOTE: This property will not be serialized. It can only be populated by the server.
58
46
  */
59
- readonly expiry?: Date;
47
+ readonly resource?: string;
60
48
  /**
61
- * The certificate's thumbprint.
62
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
49
+ * Name of the operation.
50
+ * NOTE: This property will not be serialized. It can only be populated by the server.
63
51
  */
64
- readonly thumbprint?: string;
52
+ readonly operation?: string;
53
+ }
54
+
55
+ /** Error details. */
56
+ export interface ErrorDetails {
65
57
  /**
66
- * Determines whether certificate has been verified.
67
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
58
+ * The error code.
59
+ * NOTE: This property will not be serialized. It can only be populated by the server.
68
60
  */
69
- readonly isVerified?: boolean;
61
+ readonly code?: string;
70
62
  /**
71
- * base-64 representation of X509 certificate .cer file or just .pem file content.
72
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
63
+ * The HTTP status code.
64
+ * NOTE: This property will not be serialized. It can only be populated by the server.
73
65
  */
74
- readonly certificate?: Uint8Array;
66
+ readonly httpStatusCode?: string;
75
67
  /**
76
- * The certificate's creation date and time.
77
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
68
+ * The error message.
69
+ * NOTE: This property will not be serialized. It can only be populated by the server.
78
70
  */
79
- readonly created?: Date;
71
+ readonly message?: string;
80
72
  /**
81
- * The certificate's last update date and time.
82
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
73
+ * The error details.
74
+ * NOTE: This property will not be serialized. It can only be populated by the server.
83
75
  */
84
- readonly updated?: Date;
76
+ readonly details?: string;
85
77
  }
86
78
 
87
- /**
88
- * The X509 Certificate.
89
- */
90
- export interface CertificateResponse extends BaseResource {
91
- /**
92
- * properties of a certificate
93
- */
79
+ /** The X509 Certificate. */
80
+ export interface CertificateResponse {
81
+ /** properties of a certificate */
94
82
  properties?: CertificateProperties;
95
83
  /**
96
84
  * The resource identifier.
97
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
85
+ * NOTE: This property will not be serialized. It can only be populated by the server.
98
86
  */
99
87
  readonly id?: string;
100
88
  /**
101
89
  * The name of the certificate.
102
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
90
+ * NOTE: This property will not be serialized. It can only be populated by the server.
103
91
  */
104
92
  readonly name?: string;
105
93
  /**
106
94
  * The entity tag.
107
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
95
+ * NOTE: This property will not be serialized. It can only be populated by the server.
108
96
  */
109
97
  readonly etag?: string;
110
98
  /**
111
99
  * The resource type.
112
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
100
+ * NOTE: This property will not be serialized. It can only be populated by the server.
113
101
  */
114
102
  readonly type?: string;
115
103
  }
116
104
 
117
- /**
118
- * The JSON-serialized array of Certificate objects.
119
- */
120
- export interface CertificateListDescription {
105
+ /** The description of an X509 CA Certificate. */
106
+ export interface CertificateProperties {
121
107
  /**
122
- * The array of Certificate objects.
108
+ * The certificate's subject name.
109
+ * NOTE: This property will not be serialized. It can only be populated by the server.
123
110
  */
124
- value?: CertificateResponse[];
125
- }
126
-
127
- /**
128
- * The JSON-serialized X509 Certificate.
129
- */
130
- export interface CertificateBodyDescription {
111
+ readonly subject?: string;
131
112
  /**
132
- * Base-64 representation of the X509 leaf certificate .cer file or just .pem file content.
113
+ * The certificate's expiration date and time.
114
+ * NOTE: This property will not be serialized. It can only be populated by the server.
133
115
  */
134
- certificate?: string;
116
+ readonly expiry?: Date;
135
117
  /**
136
- * True indicates that the certificate will be created in verified state and proof of possession
137
- * will not be required.
118
+ * The certificate's thumbprint.
119
+ * NOTE: This property will not be serialized. It can only be populated by the server.
138
120
  */
139
- isVerified?: boolean;
140
- }
141
-
142
- /**
143
- * List of possible provisioning service SKUs.
144
- */
145
- export interface IotDpsSkuInfo {
121
+ readonly thumbprint?: string;
146
122
  /**
147
- * Sku name. Possible values include: 'S1'
123
+ * Determines whether certificate has been verified.
124
+ * NOTE: This property will not be serialized. It can only be populated by the server.
148
125
  */
149
- name?: IotDpsSku;
126
+ readonly isVerified?: boolean;
150
127
  /**
151
- * Pricing tier name of the provisioning service.
152
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
128
+ * base-64 representation of X509 certificate .cer file or just .pem file content.
129
+ * NOTE: This property will not be serialized. It can only be populated by the server.
153
130
  */
154
- readonly tier?: string;
131
+ readonly certificate?: Uint8Array;
155
132
  /**
156
- * The number of units to provision
133
+ * The certificate's creation date and time.
134
+ * NOTE: This property will not be serialized. It can only be populated by the server.
157
135
  */
158
- capacity?: number;
136
+ readonly created?: Date;
137
+ /**
138
+ * The certificate's last update date and time.
139
+ * NOTE: This property will not be serialized. It can only be populated by the server.
140
+ */
141
+ readonly updated?: Date;
159
142
  }
160
143
 
161
- /**
162
- * The IP filter rules for a provisioning Service.
163
- */
164
- export interface IpFilterRule {
144
+ /** The JSON-serialized X509 Certificate. */
145
+ export interface CertificateBodyDescription {
146
+ /** Base-64 representation of the X509 leaf certificate .cer file or just .pem file content. */
147
+ certificate?: string;
148
+ /** True indicates that the certificate will be created in verified state and proof of possession will not be required. */
149
+ isVerified?: boolean;
150
+ }
151
+
152
+ /** the service specific properties of a provisioning service, including keys, linked iot hubs, current state, and system generated properties such as hostname and idScope */
153
+ export interface IotDpsPropertiesDescription {
154
+ /** Current state of the provisioning service. */
155
+ state?: State;
156
+ /** Whether requests from Public Network are allowed */
157
+ publicNetworkAccess?: PublicNetworkAccess;
158
+ /** The IP filter rules. */
159
+ ipFilterRules?: IpFilterRule[];
160
+ /** Private endpoint connections created on this IotHub */
161
+ privateEndpointConnections?: PrivateEndpointConnection[];
162
+ /** The ARM provisioning state of the provisioning service. */
163
+ provisioningState?: string;
164
+ /** List of IoT hubs associated with this provisioning service. */
165
+ iotHubs?: IotHubDefinitionDescription[];
166
+ /** Allocation policy to be used by this provisioning service. */
167
+ allocationPolicy?: AllocationPolicy;
165
168
  /**
166
- * The name of the IP filter rule.
169
+ * Service endpoint for provisioning service.
170
+ * NOTE: This property will not be serialized. It can only be populated by the server.
167
171
  */
168
- filterName: string;
172
+ readonly serviceOperationsHostName?: string;
169
173
  /**
170
- * The desired action for requests captured by this rule. Possible values include: 'Accept',
171
- * 'Reject'
174
+ * Device endpoint for this provisioning service.
175
+ * NOTE: This property will not be serialized. It can only be populated by the server.
172
176
  */
173
- action: IpFilterActionType;
177
+ readonly deviceProvisioningHostName?: string;
174
178
  /**
175
- * A string that contains the IP address range in CIDR notation for the rule.
179
+ * Unique identifier of this provisioning service.
180
+ * NOTE: This property will not be serialized. It can only be populated by the server.
176
181
  */
182
+ readonly idScope?: string;
183
+ /** List of authorization keys for a provisioning service. */
184
+ authorizationPolicies?: SharedAccessSignatureAuthorizationRuleAccessRightsDescription[];
185
+ }
186
+
187
+ /** The IP filter rules for a provisioning Service. */
188
+ export interface IpFilterRule {
189
+ /** The name of the IP filter rule. */
190
+ filterName: string;
191
+ /** The desired action for requests captured by this rule. */
192
+ action: IpFilterActionType;
193
+ /** A string that contains the IP address range in CIDR notation for the rule. */
177
194
  ipMask: string;
178
- /**
179
- * Target for requests captured by this rule. Possible values include: 'all', 'serviceApi',
180
- * 'deviceApi'
181
- */
195
+ /** Target for requests captured by this rule. */
182
196
  target?: IpFilterTargetType;
183
197
  }
184
198
 
185
- /**
186
- * The private endpoint property of a private endpoint connection
187
- */
188
- export interface PrivateEndpoint {
199
+ /** The private endpoint connection of a provisioning service */
200
+ export interface PrivateEndpointConnection {
189
201
  /**
190
202
  * The resource identifier.
191
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
203
+ * NOTE: This property will not be serialized. It can only be populated by the server.
192
204
  */
193
205
  readonly id?: string;
194
- }
195
-
196
- /**
197
- * The current state of a private endpoint connection
198
- */
199
- export interface PrivateLinkServiceConnectionState {
200
- /**
201
- * The status of a private endpoint connection. Possible values include: 'Pending', 'Approved',
202
- * 'Rejected', 'Disconnected'
203
- */
204
- status: PrivateLinkServiceConnectionStatus;
205
206
  /**
206
- * The description for the current state of a private endpoint connection
207
+ * The resource name.
208
+ * NOTE: This property will not be serialized. It can only be populated by the server.
207
209
  */
208
- description: string;
210
+ readonly name?: string;
209
211
  /**
210
- * Actions required for a private endpoint connection
212
+ * The resource type.
213
+ * NOTE: This property will not be serialized. It can only be populated by the server.
211
214
  */
212
- actionsRequired?: string;
215
+ readonly type?: string;
216
+ /** The properties of a private endpoint connection */
217
+ properties: PrivateEndpointConnectionProperties;
213
218
  }
214
219
 
215
- /**
216
- * The properties of a private endpoint connection
217
- */
220
+ /** The properties of a private endpoint connection */
218
221
  export interface PrivateEndpointConnectionProperties {
219
- /**
220
- * The private endpoint property of a private endpoint connection
221
- */
222
+ /** The private endpoint property of a private endpoint connection */
222
223
  privateEndpoint?: PrivateEndpoint;
223
- /**
224
- * The current state of a private endpoint connection
225
- */
224
+ /** The current state of a private endpoint connection */
226
225
  privateLinkServiceConnectionState: PrivateLinkServiceConnectionState;
227
226
  }
228
227
 
229
- /**
230
- * The private endpoint connection of a provisioning service
231
- */
232
- export interface PrivateEndpointConnection extends BaseResource {
228
+ /** The private endpoint property of a private endpoint connection */
229
+ export interface PrivateEndpoint {
233
230
  /**
234
231
  * The resource identifier.
235
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
232
+ * NOTE: This property will not be serialized. It can only be populated by the server.
236
233
  */
237
234
  readonly id?: string;
238
- /**
239
- * The resource name.
240
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
241
- */
242
- readonly name?: string;
243
- /**
244
- * The resource type.
245
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
246
- */
247
- readonly type?: string;
248
- /**
249
- * The properties of a private endpoint connection
250
- */
251
- properties: PrivateEndpointConnectionProperties;
252
235
  }
253
236
 
254
- /**
255
- * Description of the IoT hub.
256
- */
237
+ /** The current state of a private endpoint connection */
238
+ export interface PrivateLinkServiceConnectionState {
239
+ /** The status of a private endpoint connection */
240
+ status: PrivateLinkServiceConnectionStatus;
241
+ /** The description for the current state of a private endpoint connection */
242
+ description: string;
243
+ /** Actions required for a private endpoint connection */
244
+ actionsRequired?: string;
245
+ }
246
+
247
+ /** Description of the IoT hub. */
257
248
  export interface IotHubDefinitionDescription {
258
- /**
259
- * flag for applying allocationPolicy or not for a given iot hub.
260
- */
249
+ /** flag for applying allocationPolicy or not for a given iot hub. */
261
250
  applyAllocationPolicy?: boolean;
262
- /**
263
- * weight to apply for a given iot h.
264
- */
251
+ /** weight to apply for a given iot h. */
265
252
  allocationWeight?: number;
266
253
  /**
267
254
  * Host name of the IoT hub.
268
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
255
+ * NOTE: This property will not be serialized. It can only be populated by the server.
269
256
  */
270
257
  readonly name?: string;
271
- /**
272
- * Connection string of the IoT hub.
273
- */
258
+ /** Connection string of the IoT hub. */
274
259
  connectionString: string;
275
- /**
276
- * ARM region of the IoT hub.
277
- */
260
+ /** ARM region of the IoT hub. */
278
261
  location: string;
279
262
  }
280
263
 
281
- /**
282
- * Description of the shared access key.
283
- */
264
+ /** Description of the shared access key. */
284
265
  export interface SharedAccessSignatureAuthorizationRuleAccessRightsDescription {
285
- /**
286
- * Name of the key.
287
- */
266
+ /** Name of the key. */
288
267
  keyName: string;
289
- /**
290
- * Primary SAS key value.
291
- */
268
+ /** Primary SAS key value. */
292
269
  primaryKey?: string;
293
- /**
294
- * Secondary SAS key value.
295
- */
270
+ /** Secondary SAS key value. */
296
271
  secondaryKey?: string;
297
- /**
298
- * Rights that this key has. Possible values include: 'ServiceConfig', 'EnrollmentRead',
299
- * 'EnrollmentWrite', 'DeviceConnect', 'RegistrationStatusRead', 'RegistrationStatusWrite'
300
- */
272
+ /** Rights that this key has. */
301
273
  rights: AccessRightsDescription;
302
274
  }
303
275
 
304
- /**
305
- * the service specific properties of a provisioning service, including keys, linked iot hubs,
306
- * current state, and system generated properties such as hostname and idScope
307
- */
308
- export interface IotDpsPropertiesDescription {
309
- /**
310
- * Current state of the provisioning service. Possible values include: 'Activating', 'Active',
311
- * 'Deleting', 'Deleted', 'ActivationFailed', 'DeletionFailed', 'Transitioning', 'Suspending',
312
- * 'Suspended', 'Resuming', 'FailingOver', 'FailoverFailed'
313
- */
314
- state?: State;
315
- /**
316
- * Whether requests from Public Network are allowed. Possible values include: 'Enabled',
317
- * 'Disabled'
318
- */
319
- publicNetworkAccess?: PublicNetworkAccess;
320
- /**
321
- * The IP filter rules.
322
- */
323
- ipFilterRules?: IpFilterRule[];
324
- /**
325
- * Private endpoint connections created on this IotHub
326
- */
327
- privateEndpointConnections?: PrivateEndpointConnection[];
328
- /**
329
- * The ARM provisioning state of the provisioning service.
330
- */
331
- provisioningState?: string;
332
- /**
333
- * List of IoT hubs associated with this provisioning service.
334
- */
335
- iotHubs?: IotHubDefinitionDescription[];
336
- /**
337
- * Allocation policy to be used by this provisioning service. Possible values include: 'Hashed',
338
- * 'GeoLatency', 'Static'
339
- */
340
- allocationPolicy?: AllocationPolicy;
341
- /**
342
- * Service endpoint for provisioning service.
343
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
344
- */
345
- readonly serviceOperationsHostName?: string;
346
- /**
347
- * Device endpoint for this provisioning service.
348
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
349
- */
350
- readonly deviceProvisioningHostName?: string;
351
- /**
352
- * Unique identifier of this provisioning service.
353
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
354
- */
355
- readonly idScope?: string;
276
+ /** List of possible provisioning service SKUs. */
277
+ export interface IotDpsSkuInfo {
278
+ /** Sku name. */
279
+ name?: IotDpsSku;
356
280
  /**
357
- * List of authorization keys for a provisioning service.
281
+ * Pricing tier name of the provisioning service.
282
+ * NOTE: This property will not be serialized. It can only be populated by the server.
358
283
  */
359
- authorizationPolicies?: SharedAccessSignatureAuthorizationRuleAccessRightsDescription[];
284
+ readonly tier?: string;
285
+ /** The number of units to provision */
286
+ capacity?: number;
360
287
  }
361
288
 
362
- /**
363
- * The common properties of an Azure resource.
364
- */
365
- export interface Resource extends BaseResource {
289
+ /** The common properties of an Azure resource. */
290
+ export interface Resource {
366
291
  /**
367
292
  * The resource identifier.
368
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
293
+ * NOTE: This property will not be serialized. It can only be populated by the server.
369
294
  */
370
295
  readonly id?: string;
371
296
  /**
372
297
  * The resource name.
373
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
298
+ * NOTE: This property will not be serialized. It can only be populated by the server.
374
299
  */
375
300
  readonly name?: string;
376
301
  /**
377
302
  * The resource type.
378
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
303
+ * NOTE: This property will not be serialized. It can only be populated by the server.
379
304
  */
380
305
  readonly type?: string;
381
- /**
382
- * The resource location.
383
- */
306
+ /** The resource location. */
384
307
  location: string;
385
- /**
386
- * The resource tags.
387
- */
308
+ /** The resource tags. */
388
309
  tags?: { [propertyName: string]: string };
389
310
  }
390
311
 
391
- /**
392
- * The description of the provisioning service.
393
- */
394
- export interface ProvisioningServiceDescription extends Resource {
395
- /**
396
- * The Etag field is *not* required. If it is provided in the response body, it must also be
397
- * provided as a header per the normal ETag convention.
398
- */
399
- etag?: string;
400
- /**
401
- * Service specific properties for a provisioning service
402
- */
403
- properties: IotDpsPropertiesDescription;
404
- /**
405
- * Sku info for a provisioning Service.
406
- */
407
- sku: IotDpsSkuInfo;
312
+ /** A container holding only the Tags for a resource, allowing the user to update the tags on a Provisioning Service instance. */
313
+ export interface TagsResource {
314
+ /** Resource tags */
315
+ tags?: { [propertyName: string]: string };
408
316
  }
409
317
 
410
- /**
411
- * The properties for a group information object
412
- */
413
- export interface GroupIdInformationProperties {
414
- /**
415
- * The group id
416
- */
417
- groupId?: string;
418
- /**
419
- * The required members for a specific group id
420
- */
421
- requiredMembers?: string[];
422
- /**
423
- * The required DNS zones for a specific group id
424
- */
425
- requiredZoneNames?: string[];
426
- }
427
-
428
- /**
429
- * The group information for creating a private endpoint on a provisioning service
430
- */
431
- export interface GroupIdInformation {
432
- /**
433
- * The resource identifier.
434
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
435
- */
436
- readonly id?: string;
437
- /**
438
- * The resource name.
439
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
440
- */
441
- readonly name?: string;
442
- /**
443
- * The resource type.
444
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
445
- */
446
- readonly type?: string;
447
- /**
448
- * The properties for a group information object
449
- */
450
- properties: GroupIdInformationProperties;
318
+ /** The JSON-serialized array of Certificate objects. */
319
+ export interface CertificateListDescription {
320
+ /** The array of Certificate objects. */
321
+ value?: CertificateResponse[];
451
322
  }
452
323
 
453
- /**
454
- * The available private link resources for a provisioning service
455
- */
456
- export interface PrivateLinkResources {
324
+ /** List of provisioning service descriptions. */
325
+ export interface ProvisioningServiceDescriptionListResult {
326
+ /** List of provisioning service descriptions. */
327
+ value?: ProvisioningServiceDescription[];
457
328
  /**
458
- * The list of available private link resources for a provisioning service
329
+ * the next link
330
+ * NOTE: This property will not be serialized. It can only be populated by the server.
459
331
  */
460
- value?: GroupIdInformation[];
332
+ readonly nextLink?: string;
461
333
  }
462
334
 
463
- /**
464
- * The object that represents the operation.
465
- */
466
- export interface OperationDisplay {
467
- /**
468
- * Service provider: Microsoft Devices.
469
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
470
- */
471
- readonly provider?: string;
472
- /**
473
- * Resource Type: ProvisioningServices.
474
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
475
- */
476
- readonly resource?: string;
477
- /**
478
- * Name of the operation.
479
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
480
- */
481
- readonly operation?: string;
335
+ /** Result of a long running operation. */
336
+ export interface AsyncOperationResult {
337
+ /** current status of a long running operation. */
338
+ status?: string;
339
+ /** Error message containing code, description and details */
340
+ error?: ErrorMesssage;
482
341
  }
483
342
 
484
- /**
485
- * Provisioning Service REST API operation.
486
- */
487
- export interface Operation {
488
- /**
489
- * Operation name: {provider}/{resource}/{read | write | action | delete}
490
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
491
- */
492
- readonly name?: string;
493
- /**
494
- * The object that represents the operation.
495
- */
496
- display?: OperationDisplay;
343
+ /** Error response containing message and code. */
344
+ export interface ErrorMesssage {
345
+ /** standard error code */
346
+ code?: string;
347
+ /** standard error description */
348
+ message?: string;
349
+ /** detailed summary of error */
350
+ details?: string;
497
351
  }
498
352
 
499
- /**
500
- * Error details.
501
- */
502
- export interface ErrorDetails {
503
- /**
504
- * The error code.
505
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
506
- */
507
- readonly code?: string;
508
- /**
509
- * The HTTP status code.
510
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
511
- */
512
- readonly httpStatusCode?: string;
513
- /**
514
- * The error message.
515
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
516
- */
517
- readonly message?: string;
353
+ /** List of available SKUs. */
354
+ export interface IotDpsSkuDefinitionListResult {
355
+ /** The list of SKUs */
356
+ value?: IotDpsSkuDefinition[];
518
357
  /**
519
- * The error details.
520
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
358
+ * The next link.
359
+ * NOTE: This property will not be serialized. It can only be populated by the server.
521
360
  */
522
- readonly details?: string;
361
+ readonly nextLink?: string;
523
362
  }
524
363
 
525
- /**
526
- * Available SKUs of tier and units.
527
- */
364
+ /** Available SKUs of tier and units. */
528
365
  export interface IotDpsSkuDefinition {
529
- /**
530
- * Sku name. Possible values include: 'S1'
531
- */
366
+ /** Sku name. */
532
367
  name?: IotDpsSku;
533
368
  }
534
369
 
535
- /**
536
- * Input values for operation results call.
537
- */
538
- export interface OperationInputs {
539
- /**
540
- * The name of the Provisioning Service to check.
541
- */
542
- name: string;
543
- }
544
-
545
- /**
546
- * Description of name availability.
547
- */
548
- export interface NameAvailabilityInfo {
370
+ /** Description of the response of the verification code. */
371
+ export interface VerificationCodeResponse {
549
372
  /**
550
- * specifies if a name is available or not
373
+ * Name of certificate.
374
+ * NOTE: This property will not be serialized. It can only be populated by the server.
551
375
  */
552
- nameAvailable?: boolean;
376
+ readonly name?: string;
553
377
  /**
554
- * specifies the reason a name is unavailable. Possible values include: 'Invalid',
555
- * 'AlreadyExists'
378
+ * Request etag.
379
+ * NOTE: This property will not be serialized. It can only be populated by the server.
556
380
  */
557
- reason?: NameUnavailabilityReason;
381
+ readonly etag?: string;
558
382
  /**
559
- * message containing a detailed reason name is unavailable
383
+ * The resource identifier.
384
+ * NOTE: This property will not be serialized. It can only be populated by the server.
560
385
  */
561
- message?: string;
562
- }
563
-
564
- /**
565
- * A container holding only the Tags for a resource, allowing the user to update the tags on a
566
- * Provisioning Service instance.
567
- */
568
- export interface TagsResource {
386
+ readonly id?: string;
569
387
  /**
570
- * Resource tags
388
+ * The resource type.
389
+ * NOTE: This property will not be serialized. It can only be populated by the server.
571
390
  */
572
- tags?: { [propertyName: string]: string };
391
+ readonly type?: string;
392
+ properties?: VerificationCodeResponseProperties;
573
393
  }
574
394
 
575
- /**
576
- * An interface representing VerificationCodeResponseProperties.
577
- */
578
395
  export interface VerificationCodeResponseProperties {
579
- /**
580
- * Verification code.
581
- */
396
+ /** Verification code. */
582
397
  verificationCode?: string;
583
- /**
584
- * Certificate subject.
585
- */
398
+ /** Certificate subject. */
586
399
  subject?: string;
587
- /**
588
- * Code expiry.
589
- */
400
+ /** Code expiry. */
590
401
  expiry?: string;
591
- /**
592
- * Certificate thumbprint.
593
- */
402
+ /** Certificate thumbprint. */
594
403
  thumbprint?: string;
595
- /**
596
- * Indicate if the certificate is verified by owner of private key.
597
- */
404
+ /** Indicate if the certificate is verified by owner of private key. */
598
405
  isVerified?: boolean;
599
- /**
600
- * base-64 representation of X509 certificate .cer file or just .pem file content.
601
- */
406
+ /** base-64 representation of X509 certificate .cer file or just .pem file content. */
602
407
  certificate?: Uint8Array;
603
- /**
604
- * Certificate created time.
605
- */
408
+ /** Certificate created time. */
606
409
  created?: string;
607
- /**
608
- * Certificate updated time.
609
- */
410
+ /** Certificate updated time. */
610
411
  updated?: string;
611
412
  }
612
413
 
613
- /**
614
- * Description of the response of the verification code.
615
- */
616
- export interface VerificationCodeResponse extends BaseResource {
617
- /**
618
- * Name of certificate.
619
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
620
- */
621
- readonly name?: string;
622
- /**
623
- * Request etag.
624
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
625
- */
626
- readonly etag?: string;
627
- /**
628
- * The resource identifier.
629
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
630
- */
631
- readonly id?: string;
632
- /**
633
- * The resource type.
634
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
635
- */
636
- readonly type?: string;
637
- properties?: VerificationCodeResponseProperties;
638
- }
639
-
640
- /**
641
- * The JSON-serialized leaf certificate
642
- */
414
+ /** The JSON-serialized leaf certificate */
643
415
  export interface VerificationCodeRequest {
644
- /**
645
- * base-64 representation of X509 certificate .cer file or just .pem file content.
646
- */
416
+ /** base-64 representation of X509 certificate .cer file or just .pem file content. */
647
417
  certificate?: string;
648
418
  }
649
419
 
650
- /**
651
- * Optional Parameters.
652
- */
653
- export interface DpsCertificateGetOptionalParams extends msRest.RequestOptionsBase {
654
- /**
655
- * ETag of the certificate.
656
- */
657
- ifMatch?: string;
420
+ /** Input values for operation results call. */
421
+ export interface OperationInputs {
422
+ /** The name of the Provisioning Service to check. */
423
+ name: string;
658
424
  }
659
425
 
660
- /**
661
- * Optional Parameters.
662
- */
663
- export interface DpsCertificateCreateOrUpdateOptionalParams extends msRest.RequestOptionsBase {
664
- /**
665
- * ETag of the certificate. This is required to update an existing certificate, and ignored while
666
- * creating a brand new certificate.
667
- */
668
- ifMatch?: string;
426
+ /** Description of name availability. */
427
+ export interface NameAvailabilityInfo {
428
+ /** specifies if a name is available or not */
429
+ nameAvailable?: boolean;
430
+ /** specifies the reason a name is unavailable */
431
+ reason?: NameUnavailabilityReason;
432
+ /** message containing a detailed reason name is unavailable */
433
+ message?: string;
669
434
  }
670
435
 
671
- /**
672
- * Optional Parameters.
673
- */
674
- export interface DpsCertificateDeleteMethodOptionalParams extends msRest.RequestOptionsBase {
675
- /**
676
- * This is optional, and it is the Common Name of the certificate.
677
- */
678
- certificatename?: string;
679
- /**
680
- * Raw data within the certificate.
681
- */
682
- certificaterawBytes?: Uint8Array;
683
- /**
684
- * Indicates if certificate has been verified by owner of the private key.
685
- */
686
- certificateisVerified?: boolean;
687
- /**
688
- * A description that mentions the purpose of the certificate. Possible values include:
689
- * 'clientAuthentication', 'serverAuthentication'
690
- */
691
- certificatepurpose?: CertificatePurpose;
692
- /**
693
- * Time the certificate is created.
694
- */
695
- certificatecreated?: Date;
696
- /**
697
- * Time the certificate is last updated.
698
- */
699
- certificatelastUpdated?: Date;
700
- /**
701
- * Indicates if the certificate contains a private key.
702
- */
703
- certificatehasPrivateKey?: boolean;
436
+ /** List of shared access keys. */
437
+ export interface SharedAccessSignatureAuthorizationRuleListResult {
438
+ /** The list of shared access policies. */
439
+ value?: SharedAccessSignatureAuthorizationRuleAccessRightsDescription[];
704
440
  /**
705
- * Random number generated to indicate Proof of Possession.
441
+ * The next link.
442
+ * NOTE: This property will not be serialized. It can only be populated by the server.
706
443
  */
707
- certificatenonce?: string;
444
+ readonly nextLink?: string;
708
445
  }
709
446
 
710
- /**
711
- * Optional Parameters.
712
- */
713
- export interface DpsCertificateGenerateVerificationCodeOptionalParams extends msRest.RequestOptionsBase {
714
- /**
715
- * Common Name for the certificate.
716
- */
717
- certificatename?: string;
718
- /**
719
- * Raw data of certificate.
720
- */
721
- certificaterawBytes?: Uint8Array;
722
- /**
723
- * Indicates if the certificate has been verified by owner of the private key.
724
- */
725
- certificateisVerified?: boolean;
726
- /**
727
- * Description mentioning the purpose of the certificate. Possible values include:
728
- * 'clientAuthentication', 'serverAuthentication'
729
- */
730
- certificatepurpose?: CertificatePurpose;
731
- /**
732
- * Certificate creation time.
733
- */
734
- certificatecreated?: Date;
735
- /**
736
- * Certificate last updated time.
737
- */
738
- certificatelastUpdated?: Date;
739
- /**
740
- * Indicates if the certificate contains private key.
741
- */
742
- certificatehasPrivateKey?: boolean;
743
- /**
744
- * Random number generated to indicate Proof of Possession.
745
- */
746
- certificatenonce?: string;
447
+ /** The available private link resources for a provisioning service */
448
+ export interface PrivateLinkResources {
449
+ /** The list of available private link resources for a provisioning service */
450
+ value?: GroupIdInformation[];
747
451
  }
748
452
 
749
- /**
750
- * Optional Parameters.
751
- */
752
- export interface DpsCertificateVerifyCertificateOptionalParams extends msRest.RequestOptionsBase {
753
- /**
754
- * Common Name for the certificate.
755
- */
756
- certificatename?: string;
757
- /**
758
- * Raw data of certificate.
759
- */
760
- certificaterawBytes?: Uint8Array;
761
- /**
762
- * Indicates if the certificate has been verified by owner of the private key.
763
- */
764
- certificateisVerified?: boolean;
765
- /**
766
- * Describe the purpose of the certificate. Possible values include: 'clientAuthentication',
767
- * 'serverAuthentication'
768
- */
769
- certificatepurpose?: CertificatePurpose;
770
- /**
771
- * Certificate creation time.
772
- */
773
- certificatecreated?: Date;
453
+ /** The group information for creating a private endpoint on a provisioning service */
454
+ export interface GroupIdInformation {
774
455
  /**
775
- * Certificate last updated time.
456
+ * The resource identifier.
457
+ * NOTE: This property will not be serialized. It can only be populated by the server.
776
458
  */
777
- certificatelastUpdated?: Date;
459
+ readonly id?: string;
778
460
  /**
779
- * Indicates if the certificate contains private key.
461
+ * The resource name.
462
+ * NOTE: This property will not be serialized. It can only be populated by the server.
780
463
  */
781
- certificatehasPrivateKey?: boolean;
464
+ readonly name?: string;
782
465
  /**
783
- * Random number generated to indicate Proof of Possession.
466
+ * The resource type.
467
+ * NOTE: This property will not be serialized. It can only be populated by the server.
784
468
  */
785
- certificatenonce?: string;
469
+ readonly type?: string;
470
+ /** The properties for a group information object */
471
+ properties: GroupIdInformationProperties;
786
472
  }
787
473
 
788
- /**
789
- * An interface representing IotDpsClientOptions.
790
- */
791
- export interface IotDpsClientOptions extends AzureServiceClientOptions {
792
- baseUri?: string;
474
+ /** The properties for a group information object */
475
+ export interface GroupIdInformationProperties {
476
+ /** The group id */
477
+ groupId?: string;
478
+ /** The required members for a specific group id */
479
+ requiredMembers?: string[];
480
+ /** The required DNS zones for a specific group id */
481
+ requiredZoneNames?: string[];
793
482
  }
794
483
 
795
- /**
796
- * @interface
797
- * Result of the request to list provisioning service operations. It contains a list of operations
798
- * and a URL link to get the next set of results.
799
- * @extends Array<Operation>
800
- */
801
- export interface OperationListResult extends Array<Operation> {
802
- /**
803
- * URL to get the next set of operation list results if there are any.
804
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
805
- */
806
- readonly nextLink?: string;
807
- }
484
+ /** The description of the provisioning service. */
485
+ export type ProvisioningServiceDescription = Resource & {
486
+ /** 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. */
487
+ etag?: string;
488
+ /** Service specific properties for a provisioning service */
489
+ properties: IotDpsPropertiesDescription;
490
+ /** Sku info for a provisioning Service. */
491
+ sku: IotDpsSkuInfo;
492
+ };
808
493
 
809
- /**
810
- * @interface
811
- * List of provisioning service descriptions.
812
- * @extends Array<ProvisioningServiceDescription>
494
+ /** Known values of {@link CertificatePurpose} that the service accepts. */
495
+ export enum KnownCertificatePurpose {
496
+ ClientAuthentication = "clientAuthentication",
497
+ ServerAuthentication = "serverAuthentication"
498
+ }
499
+
500
+ /**
501
+ * Defines values for CertificatePurpose. \
502
+ * {@link KnownCertificatePurpose} can be used interchangeably with CertificatePurpose,
503
+ * this enum contains the known values that the service supports.
504
+ * ### Known values supported by the service
505
+ * **clientAuthentication** \
506
+ * **serverAuthentication**
507
+ */
508
+ export type CertificatePurpose = string;
509
+
510
+ /** Known values of {@link State} that the service accepts. */
511
+ export enum KnownState {
512
+ Activating = "Activating",
513
+ Active = "Active",
514
+ Deleting = "Deleting",
515
+ Deleted = "Deleted",
516
+ ActivationFailed = "ActivationFailed",
517
+ DeletionFailed = "DeletionFailed",
518
+ Transitioning = "Transitioning",
519
+ Suspending = "Suspending",
520
+ Suspended = "Suspended",
521
+ Resuming = "Resuming",
522
+ FailingOver = "FailingOver",
523
+ FailoverFailed = "FailoverFailed"
524
+ }
525
+
526
+ /**
527
+ * Defines values for State. \
528
+ * {@link KnownState} can be used interchangeably with State,
529
+ * this enum contains the known values that the service supports.
530
+ * ### Known values supported by the service
531
+ * **Activating** \
532
+ * **Active** \
533
+ * **Deleting** \
534
+ * **Deleted** \
535
+ * **ActivationFailed** \
536
+ * **DeletionFailed** \
537
+ * **Transitioning** \
538
+ * **Suspending** \
539
+ * **Suspended** \
540
+ * **Resuming** \
541
+ * **FailingOver** \
542
+ * **FailoverFailed**
813
543
  */
814
- export interface ProvisioningServiceDescriptionListResult extends Array<ProvisioningServiceDescription> {
815
- /**
816
- * the next link
817
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
818
- */
819
- readonly nextLink?: string;
544
+ export type State = string;
545
+
546
+ /** Known values of {@link PublicNetworkAccess} that the service accepts. */
547
+ export enum KnownPublicNetworkAccess {
548
+ Enabled = "Enabled",
549
+ Disabled = "Disabled"
820
550
  }
821
551
 
822
552
  /**
823
- * @interface
824
- * List of available SKUs.
825
- * @extends Array<IotDpsSkuDefinition>
553
+ * Defines values for PublicNetworkAccess. \
554
+ * {@link KnownPublicNetworkAccess} can be used interchangeably with PublicNetworkAccess,
555
+ * this enum contains the known values that the service supports.
556
+ * ### Known values supported by the service
557
+ * **Enabled** \
558
+ * **Disabled**
826
559
  */
827
- export interface IotDpsSkuDefinitionListResult extends Array<IotDpsSkuDefinition> {
828
- /**
829
- * The next link.
830
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
831
- */
832
- readonly nextLink?: string;
560
+ export type PublicNetworkAccess = string;
561
+
562
+ /** Known values of {@link PrivateLinkServiceConnectionStatus} that the service accepts. */
563
+ export enum KnownPrivateLinkServiceConnectionStatus {
564
+ Pending = "Pending",
565
+ Approved = "Approved",
566
+ Rejected = "Rejected",
567
+ Disconnected = "Disconnected"
833
568
  }
834
569
 
835
570
  /**
836
- * @interface
837
- * List of shared access keys.
838
- * @extends Array<SharedAccessSignatureAuthorizationRuleAccessRightsDescription>
571
+ * Defines values for PrivateLinkServiceConnectionStatus. \
572
+ * {@link KnownPrivateLinkServiceConnectionStatus} can be used interchangeably with PrivateLinkServiceConnectionStatus,
573
+ * this enum contains the known values that the service supports.
574
+ * ### Known values supported by the service
575
+ * **Pending** \
576
+ * **Approved** \
577
+ * **Rejected** \
578
+ * **Disconnected**
839
579
  */
840
- export interface SharedAccessSignatureAuthorizationRuleListResult extends Array<SharedAccessSignatureAuthorizationRuleAccessRightsDescription> {
841
- /**
842
- * The next link.
843
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
844
- */
845
- readonly nextLink?: string;
580
+ export type PrivateLinkServiceConnectionStatus = string;
581
+
582
+ /** Known values of {@link AllocationPolicy} that the service accepts. */
583
+ export enum KnownAllocationPolicy {
584
+ Hashed = "Hashed",
585
+ GeoLatency = "GeoLatency",
586
+ Static = "Static"
846
587
  }
847
588
 
848
589
  /**
849
- * Defines values for IotDpsSku.
850
- * Possible values include: 'S1'
851
- * @readonly
852
- * @enum {string}
590
+ * Defines values for AllocationPolicy. \
591
+ * {@link KnownAllocationPolicy} can be used interchangeably with AllocationPolicy,
592
+ * this enum contains the known values that the service supports.
593
+ * ### Known values supported by the service
594
+ * **Hashed** \
595
+ * **GeoLatency** \
596
+ * **Static**
853
597
  */
854
- export type IotDpsSku = 'S1';
855
-
856
- /**
857
- * Defines values for State.
858
- * Possible values include: 'Activating', 'Active', 'Deleting', 'Deleted', 'ActivationFailed',
859
- * 'DeletionFailed', 'Transitioning', 'Suspending', 'Suspended', 'Resuming', 'FailingOver',
860
- * 'FailoverFailed'
861
- * @readonly
862
- * @enum {string}
598
+ export type AllocationPolicy = string;
599
+
600
+ /** Known values of {@link AccessRightsDescription} that the service accepts. */
601
+ export enum KnownAccessRightsDescription {
602
+ ServiceConfig = "ServiceConfig",
603
+ EnrollmentRead = "EnrollmentRead",
604
+ EnrollmentWrite = "EnrollmentWrite",
605
+ DeviceConnect = "DeviceConnect",
606
+ RegistrationStatusRead = "RegistrationStatusRead",
607
+ RegistrationStatusWrite = "RegistrationStatusWrite"
608
+ }
609
+
610
+ /**
611
+ * Defines values for AccessRightsDescription. \
612
+ * {@link KnownAccessRightsDescription} can be used interchangeably with AccessRightsDescription,
613
+ * this enum contains the known values that the service supports.
614
+ * ### Known values supported by the service
615
+ * **ServiceConfig** \
616
+ * **EnrollmentRead** \
617
+ * **EnrollmentWrite** \
618
+ * **DeviceConnect** \
619
+ * **RegistrationStatusRead** \
620
+ * **RegistrationStatusWrite**
863
621
  */
864
- export type State = 'Activating' | 'Active' | 'Deleting' | 'Deleted' | 'ActivationFailed' | 'DeletionFailed' | 'Transitioning' | 'Suspending' | 'Suspended' | 'Resuming' | 'FailingOver' | 'FailoverFailed';
622
+ export type AccessRightsDescription = string;
623
+
624
+ /** Known values of {@link IotDpsSku} that the service accepts. */
625
+ export enum KnownIotDpsSku {
626
+ S1 = "S1"
627
+ }
865
628
 
866
629
  /**
867
- * Defines values for PublicNetworkAccess.
868
- * Possible values include: 'Enabled', 'Disabled'
869
- * @readonly
870
- * @enum {string}
630
+ * Defines values for IotDpsSku. \
631
+ * {@link KnownIotDpsSku} can be used interchangeably with IotDpsSku,
632
+ * this enum contains the known values that the service supports.
633
+ * ### Known values supported by the service
634
+ * **S1**
871
635
  */
872
- export type PublicNetworkAccess = 'Enabled' | 'Disabled';
636
+ export type IotDpsSku = string;
873
637
 
874
- /**
875
- * Defines values for IpFilterActionType.
876
- * Possible values include: 'Accept', 'Reject'
877
- * @readonly
878
- * @enum {string}
879
- */
880
- export type IpFilterActionType = 'Accept' | 'Reject';
638
+ /** Known values of {@link NameUnavailabilityReason} that the service accepts. */
639
+ export enum KnownNameUnavailabilityReason {
640
+ Invalid = "Invalid",
641
+ AlreadyExists = "AlreadyExists"
642
+ }
881
643
 
882
644
  /**
883
- * Defines values for IpFilterTargetType.
884
- * Possible values include: 'all', 'serviceApi', 'deviceApi'
885
- * @readonly
886
- * @enum {string}
645
+ * Defines values for NameUnavailabilityReason. \
646
+ * {@link KnownNameUnavailabilityReason} can be used interchangeably with NameUnavailabilityReason,
647
+ * this enum contains the known values that the service supports.
648
+ * ### Known values supported by the service
649
+ * **Invalid** \
650
+ * **AlreadyExists**
887
651
  */
888
- export type IpFilterTargetType = 'all' | 'serviceApi' | 'deviceApi';
652
+ export type NameUnavailabilityReason = string;
653
+ /** Defines values for IpFilterActionType. */
654
+ export type IpFilterActionType = "Accept" | "Reject";
655
+ /** Defines values for IpFilterTargetType. */
656
+ export type IpFilterTargetType = "all" | "serviceApi" | "deviceApi";
889
657
 
890
- /**
891
- * Defines values for PrivateLinkServiceConnectionStatus.
892
- * Possible values include: 'Pending', 'Approved', 'Rejected', 'Disconnected'
893
- * @readonly
894
- * @enum {string}
895
- */
896
- export type PrivateLinkServiceConnectionStatus = 'Pending' | 'Approved' | 'Rejected' | 'Disconnected';
658
+ /** Optional parameters. */
659
+ export interface OperationsListOptionalParams
660
+ extends coreClient.OperationOptions {}
897
661
 
898
- /**
899
- * Defines values for AllocationPolicy.
900
- * Possible values include: 'Hashed', 'GeoLatency', 'Static'
901
- * @readonly
902
- * @enum {string}
903
- */
904
- export type AllocationPolicy = 'Hashed' | 'GeoLatency' | 'Static';
662
+ /** Contains response data for the list operation. */
663
+ export type OperationsListResponse = OperationListResult;
905
664
 
906
- /**
907
- * Defines values for AccessRightsDescription.
908
- * Possible values include: 'ServiceConfig', 'EnrollmentRead', 'EnrollmentWrite', 'DeviceConnect',
909
- * 'RegistrationStatusRead', 'RegistrationStatusWrite'
910
- * @readonly
911
- * @enum {string}
912
- */
913
- export type AccessRightsDescription = 'ServiceConfig' | 'EnrollmentRead' | 'EnrollmentWrite' | 'DeviceConnect' | 'RegistrationStatusRead' | 'RegistrationStatusWrite';
665
+ /** Optional parameters. */
666
+ export interface OperationsListNextOptionalParams
667
+ extends coreClient.OperationOptions {}
914
668
 
915
- /**
916
- * Defines values for NameUnavailabilityReason.
917
- * Possible values include: 'Invalid', 'AlreadyExists'
918
- * @readonly
919
- * @enum {string}
920
- */
921
- export type NameUnavailabilityReason = 'Invalid' | 'AlreadyExists';
669
+ /** Contains response data for the listNext operation. */
670
+ export type OperationsListNextResponse = OperationListResult;
922
671
 
923
- /**
924
- * Defines values for CertificatePurpose.
925
- * Possible values include: 'clientAuthentication', 'serverAuthentication'
926
- * @readonly
927
- * @enum {string}
928
- */
929
- export type CertificatePurpose = 'clientAuthentication' | 'serverAuthentication';
672
+ /** Optional parameters. */
673
+ export interface DpsCertificateGetOptionalParams
674
+ extends coreClient.OperationOptions {
675
+ /** ETag of the certificate. */
676
+ ifMatch?: string;
677
+ }
930
678
 
931
- /**
932
- * Contains response data for the list operation.
933
- */
934
- export type OperationsListResponse = OperationListResult & {
935
- /**
936
- * The underlying HTTP response.
937
- */
938
- _response: msRest.HttpResponse & {
939
- /**
940
- * The response body as text (string format)
941
- */
942
- bodyAsText: string;
943
-
944
- /**
945
- * The response body as parsed JSON or XML
946
- */
947
- parsedBody: OperationListResult;
948
- };
949
- };
679
+ /** Contains response data for the get operation. */
680
+ export type DpsCertificateGetResponse = CertificateResponse;
950
681
 
951
- /**
952
- * Contains response data for the listNext operation.
953
- */
954
- export type OperationsListNextResponse = OperationListResult & {
955
- /**
956
- * The underlying HTTP response.
957
- */
958
- _response: msRest.HttpResponse & {
959
- /**
960
- * The response body as text (string format)
961
- */
962
- bodyAsText: string;
963
-
964
- /**
965
- * The response body as parsed JSON or XML
966
- */
967
- parsedBody: OperationListResult;
968
- };
969
- };
682
+ /** Optional parameters. */
683
+ export interface DpsCertificateCreateOrUpdateOptionalParams
684
+ extends coreClient.OperationOptions {
685
+ /** ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate. */
686
+ ifMatch?: string;
687
+ }
970
688
 
971
- /**
972
- * Contains response data for the get operation.
973
- */
974
- export type DpsCertificateGetResponse = CertificateResponse & {
975
- /**
976
- * The underlying HTTP response.
977
- */
978
- _response: msRest.HttpResponse & {
979
- /**
980
- * The response body as text (string format)
981
- */
982
- bodyAsText: string;
983
-
984
- /**
985
- * The response body as parsed JSON or XML
986
- */
987
- parsedBody: CertificateResponse;
988
- };
989
- };
689
+ /** Contains response data for the createOrUpdate operation. */
690
+ export type DpsCertificateCreateOrUpdateResponse = CertificateResponse;
691
+
692
+ /** Optional parameters. */
693
+ export interface DpsCertificateDeleteOptionalParams
694
+ extends coreClient.OperationOptions {
695
+ /** This is optional, and it is the Common Name of the certificate. */
696
+ certificateName1?: string;
697
+ /** Raw data within the certificate. */
698
+ certificateRawBytes?: Uint8Array;
699
+ /** Indicates if certificate has been verified by owner of the private key. */
700
+ certificateIsVerified?: boolean;
701
+ /** A description that mentions the purpose of the certificate. */
702
+ certificatePurpose?: CertificatePurpose;
703
+ /** Time the certificate is created. */
704
+ certificateCreated?: Date;
705
+ /** Time the certificate is last updated. */
706
+ certificateLastUpdated?: Date;
707
+ /** Indicates if the certificate contains a private key. */
708
+ certificateHasPrivateKey?: boolean;
709
+ /** Random number generated to indicate Proof of Possession. */
710
+ certificateNonce?: string;
711
+ }
712
+
713
+ /** Optional parameters. */
714
+ export interface DpsCertificateListOptionalParams
715
+ extends coreClient.OperationOptions {}
716
+
717
+ /** Contains response data for the list operation. */
718
+ export type DpsCertificateListResponse = CertificateListDescription;
719
+
720
+ /** Optional parameters. */
721
+ export interface DpsCertificateGenerateVerificationCodeOptionalParams
722
+ extends coreClient.OperationOptions {
723
+ /** Common Name for the certificate. */
724
+ certificateName1?: string;
725
+ /** Raw data of certificate. */
726
+ certificateRawBytes?: Uint8Array;
727
+ /** Indicates if the certificate has been verified by owner of the private key. */
728
+ certificateIsVerified?: boolean;
729
+ /** Description mentioning the purpose of the certificate. */
730
+ certificatePurpose?: CertificatePurpose;
731
+ /** Certificate creation time. */
732
+ certificateCreated?: Date;
733
+ /** Certificate last updated time. */
734
+ certificateLastUpdated?: Date;
735
+ /** Indicates if the certificate contains private key. */
736
+ certificateHasPrivateKey?: boolean;
737
+ /** Random number generated to indicate Proof of Possession. */
738
+ certificateNonce?: string;
739
+ }
740
+
741
+ /** Contains response data for the generateVerificationCode operation. */
742
+ export type DpsCertificateGenerateVerificationCodeResponse = VerificationCodeResponse;
743
+
744
+ /** Optional parameters. */
745
+ export interface DpsCertificateVerifyCertificateOptionalParams
746
+ extends coreClient.OperationOptions {
747
+ /** Common Name for the certificate. */
748
+ certificateName1?: string;
749
+ /** Raw data of certificate. */
750
+ certificateRawBytes?: Uint8Array;
751
+ /** Indicates if the certificate has been verified by owner of the private key. */
752
+ certificateIsVerified?: boolean;
753
+ /** Describe the purpose of the certificate. */
754
+ certificatePurpose?: CertificatePurpose;
755
+ /** Certificate creation time. */
756
+ certificateCreated?: Date;
757
+ /** Certificate last updated time. */
758
+ certificateLastUpdated?: Date;
759
+ /** Indicates if the certificate contains private key. */
760
+ certificateHasPrivateKey?: boolean;
761
+ /** Random number generated to indicate Proof of Possession. */
762
+ certificateNonce?: string;
763
+ }
764
+
765
+ /** Contains response data for the verifyCertificate operation. */
766
+ export type DpsCertificateVerifyCertificateResponse = CertificateResponse;
767
+
768
+ /** Optional parameters. */
769
+ export interface IotDpsResourceGetOptionalParams
770
+ extends coreClient.OperationOptions {}
771
+
772
+ /** Contains response data for the get operation. */
773
+ export type IotDpsResourceGetResponse = ProvisioningServiceDescription;
774
+
775
+ /** Optional parameters. */
776
+ export interface IotDpsResourceCreateOrUpdateOptionalParams
777
+ extends coreClient.OperationOptions {
778
+ /** Delay to wait until next poll, in milliseconds. */
779
+ updateIntervalInMs?: number;
780
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
781
+ resumeFrom?: string;
782
+ }
783
+
784
+ /** Contains response data for the createOrUpdate operation. */
785
+ export type IotDpsResourceCreateOrUpdateResponse = ProvisioningServiceDescription;
786
+
787
+ /** Optional parameters. */
788
+ export interface IotDpsResourceUpdateOptionalParams
789
+ extends coreClient.OperationOptions {
790
+ /** Delay to wait until next poll, in milliseconds. */
791
+ updateIntervalInMs?: number;
792
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
793
+ resumeFrom?: string;
794
+ }
795
+
796
+ /** Contains response data for the update operation. */
797
+ export type IotDpsResourceUpdateResponse = ProvisioningServiceDescription;
798
+
799
+ /** Optional parameters. */
800
+ export interface IotDpsResourceDeleteOptionalParams
801
+ extends coreClient.OperationOptions {
802
+ /** Delay to wait until next poll, in milliseconds. */
803
+ updateIntervalInMs?: number;
804
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
805
+ resumeFrom?: string;
806
+ }
807
+
808
+ /** Optional parameters. */
809
+ export interface IotDpsResourceListBySubscriptionOptionalParams
810
+ extends coreClient.OperationOptions {}
811
+
812
+ /** Contains response data for the listBySubscription operation. */
813
+ export type IotDpsResourceListBySubscriptionResponse = ProvisioningServiceDescriptionListResult;
814
+
815
+ /** Optional parameters. */
816
+ export interface IotDpsResourceListByResourceGroupOptionalParams
817
+ extends coreClient.OperationOptions {}
818
+
819
+ /** Contains response data for the listByResourceGroup operation. */
820
+ export type IotDpsResourceListByResourceGroupResponse = ProvisioningServiceDescriptionListResult;
821
+
822
+ /** Optional parameters. */
823
+ export interface IotDpsResourceGetOperationResultOptionalParams
824
+ extends coreClient.OperationOptions {}
825
+
826
+ /** Contains response data for the getOperationResult operation. */
827
+ export type IotDpsResourceGetOperationResultResponse = AsyncOperationResult;
828
+
829
+ /** Optional parameters. */
830
+ export interface IotDpsResourceListValidSkusOptionalParams
831
+ extends coreClient.OperationOptions {}
990
832
 
991
- /**
992
- * Contains response data for the createOrUpdate operation.
993
- */
994
- export type DpsCertificateCreateOrUpdateResponse = CertificateResponse & {
995
- /**
996
- * The underlying HTTP response.
997
- */
998
- _response: msRest.HttpResponse & {
999
- /**
1000
- * The response body as text (string format)
1001
- */
1002
- bodyAsText: string;
1003
-
1004
- /**
1005
- * The response body as parsed JSON or XML
1006
- */
1007
- parsedBody: CertificateResponse;
1008
- };
1009
- };
833
+ /** Contains response data for the listValidSkus operation. */
834
+ export type IotDpsResourceListValidSkusResponse = IotDpsSkuDefinitionListResult;
1010
835
 
1011
- /**
1012
- * Contains response data for the list operation.
1013
- */
1014
- export type DpsCertificateListResponse = CertificateListDescription & {
1015
- /**
1016
- * The underlying HTTP response.
1017
- */
1018
- _response: msRest.HttpResponse & {
1019
- /**
1020
- * The response body as text (string format)
1021
- */
1022
- bodyAsText: string;
1023
-
1024
- /**
1025
- * The response body as parsed JSON or XML
1026
- */
1027
- parsedBody: CertificateListDescription;
1028
- };
1029
- };
836
+ /** Optional parameters. */
837
+ export interface IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams
838
+ extends coreClient.OperationOptions {}
1030
839
 
1031
- /**
1032
- * Contains response data for the generateVerificationCode operation.
1033
- */
1034
- export type DpsCertificateGenerateVerificationCodeResponse = VerificationCodeResponse & {
1035
- /**
1036
- * The underlying HTTP response.
1037
- */
1038
- _response: msRest.HttpResponse & {
1039
- /**
1040
- * The response body as text (string format)
1041
- */
1042
- bodyAsText: string;
1043
-
1044
- /**
1045
- * The response body as parsed JSON or XML
1046
- */
1047
- parsedBody: VerificationCodeResponse;
1048
- };
1049
- };
840
+ /** Contains response data for the checkProvisioningServiceNameAvailability operation. */
841
+ export type IotDpsResourceCheckProvisioningServiceNameAvailabilityResponse = NameAvailabilityInfo;
1050
842
 
1051
- /**
1052
- * Contains response data for the verifyCertificate operation.
1053
- */
1054
- export type DpsCertificateVerifyCertificateResponse = CertificateResponse & {
1055
- /**
1056
- * The underlying HTTP response.
1057
- */
1058
- _response: msRest.HttpResponse & {
1059
- /**
1060
- * The response body as text (string format)
1061
- */
1062
- bodyAsText: string;
1063
-
1064
- /**
1065
- * The response body as parsed JSON or XML
1066
- */
1067
- parsedBody: CertificateResponse;
1068
- };
1069
- };
843
+ /** Optional parameters. */
844
+ export interface IotDpsResourceListKeysOptionalParams
845
+ extends coreClient.OperationOptions {}
1070
846
 
1071
- /**
1072
- * Contains response data for the get operation.
1073
- */
1074
- export type IotDpsResourceGetResponse = ProvisioningServiceDescription & {
1075
- /**
1076
- * The underlying HTTP response.
1077
- */
1078
- _response: msRest.HttpResponse & {
1079
- /**
1080
- * The response body as text (string format)
1081
- */
1082
- bodyAsText: string;
1083
-
1084
- /**
1085
- * The response body as parsed JSON or XML
1086
- */
1087
- parsedBody: ProvisioningServiceDescription;
1088
- };
1089
- };
847
+ /** Contains response data for the listKeys operation. */
848
+ export type IotDpsResourceListKeysResponse = SharedAccessSignatureAuthorizationRuleListResult;
1090
849
 
1091
- /**
1092
- * Contains response data for the createOrUpdate operation.
1093
- */
1094
- export type IotDpsResourceCreateOrUpdateResponse = ProvisioningServiceDescription & {
1095
- /**
1096
- * The underlying HTTP response.
1097
- */
1098
- _response: msRest.HttpResponse & {
1099
- /**
1100
- * The response body as text (string format)
1101
- */
1102
- bodyAsText: string;
1103
-
1104
- /**
1105
- * The response body as parsed JSON or XML
1106
- */
1107
- parsedBody: ProvisioningServiceDescription;
1108
- };
1109
- };
850
+ /** Optional parameters. */
851
+ export interface IotDpsResourceListKeysForKeyNameOptionalParams
852
+ extends coreClient.OperationOptions {}
1110
853
 
1111
- /**
1112
- * Contains response data for the update operation.
1113
- */
1114
- export type IotDpsResourceUpdateResponse = ProvisioningServiceDescription & {
1115
- /**
1116
- * The underlying HTTP response.
1117
- */
1118
- _response: msRest.HttpResponse & {
1119
- /**
1120
- * The response body as text (string format)
1121
- */
1122
- bodyAsText: string;
1123
-
1124
- /**
1125
- * The response body as parsed JSON or XML
1126
- */
1127
- parsedBody: ProvisioningServiceDescription;
1128
- };
1129
- };
854
+ /** Contains response data for the listKeysForKeyName operation. */
855
+ export type IotDpsResourceListKeysForKeyNameResponse = SharedAccessSignatureAuthorizationRuleAccessRightsDescription;
1130
856
 
1131
- /**
1132
- * Contains response data for the listBySubscription operation.
1133
- */
1134
- export type IotDpsResourceListBySubscriptionResponse = ProvisioningServiceDescriptionListResult & {
1135
- /**
1136
- * The underlying HTTP response.
1137
- */
1138
- _response: msRest.HttpResponse & {
1139
- /**
1140
- * The response body as text (string format)
1141
- */
1142
- bodyAsText: string;
1143
-
1144
- /**
1145
- * The response body as parsed JSON or XML
1146
- */
1147
- parsedBody: ProvisioningServiceDescriptionListResult;
1148
- };
1149
- };
857
+ /** Optional parameters. */
858
+ export interface IotDpsResourceListPrivateLinkResourcesOptionalParams
859
+ extends coreClient.OperationOptions {}
1150
860
 
1151
- /**
1152
- * Contains response data for the listByResourceGroup operation.
1153
- */
1154
- export type IotDpsResourceListByResourceGroupResponse = ProvisioningServiceDescriptionListResult & {
1155
- /**
1156
- * The underlying HTTP response.
1157
- */
1158
- _response: msRest.HttpResponse & {
1159
- /**
1160
- * The response body as text (string format)
1161
- */
1162
- bodyAsText: string;
1163
-
1164
- /**
1165
- * The response body as parsed JSON or XML
1166
- */
1167
- parsedBody: ProvisioningServiceDescriptionListResult;
1168
- };
1169
- };
861
+ /** Contains response data for the listPrivateLinkResources operation. */
862
+ export type IotDpsResourceListPrivateLinkResourcesResponse = PrivateLinkResources;
1170
863
 
1171
- /**
1172
- * Contains response data for the getOperationResult operation.
1173
- */
1174
- export type IotDpsResourceGetOperationResultResponse = AsyncOperationResult & {
1175
- /**
1176
- * The underlying HTTP response.
1177
- */
1178
- _response: msRest.HttpResponse & {
1179
- /**
1180
- * The response body as text (string format)
1181
- */
1182
- bodyAsText: string;
1183
-
1184
- /**
1185
- * The response body as parsed JSON or XML
1186
- */
1187
- parsedBody: AsyncOperationResult;
1188
- };
1189
- };
864
+ /** Optional parameters. */
865
+ export interface IotDpsResourceGetPrivateLinkResourcesOptionalParams
866
+ extends coreClient.OperationOptions {}
1190
867
 
1191
- /**
1192
- * Contains response data for the listValidSkus operation.
1193
- */
1194
- export type IotDpsResourceListValidSkusResponse = IotDpsSkuDefinitionListResult & {
1195
- /**
1196
- * The underlying HTTP response.
1197
- */
1198
- _response: msRest.HttpResponse & {
1199
- /**
1200
- * The response body as text (string format)
1201
- */
1202
- bodyAsText: string;
1203
-
1204
- /**
1205
- * The response body as parsed JSON or XML
1206
- */
1207
- parsedBody: IotDpsSkuDefinitionListResult;
1208
- };
1209
- };
868
+ /** Contains response data for the getPrivateLinkResources operation. */
869
+ export type IotDpsResourceGetPrivateLinkResourcesResponse = GroupIdInformation;
1210
870
 
1211
- /**
1212
- * Contains response data for the checkProvisioningServiceNameAvailability operation.
1213
- */
1214
- export type IotDpsResourceCheckProvisioningServiceNameAvailabilityResponse = NameAvailabilityInfo & {
1215
- /**
1216
- * The underlying HTTP response.
1217
- */
1218
- _response: msRest.HttpResponse & {
1219
- /**
1220
- * The response body as text (string format)
1221
- */
1222
- bodyAsText: string;
1223
-
1224
- /**
1225
- * The response body as parsed JSON or XML
1226
- */
1227
- parsedBody: NameAvailabilityInfo;
1228
- };
1229
- };
871
+ /** Optional parameters. */
872
+ export interface IotDpsResourceListPrivateEndpointConnectionsOptionalParams
873
+ extends coreClient.OperationOptions {}
1230
874
 
1231
- /**
1232
- * Contains response data for the listKeys operation.
1233
- */
1234
- export type IotDpsResourceListKeysResponse = SharedAccessSignatureAuthorizationRuleListResult & {
1235
- /**
1236
- * The underlying HTTP response.
1237
- */
1238
- _response: msRest.HttpResponse & {
1239
- /**
1240
- * The response body as text (string format)
1241
- */
1242
- bodyAsText: string;
1243
-
1244
- /**
1245
- * The response body as parsed JSON or XML
1246
- */
1247
- parsedBody: SharedAccessSignatureAuthorizationRuleListResult;
1248
- };
1249
- };
875
+ /** Contains response data for the listPrivateEndpointConnections operation. */
876
+ export type IotDpsResourceListPrivateEndpointConnectionsResponse = PrivateEndpointConnection[];
1250
877
 
1251
- /**
1252
- * Contains response data for the listKeysForKeyName operation.
1253
- */
1254
- export type IotDpsResourceListKeysForKeyNameResponse = SharedAccessSignatureAuthorizationRuleAccessRightsDescription & {
1255
- /**
1256
- * The underlying HTTP response.
1257
- */
1258
- _response: msRest.HttpResponse & {
1259
- /**
1260
- * The response body as text (string format)
1261
- */
1262
- bodyAsText: string;
1263
-
1264
- /**
1265
- * The response body as parsed JSON or XML
1266
- */
1267
- parsedBody: SharedAccessSignatureAuthorizationRuleAccessRightsDescription;
1268
- };
1269
- };
878
+ /** Optional parameters. */
879
+ export interface IotDpsResourceGetPrivateEndpointConnectionOptionalParams
880
+ extends coreClient.OperationOptions {}
1270
881
 
1271
- /**
1272
- * Contains response data for the listPrivateLinkResources operation.
1273
- */
1274
- export type IotDpsResourceListPrivateLinkResourcesResponse = PrivateLinkResources & {
1275
- /**
1276
- * The underlying HTTP response.
1277
- */
1278
- _response: msRest.HttpResponse & {
1279
- /**
1280
- * The response body as text (string format)
1281
- */
1282
- bodyAsText: string;
1283
-
1284
- /**
1285
- * The response body as parsed JSON or XML
1286
- */
1287
- parsedBody: PrivateLinkResources;
1288
- };
1289
- };
882
+ /** Contains response data for the getPrivateEndpointConnection operation. */
883
+ export type IotDpsResourceGetPrivateEndpointConnectionResponse = PrivateEndpointConnection;
1290
884
 
1291
- /**
1292
- * Contains response data for the getPrivateLinkResources operation.
1293
- */
1294
- export type IotDpsResourceGetPrivateLinkResourcesResponse = GroupIdInformation & {
1295
- /**
1296
- * The underlying HTTP response.
1297
- */
1298
- _response: msRest.HttpResponse & {
1299
- /**
1300
- * The response body as text (string format)
1301
- */
1302
- bodyAsText: string;
1303
-
1304
- /**
1305
- * The response body as parsed JSON or XML
1306
- */
1307
- parsedBody: GroupIdInformation;
1308
- };
1309
- };
885
+ /** Optional parameters. */
886
+ export interface IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams
887
+ extends coreClient.OperationOptions {
888
+ /** Delay to wait until next poll, in milliseconds. */
889
+ updateIntervalInMs?: number;
890
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
891
+ resumeFrom?: string;
892
+ }
1310
893
 
1311
- /**
1312
- * Contains response data for the listPrivateEndpointConnections operation.
1313
- */
1314
- export type IotDpsResourceListPrivateEndpointConnectionsResponse = Array<PrivateEndpointConnection> & {
1315
- /**
1316
- * The underlying HTTP response.
1317
- */
1318
- _response: msRest.HttpResponse & {
1319
- /**
1320
- * The response body as text (string format)
1321
- */
1322
- bodyAsText: string;
1323
-
1324
- /**
1325
- * The response body as parsed JSON or XML
1326
- */
1327
- parsedBody: PrivateEndpointConnection[];
1328
- };
1329
- };
894
+ /** Contains response data for the createOrUpdatePrivateEndpointConnection operation. */
895
+ export type IotDpsResourceCreateOrUpdatePrivateEndpointConnectionResponse = PrivateEndpointConnection;
1330
896
 
1331
- /**
1332
- * Contains response data for the getPrivateEndpointConnection operation.
1333
- */
1334
- export type IotDpsResourceGetPrivateEndpointConnectionResponse = PrivateEndpointConnection & {
1335
- /**
1336
- * The underlying HTTP response.
1337
- */
1338
- _response: msRest.HttpResponse & {
1339
- /**
1340
- * The response body as text (string format)
1341
- */
1342
- bodyAsText: string;
1343
-
1344
- /**
1345
- * The response body as parsed JSON or XML
1346
- */
1347
- parsedBody: PrivateEndpointConnection;
1348
- };
1349
- };
897
+ /** Optional parameters. */
898
+ export interface IotDpsResourceDeletePrivateEndpointConnectionOptionalParams
899
+ extends coreClient.OperationOptions {
900
+ /** Delay to wait until next poll, in milliseconds. */
901
+ updateIntervalInMs?: number;
902
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
903
+ resumeFrom?: string;
904
+ }
1350
905
 
1351
- /**
1352
- * Contains response data for the createOrUpdatePrivateEndpointConnection operation.
1353
- */
1354
- export type IotDpsResourceCreateOrUpdatePrivateEndpointConnectionResponse = PrivateEndpointConnection & {
1355
- /**
1356
- * The underlying HTTP response.
1357
- */
1358
- _response: msRest.HttpResponse & {
1359
- /**
1360
- * The response body as text (string format)
1361
- */
1362
- bodyAsText: string;
1363
-
1364
- /**
1365
- * The response body as parsed JSON or XML
1366
- */
1367
- parsedBody: PrivateEndpointConnection;
1368
- };
1369
- };
906
+ /** Contains response data for the deletePrivateEndpointConnection operation. */
907
+ export type IotDpsResourceDeletePrivateEndpointConnectionResponse = PrivateEndpointConnection;
1370
908
 
1371
- /**
1372
- * Contains response data for the deletePrivateEndpointConnection operation.
1373
- */
1374
- export type IotDpsResourceDeletePrivateEndpointConnectionResponse = PrivateEndpointConnection & {
1375
- /**
1376
- * The underlying HTTP response.
1377
- */
1378
- _response: msRest.HttpResponse & {
1379
- /**
1380
- * The response body as text (string format)
1381
- */
1382
- bodyAsText: string;
1383
-
1384
- /**
1385
- * The response body as parsed JSON or XML
1386
- */
1387
- parsedBody: PrivateEndpointConnection;
1388
- };
1389
- };
909
+ /** Optional parameters. */
910
+ export interface IotDpsResourceListBySubscriptionNextOptionalParams
911
+ extends coreClient.OperationOptions {}
1390
912
 
1391
- /**
1392
- * Contains response data for the beginCreateOrUpdate operation.
1393
- */
1394
- export type IotDpsResourceBeginCreateOrUpdateResponse = ProvisioningServiceDescription & {
1395
- /**
1396
- * The underlying HTTP response.
1397
- */
1398
- _response: msRest.HttpResponse & {
1399
- /**
1400
- * The response body as text (string format)
1401
- */
1402
- bodyAsText: string;
1403
-
1404
- /**
1405
- * The response body as parsed JSON or XML
1406
- */
1407
- parsedBody: ProvisioningServiceDescription;
1408
- };
1409
- };
913
+ /** Contains response data for the listBySubscriptionNext operation. */
914
+ export type IotDpsResourceListBySubscriptionNextResponse = ProvisioningServiceDescriptionListResult;
1410
915
 
1411
- /**
1412
- * Contains response data for the beginUpdate operation.
1413
- */
1414
- export type IotDpsResourceBeginUpdateResponse = ProvisioningServiceDescription & {
1415
- /**
1416
- * The underlying HTTP response.
1417
- */
1418
- _response: msRest.HttpResponse & {
1419
- /**
1420
- * The response body as text (string format)
1421
- */
1422
- bodyAsText: string;
1423
-
1424
- /**
1425
- * The response body as parsed JSON or XML
1426
- */
1427
- parsedBody: ProvisioningServiceDescription;
1428
- };
1429
- };
916
+ /** Optional parameters. */
917
+ export interface IotDpsResourceListByResourceGroupNextOptionalParams
918
+ extends coreClient.OperationOptions {}
1430
919
 
1431
- /**
1432
- * Contains response data for the beginCreateOrUpdatePrivateEndpointConnection operation.
1433
- */
1434
- export type IotDpsResourceBeginCreateOrUpdatePrivateEndpointConnectionResponse = PrivateEndpointConnection & {
1435
- /**
1436
- * The underlying HTTP response.
1437
- */
1438
- _response: msRest.HttpResponse & {
1439
- /**
1440
- * The response body as text (string format)
1441
- */
1442
- bodyAsText: string;
1443
-
1444
- /**
1445
- * The response body as parsed JSON or XML
1446
- */
1447
- parsedBody: PrivateEndpointConnection;
1448
- };
1449
- };
920
+ /** Contains response data for the listByResourceGroupNext operation. */
921
+ export type IotDpsResourceListByResourceGroupNextResponse = ProvisioningServiceDescriptionListResult;
1450
922
 
1451
- /**
1452
- * Contains response data for the beginDeletePrivateEndpointConnection operation.
1453
- */
1454
- export type IotDpsResourceBeginDeletePrivateEndpointConnectionResponse = PrivateEndpointConnection & {
1455
- /**
1456
- * The underlying HTTP response.
1457
- */
1458
- _response: msRest.HttpResponse & {
1459
- /**
1460
- * The response body as text (string format)
1461
- */
1462
- bodyAsText: string;
1463
-
1464
- /**
1465
- * The response body as parsed JSON or XML
1466
- */
1467
- parsedBody: PrivateEndpointConnection;
1468
- };
1469
- };
923
+ /** Optional parameters. */
924
+ export interface IotDpsResourceListValidSkusNextOptionalParams
925
+ extends coreClient.OperationOptions {}
1470
926
 
1471
- /**
1472
- * Contains response data for the listBySubscriptionNext operation.
1473
- */
1474
- export type IotDpsResourceListBySubscriptionNextResponse = ProvisioningServiceDescriptionListResult & {
1475
- /**
1476
- * The underlying HTTP response.
1477
- */
1478
- _response: msRest.HttpResponse & {
1479
- /**
1480
- * The response body as text (string format)
1481
- */
1482
- bodyAsText: string;
1483
-
1484
- /**
1485
- * The response body as parsed JSON or XML
1486
- */
1487
- parsedBody: ProvisioningServiceDescriptionListResult;
1488
- };
1489
- };
927
+ /** Contains response data for the listValidSkusNext operation. */
928
+ export type IotDpsResourceListValidSkusNextResponse = IotDpsSkuDefinitionListResult;
1490
929
 
1491
- /**
1492
- * Contains response data for the listByResourceGroupNext operation.
1493
- */
1494
- export type IotDpsResourceListByResourceGroupNextResponse = ProvisioningServiceDescriptionListResult & {
1495
- /**
1496
- * The underlying HTTP response.
1497
- */
1498
- _response: msRest.HttpResponse & {
1499
- /**
1500
- * The response body as text (string format)
1501
- */
1502
- bodyAsText: string;
1503
-
1504
- /**
1505
- * The response body as parsed JSON or XML
1506
- */
1507
- parsedBody: ProvisioningServiceDescriptionListResult;
1508
- };
1509
- };
930
+ /** Optional parameters. */
931
+ export interface IotDpsResourceListKeysNextOptionalParams
932
+ extends coreClient.OperationOptions {}
1510
933
 
1511
- /**
1512
- * Contains response data for the listValidSkusNext operation.
1513
- */
1514
- export type IotDpsResourceListValidSkusNextResponse = IotDpsSkuDefinitionListResult & {
1515
- /**
1516
- * The underlying HTTP response.
1517
- */
1518
- _response: msRest.HttpResponse & {
1519
- /**
1520
- * The response body as text (string format)
1521
- */
1522
- bodyAsText: string;
1523
-
1524
- /**
1525
- * The response body as parsed JSON or XML
1526
- */
1527
- parsedBody: IotDpsSkuDefinitionListResult;
1528
- };
1529
- };
934
+ /** Contains response data for the listKeysNext operation. */
935
+ export type IotDpsResourceListKeysNextResponse = SharedAccessSignatureAuthorizationRuleListResult;
1530
936
 
1531
- /**
1532
- * Contains response data for the listKeysNext operation.
1533
- */
1534
- export type IotDpsResourceListKeysNextResponse = SharedAccessSignatureAuthorizationRuleListResult & {
1535
- /**
1536
- * The underlying HTTP response.
1537
- */
1538
- _response: msRest.HttpResponse & {
1539
- /**
1540
- * The response body as text (string format)
1541
- */
1542
- bodyAsText: string;
1543
-
1544
- /**
1545
- * The response body as parsed JSON or XML
1546
- */
1547
- parsedBody: SharedAccessSignatureAuthorizationRuleListResult;
1548
- };
1549
- };
937
+ /** Optional parameters. */
938
+ export interface IotDpsClientOptionalParams
939
+ extends coreClient.ServiceClientOptions {
940
+ /** server parameter */
941
+ $host?: string;
942
+ /** Api Version */
943
+ apiVersion?: string;
944
+ /** Overrides client endpoint. */
945
+ endpoint?: string;
946
+ }