@azure/arm-deviceprovisioningservices 3.0.0 → 4.1.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 +24 -0
  2. package/LICENSE +21 -0
  3. package/LICENSE.txt +1 -1
  4. package/README.md +70 -78
  5. package/dist/index.js +3185 -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 +878 -0
  22. package/dist-esm/src/models/index.d.ts.map +1 -0
  23. package/dist-esm/src/models/index.js +80 -0
  24. package/dist-esm/src/models/index.js.map +1 -0
  25. package/dist-esm/src/models/mappers.d.ts +37 -0
  26. package/dist-esm/src/models/mappers.d.ts.map +1 -0
  27. package/{esm → dist-esm/src}/models/mappers.js +508 -496
  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 +83 -24
  70. package/review/arm-deviceprovisioningservices.api.md +719 -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 +741 -1288
  76. package/src/models/mappers.ts +515 -499
  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 +20 -7
  87. package/types/arm-deviceprovisioningservices.d.ts +1261 -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,997 @@
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
- }
116
-
117
- /**
118
- * The JSON-serialized array of Certificate objects.
119
- */
120
- export interface CertificateListDescription {
121
103
  /**
122
- * The array of Certificate objects.
104
+ * Metadata pertaining to creation and last modification of the resource.
105
+ * NOTE: This property will not be serialized. It can only be populated by the server.
123
106
  */
124
- value?: CertificateResponse[];
107
+ readonly systemData?: SystemData;
125
108
  }
126
109
 
127
- /**
128
- * The JSON-serialized X509 Certificate.
129
- */
130
- export interface CertificateBodyDescription {
110
+ /** The description of an X509 CA Certificate. */
111
+ export interface CertificateProperties {
131
112
  /**
132
- * Base-64 representation of the X509 leaf certificate .cer file or just .pem file content.
113
+ * The certificate's subject name.
114
+ * NOTE: This property will not be serialized. It can only be populated by the server.
133
115
  */
134
- certificate?: string;
116
+ readonly subject?: string;
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 expiration date and time.
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 expiry?: Date;
146
122
  /**
147
- * Sku name. Possible values include: 'S1'
123
+ * The certificate's thumbprint.
124
+ * NOTE: This property will not be serialized. It can only be populated by the server.
148
125
  */
149
- name?: IotDpsSku;
126
+ readonly thumbprint?: string;
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
+ * Determines whether certificate has been verified.
129
+ * NOTE: This property will not be serialized. It can only be populated by the server.
153
130
  */
154
- readonly tier?: string;
131
+ readonly isVerified?: boolean;
155
132
  /**
156
- * The number of units to provision
133
+ * base-64 representation of X509 certificate .cer file or just .pem file content.
134
+ * NOTE: This property will not be serialized. It can only be populated by the server.
157
135
  */
158
- capacity?: number;
136
+ readonly certificate?: Uint8Array;
137
+ /**
138
+ * The certificate's creation date and time.
139
+ * NOTE: This property will not be serialized. It can only be populated by the server.
140
+ */
141
+ readonly created?: Date;
142
+ /**
143
+ * The certificate's last update date and time.
144
+ * NOTE: This property will not be serialized. It can only be populated by the server.
145
+ */
146
+ readonly updated?: Date;
159
147
  }
160
148
 
161
- /**
162
- * The IP filter rules for a provisioning Service.
163
- */
164
- export interface IpFilterRule {
149
+ /** Metadata pertaining to creation and last modification of the resource. */
150
+ export interface SystemData {
151
+ /** The identity that created the resource. */
152
+ createdBy?: string;
153
+ /** The type of identity that created the resource. */
154
+ createdByType?: CreatedByType;
155
+ /** The timestamp of resource creation (UTC). */
156
+ createdAt?: Date;
157
+ /** The identity that last modified the resource. */
158
+ lastModifiedBy?: string;
159
+ /** The type of identity that last modified the resource. */
160
+ lastModifiedByType?: CreatedByType;
161
+ /** The timestamp of resource last modification (UTC) */
162
+ lastModifiedAt?: Date;
163
+ }
164
+
165
+ /** The JSON-serialized X509 Certificate. */
166
+ export interface CertificateBodyDescription {
167
+ /** Base-64 representation of the X509 leaf certificate .cer file or just .pem file content. */
168
+ certificate?: string;
169
+ /** True indicates that the certificate will be created in verified state and proof of possession will not be required. */
170
+ isVerified?: boolean;
171
+ }
172
+
173
+ /** the service specific properties of a provisioning service, including keys, linked iot hubs, current state, and system generated properties such as hostname and idScope */
174
+ export interface IotDpsPropertiesDescription {
175
+ /** Current state of the provisioning service. */
176
+ state?: State;
177
+ /** Whether requests from Public Network are allowed */
178
+ publicNetworkAccess?: PublicNetworkAccess;
179
+ /** The IP filter rules. */
180
+ ipFilterRules?: IpFilterRule[];
181
+ /** Private endpoint connections created on this IotHub */
182
+ privateEndpointConnections?: PrivateEndpointConnection[];
183
+ /** The ARM provisioning state of the provisioning service. */
184
+ provisioningState?: string;
185
+ /** List of IoT hubs associated with this provisioning service. */
186
+ iotHubs?: IotHubDefinitionDescription[];
187
+ /** Allocation policy to be used by this provisioning service. */
188
+ allocationPolicy?: AllocationPolicy;
165
189
  /**
166
- * The name of the IP filter rule.
190
+ * Service endpoint for provisioning service.
191
+ * NOTE: This property will not be serialized. It can only be populated by the server.
167
192
  */
168
- filterName: string;
193
+ readonly serviceOperationsHostName?: string;
169
194
  /**
170
- * The desired action for requests captured by this rule. Possible values include: 'Accept',
171
- * 'Reject'
195
+ * Device endpoint for this provisioning service.
196
+ * NOTE: This property will not be serialized. It can only be populated by the server.
172
197
  */
173
- action: IpFilterActionType;
198
+ readonly deviceProvisioningHostName?: string;
174
199
  /**
175
- * A string that contains the IP address range in CIDR notation for the rule.
200
+ * Unique identifier of this provisioning service.
201
+ * NOTE: This property will not be serialized. It can only be populated by the server.
176
202
  */
177
- ipMask: string;
203
+ readonly idScope?: string;
204
+ /** List of authorization keys for a provisioning service. */
205
+ authorizationPolicies?: SharedAccessSignatureAuthorizationRuleAccessRightsDescription[];
178
206
  /**
179
- * Target for requests captured by this rule. Possible values include: 'all', 'serviceApi',
180
- * 'deviceApi'
207
+ * Optional.
208
+ * Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery.
181
209
  */
210
+ enableDataResidency?: boolean;
211
+ }
212
+
213
+ /** The IP filter rules for a provisioning Service. */
214
+ export interface IpFilterRule {
215
+ /** The name of the IP filter rule. */
216
+ filterName: string;
217
+ /** The desired action for requests captured by this rule. */
218
+ action: IpFilterActionType;
219
+ /** A string that contains the IP address range in CIDR notation for the rule. */
220
+ ipMask: string;
221
+ /** Target for requests captured by this rule. */
182
222
  target?: IpFilterTargetType;
183
223
  }
184
224
 
185
- /**
186
- * The private endpoint property of a private endpoint connection
187
- */
188
- export interface PrivateEndpoint {
225
+ /** The private endpoint connection of a provisioning service */
226
+ export interface PrivateEndpointConnection {
189
227
  /**
190
228
  * The resource identifier.
191
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
229
+ * NOTE: This property will not be serialized. It can only be populated by the server.
192
230
  */
193
231
  readonly id?: string;
194
- }
195
-
196
- /**
197
- * The current state of a private endpoint connection
198
- */
199
- export interface PrivateLinkServiceConnectionState {
200
232
  /**
201
- * The status of a private endpoint connection. Possible values include: 'Pending', 'Approved',
202
- * 'Rejected', 'Disconnected'
233
+ * The resource name.
234
+ * NOTE: This property will not be serialized. It can only be populated by the server.
203
235
  */
204
- status: PrivateLinkServiceConnectionStatus;
236
+ readonly name?: string;
205
237
  /**
206
- * The description for the current state of a private endpoint connection
238
+ * The resource type.
239
+ * NOTE: This property will not be serialized. It can only be populated by the server.
207
240
  */
208
- description: string;
241
+ readonly type?: string;
242
+ /** The properties of a private endpoint connection */
243
+ properties: PrivateEndpointConnectionProperties;
209
244
  /**
210
- * Actions required for a private endpoint connection
245
+ * Metadata pertaining to creation and last modification of the resource.
246
+ * NOTE: This property will not be serialized. It can only be populated by the server.
211
247
  */
212
- actionsRequired?: string;
248
+ readonly systemData?: SystemData;
213
249
  }
214
250
 
215
- /**
216
- * The properties of a private endpoint connection
217
- */
251
+ /** The properties of a private endpoint connection */
218
252
  export interface PrivateEndpointConnectionProperties {
219
- /**
220
- * The private endpoint property of a private endpoint connection
221
- */
253
+ /** The private endpoint property of a private endpoint connection */
222
254
  privateEndpoint?: PrivateEndpoint;
223
- /**
224
- * The current state of a private endpoint connection
225
- */
255
+ /** The current state of a private endpoint connection */
226
256
  privateLinkServiceConnectionState: PrivateLinkServiceConnectionState;
227
257
  }
228
258
 
229
- /**
230
- * The private endpoint connection of a provisioning service
231
- */
232
- export interface PrivateEndpointConnection extends BaseResource {
259
+ /** The private endpoint property of a private endpoint connection */
260
+ export interface PrivateEndpoint {
233
261
  /**
234
262
  * The resource identifier.
235
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
263
+ * NOTE: This property will not be serialized. It can only be populated by the server.
236
264
  */
237
265
  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
266
  }
253
267
 
254
- /**
255
- * Description of the IoT hub.
256
- */
268
+ /** The current state of a private endpoint connection */
269
+ export interface PrivateLinkServiceConnectionState {
270
+ /** The status of a private endpoint connection */
271
+ status: PrivateLinkServiceConnectionStatus;
272
+ /** The description for the current state of a private endpoint connection */
273
+ description: string;
274
+ /** Actions required for a private endpoint connection */
275
+ actionsRequired?: string;
276
+ }
277
+
278
+ /** Description of the IoT hub. */
257
279
  export interface IotHubDefinitionDescription {
258
- /**
259
- * flag for applying allocationPolicy or not for a given iot hub.
260
- */
280
+ /** flag for applying allocationPolicy or not for a given iot hub. */
261
281
  applyAllocationPolicy?: boolean;
262
- /**
263
- * weight to apply for a given iot h.
264
- */
282
+ /** weight to apply for a given iot h. */
265
283
  allocationWeight?: number;
266
284
  /**
267
285
  * Host name of the IoT hub.
268
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
286
+ * NOTE: This property will not be serialized. It can only be populated by the server.
269
287
  */
270
288
  readonly name?: string;
271
- /**
272
- * Connection string of the IoT hub.
273
- */
289
+ /** Connection string of the IoT hub. */
274
290
  connectionString: string;
275
- /**
276
- * ARM region of the IoT hub.
277
- */
291
+ /** ARM region of the IoT hub. */
278
292
  location: string;
279
293
  }
280
294
 
281
- /**
282
- * Description of the shared access key.
283
- */
295
+ /** Description of the shared access key. */
284
296
  export interface SharedAccessSignatureAuthorizationRuleAccessRightsDescription {
285
- /**
286
- * Name of the key.
287
- */
297
+ /** Name of the key. */
288
298
  keyName: string;
289
- /**
290
- * Primary SAS key value.
291
- */
299
+ /** Primary SAS key value. */
292
300
  primaryKey?: string;
293
- /**
294
- * Secondary SAS key value.
295
- */
301
+ /** Secondary SAS key value. */
296
302
  secondaryKey?: string;
297
- /**
298
- * Rights that this key has. Possible values include: 'ServiceConfig', 'EnrollmentRead',
299
- * 'EnrollmentWrite', 'DeviceConnect', 'RegistrationStatusRead', 'RegistrationStatusWrite'
300
- */
303
+ /** Rights that this key has. */
301
304
  rights: AccessRightsDescription;
302
305
  }
303
306
 
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;
307
+ /** List of possible provisioning service SKUs. */
308
+ export interface IotDpsSkuInfo {
309
+ /** Sku name. */
310
+ name?: IotDpsSku;
356
311
  /**
357
- * List of authorization keys for a provisioning service.
312
+ * Pricing tier name of the provisioning service.
313
+ * NOTE: This property will not be serialized. It can only be populated by the server.
358
314
  */
359
- authorizationPolicies?: SharedAccessSignatureAuthorizationRuleAccessRightsDescription[];
315
+ readonly tier?: string;
316
+ /** The number of units to provision */
317
+ capacity?: number;
360
318
  }
361
319
 
362
- /**
363
- * The common properties of an Azure resource.
364
- */
365
- export interface Resource extends BaseResource {
320
+ /** The common properties of an Azure resource. */
321
+ export interface Resource {
366
322
  /**
367
323
  * The resource identifier.
368
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
324
+ * NOTE: This property will not be serialized. It can only be populated by the server.
369
325
  */
370
326
  readonly id?: string;
371
327
  /**
372
328
  * The resource name.
373
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
329
+ * NOTE: This property will not be serialized. It can only be populated by the server.
374
330
  */
375
331
  readonly name?: string;
376
332
  /**
377
333
  * The resource type.
378
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
334
+ * NOTE: This property will not be serialized. It can only be populated by the server.
379
335
  */
380
336
  readonly type?: string;
381
- /**
382
- * The resource location.
383
- */
337
+ /** The resource location. */
384
338
  location: string;
385
- /**
386
- * The resource tags.
387
- */
339
+ /** The resource tags. */
388
340
  tags?: { [propertyName: string]: string };
389
341
  }
390
342
 
391
- /**
392
- * The description of the provisioning service.
393
- */
394
- export interface ProvisioningServiceDescription extends Resource {
343
+ /** A container holding only the Tags for a resource, allowing the user to update the tags on a Provisioning Service instance. */
344
+ export interface TagsResource {
345
+ /** Resource tags */
346
+ tags?: { [propertyName: string]: string };
347
+ }
348
+
349
+ /** The JSON-serialized array of Certificate objects. */
350
+ export interface CertificateListDescription {
351
+ /** The array of Certificate objects. */
352
+ value?: CertificateResponse[];
353
+ }
354
+
355
+ /** List of provisioning service descriptions. */
356
+ export interface ProvisioningServiceDescriptionListResult {
357
+ /** List of provisioning service descriptions. */
358
+ value?: ProvisioningServiceDescription[];
395
359
  /**
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.
360
+ * the next link
361
+ * NOTE: This property will not be serialized. It can only be populated by the server.
398
362
  */
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;
408
- }
409
-
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;
451
- }
452
-
453
- /**
454
- * The available private link resources for a provisioning service
455
- */
456
- export interface PrivateLinkResources {
457
- /**
458
- * The list of available private link resources for a provisioning service
459
- */
460
- value?: GroupIdInformation[];
363
+ readonly nextLink?: string;
461
364
  }
462
365
 
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;
366
+ /** Result of a long running operation. */
367
+ export interface AsyncOperationResult {
368
+ /** current status of a long running operation. */
369
+ status?: string;
370
+ /** Error message containing code, description and details */
371
+ error?: ErrorMesssage;
482
372
  }
483
373
 
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;
374
+ /** Error response containing message and code. */
375
+ export interface ErrorMesssage {
376
+ /** standard error code */
377
+ code?: string;
378
+ /** standard error description */
379
+ message?: string;
380
+ /** detailed summary of error */
381
+ details?: string;
497
382
  }
498
383
 
499
- /**
500
- * Error details.
501
- */
502
- export interface ErrorDetails {
384
+ /** List of available SKUs. */
385
+ export interface IotDpsSkuDefinitionListResult {
386
+ /** The list of SKUs */
387
+ value?: IotDpsSkuDefinition[];
503
388
  /**
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;
518
- /**
519
- * The error details.
520
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
389
+ * The next link.
390
+ * NOTE: This property will not be serialized. It can only be populated by the server.
521
391
  */
522
- readonly details?: string;
392
+ readonly nextLink?: string;
523
393
  }
524
394
 
525
- /**
526
- * Available SKUs of tier and units.
527
- */
395
+ /** Available SKUs of tier and units. */
528
396
  export interface IotDpsSkuDefinition {
529
- /**
530
- * Sku name. Possible values include: 'S1'
531
- */
397
+ /** Sku name. */
532
398
  name?: IotDpsSku;
533
399
  }
534
400
 
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 {
401
+ /** Description of the response of the verification code. */
402
+ export interface VerificationCodeResponse {
549
403
  /**
550
- * specifies if a name is available or not
404
+ * Name of certificate.
405
+ * NOTE: This property will not be serialized. It can only be populated by the server.
551
406
  */
552
- nameAvailable?: boolean;
407
+ readonly name?: string;
553
408
  /**
554
- * specifies the reason a name is unavailable. Possible values include: 'Invalid',
555
- * 'AlreadyExists'
409
+ * Request etag.
410
+ * NOTE: This property will not be serialized. It can only be populated by the server.
556
411
  */
557
- reason?: NameUnavailabilityReason;
412
+ readonly etag?: string;
558
413
  /**
559
- * message containing a detailed reason name is unavailable
414
+ * The resource identifier.
415
+ * NOTE: This property will not be serialized. It can only be populated by the server.
560
416
  */
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 {
417
+ readonly id?: string;
569
418
  /**
570
- * Resource tags
419
+ * The resource type.
420
+ * NOTE: This property will not be serialized. It can only be populated by the server.
571
421
  */
572
- tags?: { [propertyName: string]: string };
422
+ readonly type?: string;
423
+ properties?: VerificationCodeResponseProperties;
573
424
  }
574
425
 
575
- /**
576
- * An interface representing VerificationCodeResponseProperties.
577
- */
578
426
  export interface VerificationCodeResponseProperties {
579
- /**
580
- * Verification code.
581
- */
427
+ /** Verification code. */
582
428
  verificationCode?: string;
583
- /**
584
- * Certificate subject.
585
- */
429
+ /** Certificate subject. */
586
430
  subject?: string;
587
- /**
588
- * Code expiry.
589
- */
431
+ /** Code expiry. */
590
432
  expiry?: string;
591
- /**
592
- * Certificate thumbprint.
593
- */
433
+ /** Certificate thumbprint. */
594
434
  thumbprint?: string;
595
- /**
596
- * Indicate if the certificate is verified by owner of private key.
597
- */
435
+ /** Indicate if the certificate is verified by owner of private key. */
598
436
  isVerified?: boolean;
599
- /**
600
- * base-64 representation of X509 certificate .cer file or just .pem file content.
601
- */
437
+ /** base-64 representation of X509 certificate .cer file or just .pem file content. */
602
438
  certificate?: Uint8Array;
603
- /**
604
- * Certificate created time.
605
- */
439
+ /** Certificate created time. */
606
440
  created?: string;
607
- /**
608
- * Certificate updated time.
609
- */
441
+ /** Certificate updated time. */
610
442
  updated?: string;
611
443
  }
612
444
 
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
- */
445
+ /** The JSON-serialized leaf certificate */
643
446
  export interface VerificationCodeRequest {
644
- /**
645
- * base-64 representation of X509 certificate .cer file or just .pem file content.
646
- */
447
+ /** base-64 representation of X509 certificate .cer file or just .pem file content. */
647
448
  certificate?: string;
648
449
  }
649
450
 
650
- /**
651
- * Optional Parameters.
652
- */
653
- export interface DpsCertificateGetOptionalParams extends msRest.RequestOptionsBase {
654
- /**
655
- * ETag of the certificate.
656
- */
657
- ifMatch?: string;
451
+ /** Input values for operation results call. */
452
+ export interface OperationInputs {
453
+ /** The name of the Provisioning Service to check. */
454
+ name: string;
658
455
  }
659
456
 
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;
457
+ /** Description of name availability. */
458
+ export interface NameAvailabilityInfo {
459
+ /** specifies if a name is available or not */
460
+ nameAvailable?: boolean;
461
+ /** specifies the reason a name is unavailable */
462
+ reason?: NameUnavailabilityReason;
463
+ /** message containing a detailed reason name is unavailable */
464
+ message?: string;
669
465
  }
670
466
 
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;
467
+ /** List of shared access keys. */
468
+ export interface SharedAccessSignatureAuthorizationRuleListResult {
469
+ /** The list of shared access policies. */
470
+ value?: SharedAccessSignatureAuthorizationRuleAccessRightsDescription[];
687
471
  /**
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;
704
- /**
705
- * Random number generated to indicate Proof of Possession.
472
+ * The next link.
473
+ * NOTE: This property will not be serialized. It can only be populated by the server.
706
474
  */
707
- certificatenonce?: string;
475
+ readonly nextLink?: string;
708
476
  }
709
477
 
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;
478
+ /** The available private link resources for a provisioning service */
479
+ export interface PrivateLinkResources {
480
+ /** The list of available private link resources for a provisioning service */
481
+ value?: GroupIdInformation[];
747
482
  }
748
483
 
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;
484
+ /** The group information for creating a private endpoint on a provisioning service */
485
+ export interface GroupIdInformation {
774
486
  /**
775
- * Certificate last updated time.
487
+ * The resource identifier.
488
+ * NOTE: This property will not be serialized. It can only be populated by the server.
776
489
  */
777
- certificatelastUpdated?: Date;
490
+ readonly id?: string;
778
491
  /**
779
- * Indicates if the certificate contains private key.
492
+ * The resource name.
493
+ * NOTE: This property will not be serialized. It can only be populated by the server.
780
494
  */
781
- certificatehasPrivateKey?: boolean;
495
+ readonly name?: string;
782
496
  /**
783
- * Random number generated to indicate Proof of Possession.
497
+ * The resource type.
498
+ * NOTE: This property will not be serialized. It can only be populated by the server.
784
499
  */
785
- certificatenonce?: string;
500
+ readonly type?: string;
501
+ /** The properties for a group information object */
502
+ properties: GroupIdInformationProperties;
786
503
  }
787
504
 
788
- /**
789
- * An interface representing IotDpsClientOptions.
790
- */
791
- export interface IotDpsClientOptions extends AzureServiceClientOptions {
792
- baseUri?: string;
505
+ /** The properties for a group information object */
506
+ export interface GroupIdInformationProperties {
507
+ /** The group id */
508
+ groupId?: string;
509
+ /** The required members for a specific group id */
510
+ requiredMembers?: string[];
511
+ /** The required DNS zones for a specific group id */
512
+ requiredZoneNames?: string[];
793
513
  }
794
514
 
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> {
515
+ /** The description of the provisioning service. */
516
+ export type ProvisioningServiceDescription = Resource & {
517
+ /** 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. */
518
+ etag?: string;
519
+ /** Service specific properties for a provisioning service */
520
+ properties: IotDpsPropertiesDescription;
521
+ /** Sku info for a provisioning Service. */
522
+ sku: IotDpsSkuInfo;
802
523
  /**
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.**
524
+ * Metadata pertaining to creation and last modification of the resource.
525
+ * NOTE: This property will not be serialized. It can only be populated by the server.
805
526
  */
806
- readonly nextLink?: string;
807
- }
527
+ readonly systemData?: SystemData;
528
+ };
808
529
 
809
- /**
810
- * @interface
811
- * List of provisioning service descriptions.
812
- * @extends Array<ProvisioningServiceDescription>
530
+ /** Known values of {@link CreatedByType} that the service accepts. */
531
+ export enum KnownCreatedByType {
532
+ User = "User",
533
+ Application = "Application",
534
+ ManagedIdentity = "ManagedIdentity",
535
+ Key = "Key"
536
+ }
537
+
538
+ /**
539
+ * Defines values for CreatedByType. \
540
+ * {@link KnownCreatedByType} can be used interchangeably with CreatedByType,
541
+ * this enum contains the known values that the service supports.
542
+ * ### Known values supported by the service
543
+ * **User** \
544
+ * **Application** \
545
+ * **ManagedIdentity** \
546
+ * **Key**
813
547
  */
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;
820
- }
548
+ export type CreatedByType = string;
549
+
550
+ /** Known values of {@link CertificatePurpose} that the service accepts. */
551
+ export enum KnownCertificatePurpose {
552
+ ClientAuthentication = "clientAuthentication",
553
+ ServerAuthentication = "serverAuthentication"
554
+ }
821
555
 
822
- /**
823
- * @interface
824
- * List of available SKUs.
825
- * @extends Array<IotDpsSkuDefinition>
556
+ /**
557
+ * Defines values for CertificatePurpose. \
558
+ * {@link KnownCertificatePurpose} can be used interchangeably with CertificatePurpose,
559
+ * this enum contains the known values that the service supports.
560
+ * ### Known values supported by the service
561
+ * **clientAuthentication** \
562
+ * **serverAuthentication**
563
+ */
564
+ export type CertificatePurpose = string;
565
+
566
+ /** Known values of {@link State} that the service accepts. */
567
+ export enum KnownState {
568
+ Activating = "Activating",
569
+ Active = "Active",
570
+ Deleting = "Deleting",
571
+ Deleted = "Deleted",
572
+ ActivationFailed = "ActivationFailed",
573
+ DeletionFailed = "DeletionFailed",
574
+ Transitioning = "Transitioning",
575
+ Suspending = "Suspending",
576
+ Suspended = "Suspended",
577
+ Resuming = "Resuming",
578
+ FailingOver = "FailingOver",
579
+ FailoverFailed = "FailoverFailed"
580
+ }
581
+
582
+ /**
583
+ * Defines values for State. \
584
+ * {@link KnownState} can be used interchangeably with State,
585
+ * this enum contains the known values that the service supports.
586
+ * ### Known values supported by the service
587
+ * **Activating** \
588
+ * **Active** \
589
+ * **Deleting** \
590
+ * **Deleted** \
591
+ * **ActivationFailed** \
592
+ * **DeletionFailed** \
593
+ * **Transitioning** \
594
+ * **Suspending** \
595
+ * **Suspended** \
596
+ * **Resuming** \
597
+ * **FailingOver** \
598
+ * **FailoverFailed**
826
599
  */
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;
600
+ export type State = string;
601
+
602
+ /** Known values of {@link PublicNetworkAccess} that the service accepts. */
603
+ export enum KnownPublicNetworkAccess {
604
+ Enabled = "Enabled",
605
+ Disabled = "Disabled"
833
606
  }
834
607
 
835
608
  /**
836
- * @interface
837
- * List of shared access keys.
838
- * @extends Array<SharedAccessSignatureAuthorizationRuleAccessRightsDescription>
609
+ * Defines values for PublicNetworkAccess. \
610
+ * {@link KnownPublicNetworkAccess} can be used interchangeably with PublicNetworkAccess,
611
+ * this enum contains the known values that the service supports.
612
+ * ### Known values supported by the service
613
+ * **Enabled** \
614
+ * **Disabled**
839
615
  */
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;
616
+ export type PublicNetworkAccess = string;
617
+
618
+ /** Known values of {@link PrivateLinkServiceConnectionStatus} that the service accepts. */
619
+ export enum KnownPrivateLinkServiceConnectionStatus {
620
+ Pending = "Pending",
621
+ Approved = "Approved",
622
+ Rejected = "Rejected",
623
+ Disconnected = "Disconnected"
846
624
  }
847
625
 
848
626
  /**
849
- * Defines values for IotDpsSku.
850
- * Possible values include: 'S1'
851
- * @readonly
852
- * @enum {string}
627
+ * Defines values for PrivateLinkServiceConnectionStatus. \
628
+ * {@link KnownPrivateLinkServiceConnectionStatus} can be used interchangeably with PrivateLinkServiceConnectionStatus,
629
+ * this enum contains the known values that the service supports.
630
+ * ### Known values supported by the service
631
+ * **Pending** \
632
+ * **Approved** \
633
+ * **Rejected** \
634
+ * **Disconnected**
853
635
  */
854
- export type IotDpsSku = 'S1';
636
+ export type PrivateLinkServiceConnectionStatus = string;
637
+
638
+ /** Known values of {@link AllocationPolicy} that the service accepts. */
639
+ export enum KnownAllocationPolicy {
640
+ Hashed = "Hashed",
641
+ GeoLatency = "GeoLatency",
642
+ Static = "Static"
643
+ }
855
644
 
856
645
  /**
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}
646
+ * Defines values for AllocationPolicy. \
647
+ * {@link KnownAllocationPolicy} can be used interchangeably with AllocationPolicy,
648
+ * this enum contains the known values that the service supports.
649
+ * ### Known values supported by the service
650
+ * **Hashed** \
651
+ * **GeoLatency** \
652
+ * **Static**
863
653
  */
864
- export type State = 'Activating' | 'Active' | 'Deleting' | 'Deleted' | 'ActivationFailed' | 'DeletionFailed' | 'Transitioning' | 'Suspending' | 'Suspended' | 'Resuming' | 'FailingOver' | 'FailoverFailed';
865
-
866
- /**
867
- * Defines values for PublicNetworkAccess.
868
- * Possible values include: 'Enabled', 'Disabled'
869
- * @readonly
870
- * @enum {string}
654
+ export type AllocationPolicy = string;
655
+
656
+ /** Known values of {@link AccessRightsDescription} that the service accepts. */
657
+ export enum KnownAccessRightsDescription {
658
+ ServiceConfig = "ServiceConfig",
659
+ EnrollmentRead = "EnrollmentRead",
660
+ EnrollmentWrite = "EnrollmentWrite",
661
+ DeviceConnect = "DeviceConnect",
662
+ RegistrationStatusRead = "RegistrationStatusRead",
663
+ RegistrationStatusWrite = "RegistrationStatusWrite"
664
+ }
665
+
666
+ /**
667
+ * Defines values for AccessRightsDescription. \
668
+ * {@link KnownAccessRightsDescription} can be used interchangeably with AccessRightsDescription,
669
+ * this enum contains the known values that the service supports.
670
+ * ### Known values supported by the service
671
+ * **ServiceConfig** \
672
+ * **EnrollmentRead** \
673
+ * **EnrollmentWrite** \
674
+ * **DeviceConnect** \
675
+ * **RegistrationStatusRead** \
676
+ * **RegistrationStatusWrite**
871
677
  */
872
- export type PublicNetworkAccess = 'Enabled' | 'Disabled';
678
+ export type AccessRightsDescription = string;
679
+
680
+ /** Known values of {@link IotDpsSku} that the service accepts. */
681
+ export enum KnownIotDpsSku {
682
+ S1 = "S1"
683
+ }
873
684
 
874
685
  /**
875
- * Defines values for IpFilterActionType.
876
- * Possible values include: 'Accept', 'Reject'
877
- * @readonly
878
- * @enum {string}
686
+ * Defines values for IotDpsSku. \
687
+ * {@link KnownIotDpsSku} can be used interchangeably with IotDpsSku,
688
+ * this enum contains the known values that the service supports.
689
+ * ### Known values supported by the service
690
+ * **S1**
879
691
  */
880
- export type IpFilterActionType = 'Accept' | 'Reject';
692
+ export type IotDpsSku = string;
881
693
 
882
- /**
883
- * Defines values for IpFilterTargetType.
884
- * Possible values include: 'all', 'serviceApi', 'deviceApi'
885
- * @readonly
886
- * @enum {string}
887
- */
888
- export type IpFilterTargetType = 'all' | 'serviceApi' | 'deviceApi';
694
+ /** Known values of {@link NameUnavailabilityReason} that the service accepts. */
695
+ export enum KnownNameUnavailabilityReason {
696
+ Invalid = "Invalid",
697
+ AlreadyExists = "AlreadyExists"
698
+ }
889
699
 
890
700
  /**
891
- * Defines values for PrivateLinkServiceConnectionStatus.
892
- * Possible values include: 'Pending', 'Approved', 'Rejected', 'Disconnected'
893
- * @readonly
894
- * @enum {string}
701
+ * Defines values for NameUnavailabilityReason. \
702
+ * {@link KnownNameUnavailabilityReason} can be used interchangeably with NameUnavailabilityReason,
703
+ * this enum contains the known values that the service supports.
704
+ * ### Known values supported by the service
705
+ * **Invalid** \
706
+ * **AlreadyExists**
895
707
  */
896
- export type PrivateLinkServiceConnectionStatus = 'Pending' | 'Approved' | 'Rejected' | 'Disconnected';
708
+ export type NameUnavailabilityReason = string;
709
+ /** Defines values for IpFilterActionType. */
710
+ export type IpFilterActionType = "Accept" | "Reject";
711
+ /** Defines values for IpFilterTargetType. */
712
+ export type IpFilterTargetType = "all" | "serviceApi" | "deviceApi";
897
713
 
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';
714
+ /** Optional parameters. */
715
+ export interface OperationsListOptionalParams
716
+ extends coreClient.OperationOptions {}
905
717
 
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';
718
+ /** Contains response data for the list operation. */
719
+ export type OperationsListResponse = OperationListResult;
914
720
 
915
- /**
916
- * Defines values for NameUnavailabilityReason.
917
- * Possible values include: 'Invalid', 'AlreadyExists'
918
- * @readonly
919
- * @enum {string}
920
- */
921
- export type NameUnavailabilityReason = 'Invalid' | 'AlreadyExists';
721
+ /** Optional parameters. */
722
+ export interface OperationsListNextOptionalParams
723
+ extends coreClient.OperationOptions {}
922
724
 
923
- /**
924
- * Defines values for CertificatePurpose.
925
- * Possible values include: 'clientAuthentication', 'serverAuthentication'
926
- * @readonly
927
- * @enum {string}
928
- */
929
- export type CertificatePurpose = 'clientAuthentication' | 'serverAuthentication';
725
+ /** Contains response data for the listNext operation. */
726
+ export type OperationsListNextResponse = OperationListResult;
930
727
 
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
- };
728
+ /** Optional parameters. */
729
+ export interface DpsCertificateGetOptionalParams
730
+ extends coreClient.OperationOptions {
731
+ /** ETag of the certificate. */
732
+ ifMatch?: string;
733
+ }
950
734
 
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
- };
735
+ /** Contains response data for the get operation. */
736
+ export type DpsCertificateGetResponse = CertificateResponse;
970
737
 
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
- };
738
+ /** Optional parameters. */
739
+ export interface DpsCertificateCreateOrUpdateOptionalParams
740
+ extends coreClient.OperationOptions {
741
+ /** ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate. */
742
+ ifMatch?: string;
743
+ }
990
744
 
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
- };
745
+ /** Contains response data for the createOrUpdate operation. */
746
+ export type DpsCertificateCreateOrUpdateResponse = CertificateResponse;
747
+
748
+ /** Optional parameters. */
749
+ export interface DpsCertificateDeleteOptionalParams
750
+ extends coreClient.OperationOptions {
751
+ /** This is optional, and it is the Common Name of the certificate. */
752
+ certificateName1?: string;
753
+ /** Raw data within the certificate. */
754
+ certificateRawBytes?: Uint8Array;
755
+ /** Indicates if certificate has been verified by owner of the private key. */
756
+ certificateIsVerified?: boolean;
757
+ /** A description that mentions the purpose of the certificate. */
758
+ certificatePurpose?: CertificatePurpose;
759
+ /** Time the certificate is created. */
760
+ certificateCreated?: Date;
761
+ /** Time the certificate is last updated. */
762
+ certificateLastUpdated?: Date;
763
+ /** Indicates if the certificate contains a private key. */
764
+ certificateHasPrivateKey?: boolean;
765
+ /** Random number generated to indicate Proof of Possession. */
766
+ certificateNonce?: string;
767
+ }
768
+
769
+ /** Optional parameters. */
770
+ export interface DpsCertificateListOptionalParams
771
+ extends coreClient.OperationOptions {}
772
+
773
+ /** Contains response data for the list operation. */
774
+ export type DpsCertificateListResponse = CertificateListDescription;
775
+
776
+ /** Optional parameters. */
777
+ export interface DpsCertificateGenerateVerificationCodeOptionalParams
778
+ extends coreClient.OperationOptions {
779
+ /** Common Name for the certificate. */
780
+ certificateName1?: string;
781
+ /** Raw data of certificate. */
782
+ certificateRawBytes?: Uint8Array;
783
+ /** Indicates if the certificate has been verified by owner of the private key. */
784
+ certificateIsVerified?: boolean;
785
+ /** Description mentioning the purpose of the certificate. */
786
+ certificatePurpose?: CertificatePurpose;
787
+ /** Certificate creation time. */
788
+ certificateCreated?: Date;
789
+ /** Certificate last updated time. */
790
+ certificateLastUpdated?: Date;
791
+ /** Indicates if the certificate contains private key. */
792
+ certificateHasPrivateKey?: boolean;
793
+ /** Random number generated to indicate Proof of Possession. */
794
+ certificateNonce?: string;
795
+ }
796
+
797
+ /** Contains response data for the generateVerificationCode operation. */
798
+ export type DpsCertificateGenerateVerificationCodeResponse = VerificationCodeResponse;
799
+
800
+ /** Optional parameters. */
801
+ export interface DpsCertificateVerifyCertificateOptionalParams
802
+ extends coreClient.OperationOptions {
803
+ /** Common Name for the certificate. */
804
+ certificateName1?: string;
805
+ /** Raw data of certificate. */
806
+ certificateRawBytes?: Uint8Array;
807
+ /** Indicates if the certificate has been verified by owner of the private key. */
808
+ certificateIsVerified?: boolean;
809
+ /** Describe the purpose of the certificate. */
810
+ certificatePurpose?: CertificatePurpose;
811
+ /** Certificate creation time. */
812
+ certificateCreated?: Date;
813
+ /** Certificate last updated time. */
814
+ certificateLastUpdated?: Date;
815
+ /** Indicates if the certificate contains private key. */
816
+ certificateHasPrivateKey?: boolean;
817
+ /** Random number generated to indicate Proof of Possession. */
818
+ certificateNonce?: string;
819
+ }
820
+
821
+ /** Contains response data for the verifyCertificate operation. */
822
+ export type DpsCertificateVerifyCertificateResponse = CertificateResponse;
823
+
824
+ /** Optional parameters. */
825
+ export interface IotDpsResourceGetOptionalParams
826
+ extends coreClient.OperationOptions {}
827
+
828
+ /** Contains response data for the get operation. */
829
+ export type IotDpsResourceGetResponse = ProvisioningServiceDescription;
830
+
831
+ /** Optional parameters. */
832
+ export interface IotDpsResourceCreateOrUpdateOptionalParams
833
+ extends coreClient.OperationOptions {
834
+ /** Delay to wait until next poll, in milliseconds. */
835
+ updateIntervalInMs?: number;
836
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
837
+ resumeFrom?: string;
838
+ }
839
+
840
+ /** Contains response data for the createOrUpdate operation. */
841
+ export type IotDpsResourceCreateOrUpdateResponse = ProvisioningServiceDescription;
842
+
843
+ /** Optional parameters. */
844
+ export interface IotDpsResourceUpdateOptionalParams
845
+ extends coreClient.OperationOptions {
846
+ /** Delay to wait until next poll, in milliseconds. */
847
+ updateIntervalInMs?: number;
848
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
849
+ resumeFrom?: string;
850
+ }
851
+
852
+ /** Contains response data for the update operation. */
853
+ export type IotDpsResourceUpdateResponse = ProvisioningServiceDescription;
854
+
855
+ /** Optional parameters. */
856
+ export interface IotDpsResourceDeleteOptionalParams
857
+ extends coreClient.OperationOptions {
858
+ /** Delay to wait until next poll, in milliseconds. */
859
+ updateIntervalInMs?: number;
860
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
861
+ resumeFrom?: string;
862
+ }
863
+
864
+ /** Optional parameters. */
865
+ export interface IotDpsResourceListBySubscriptionOptionalParams
866
+ extends coreClient.OperationOptions {}
867
+
868
+ /** Contains response data for the listBySubscription operation. */
869
+ export type IotDpsResourceListBySubscriptionResponse = ProvisioningServiceDescriptionListResult;
870
+
871
+ /** Optional parameters. */
872
+ export interface IotDpsResourceListByResourceGroupOptionalParams
873
+ extends coreClient.OperationOptions {}
874
+
875
+ /** Contains response data for the listByResourceGroup operation. */
876
+ export type IotDpsResourceListByResourceGroupResponse = ProvisioningServiceDescriptionListResult;
877
+
878
+ /** Optional parameters. */
879
+ export interface IotDpsResourceGetOperationResultOptionalParams
880
+ extends coreClient.OperationOptions {}
881
+
882
+ /** Contains response data for the getOperationResult operation. */
883
+ export type IotDpsResourceGetOperationResultResponse = AsyncOperationResult;
884
+
885
+ /** Optional parameters. */
886
+ export interface IotDpsResourceListValidSkusOptionalParams
887
+ extends coreClient.OperationOptions {}
1010
888
 
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
- };
889
+ /** Contains response data for the listValidSkus operation. */
890
+ export type IotDpsResourceListValidSkusResponse = IotDpsSkuDefinitionListResult;
1030
891
 
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
- };
892
+ /** Optional parameters. */
893
+ export interface IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams
894
+ extends coreClient.OperationOptions {}
1050
895
 
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
- };
896
+ /** Contains response data for the checkProvisioningServiceNameAvailability operation. */
897
+ export type IotDpsResourceCheckProvisioningServiceNameAvailabilityResponse = NameAvailabilityInfo;
1070
898
 
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
- };
899
+ /** Optional parameters. */
900
+ export interface IotDpsResourceListKeysOptionalParams
901
+ extends coreClient.OperationOptions {}
1090
902
 
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
- };
903
+ /** Contains response data for the listKeys operation. */
904
+ export type IotDpsResourceListKeysResponse = SharedAccessSignatureAuthorizationRuleListResult;
1110
905
 
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
- };
906
+ /** Optional parameters. */
907
+ export interface IotDpsResourceListKeysForKeyNameOptionalParams
908
+ extends coreClient.OperationOptions {}
1130
909
 
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
- };
910
+ /** Contains response data for the listKeysForKeyName operation. */
911
+ export type IotDpsResourceListKeysForKeyNameResponse = SharedAccessSignatureAuthorizationRuleAccessRightsDescription;
1150
912
 
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
- };
913
+ /** Optional parameters. */
914
+ export interface IotDpsResourceListPrivateLinkResourcesOptionalParams
915
+ extends coreClient.OperationOptions {}
1170
916
 
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
- };
917
+ /** Contains response data for the listPrivateLinkResources operation. */
918
+ export type IotDpsResourceListPrivateLinkResourcesResponse = PrivateLinkResources;
1190
919
 
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
- };
920
+ /** Optional parameters. */
921
+ export interface IotDpsResourceGetPrivateLinkResourcesOptionalParams
922
+ extends coreClient.OperationOptions {}
1210
923
 
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
- };
924
+ /** Contains response data for the getPrivateLinkResources operation. */
925
+ export type IotDpsResourceGetPrivateLinkResourcesResponse = GroupIdInformation;
1230
926
 
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
- };
927
+ /** Optional parameters. */
928
+ export interface IotDpsResourceListPrivateEndpointConnectionsOptionalParams
929
+ extends coreClient.OperationOptions {}
1250
930
 
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
- };
931
+ /** Contains response data for the listPrivateEndpointConnections operation. */
932
+ export type IotDpsResourceListPrivateEndpointConnectionsResponse = PrivateEndpointConnection[];
1270
933
 
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
- };
934
+ /** Optional parameters. */
935
+ export interface IotDpsResourceGetPrivateEndpointConnectionOptionalParams
936
+ extends coreClient.OperationOptions {}
1290
937
 
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
- };
938
+ /** Contains response data for the getPrivateEndpointConnection operation. */
939
+ export type IotDpsResourceGetPrivateEndpointConnectionResponse = PrivateEndpointConnection;
1310
940
 
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
- };
941
+ /** Optional parameters. */
942
+ export interface IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams
943
+ extends coreClient.OperationOptions {
944
+ /** Delay to wait until next poll, in milliseconds. */
945
+ updateIntervalInMs?: number;
946
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
947
+ resumeFrom?: string;
948
+ }
1330
949
 
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
- };
950
+ /** Contains response data for the createOrUpdatePrivateEndpointConnection operation. */
951
+ export type IotDpsResourceCreateOrUpdatePrivateEndpointConnectionResponse = PrivateEndpointConnection;
1350
952
 
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
- };
953
+ /** Optional parameters. */
954
+ export interface IotDpsResourceDeletePrivateEndpointConnectionOptionalParams
955
+ extends coreClient.OperationOptions {
956
+ /** Delay to wait until next poll, in milliseconds. */
957
+ updateIntervalInMs?: number;
958
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
959
+ resumeFrom?: string;
960
+ }
1370
961
 
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
- };
962
+ /** Contains response data for the deletePrivateEndpointConnection operation. */
963
+ export type IotDpsResourceDeletePrivateEndpointConnectionResponse = PrivateEndpointConnection;
1390
964
 
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
- };
965
+ /** Optional parameters. */
966
+ export interface IotDpsResourceListBySubscriptionNextOptionalParams
967
+ extends coreClient.OperationOptions {}
1410
968
 
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
- };
969
+ /** Contains response data for the listBySubscriptionNext operation. */
970
+ export type IotDpsResourceListBySubscriptionNextResponse = ProvisioningServiceDescriptionListResult;
1430
971
 
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
- };
972
+ /** Optional parameters. */
973
+ export interface IotDpsResourceListByResourceGroupNextOptionalParams
974
+ extends coreClient.OperationOptions {}
1450
975
 
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
- };
976
+ /** Contains response data for the listByResourceGroupNext operation. */
977
+ export type IotDpsResourceListByResourceGroupNextResponse = ProvisioningServiceDescriptionListResult;
1470
978
 
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
- };
979
+ /** Optional parameters. */
980
+ export interface IotDpsResourceListValidSkusNextOptionalParams
981
+ extends coreClient.OperationOptions {}
1490
982
 
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
- };
983
+ /** Contains response data for the listValidSkusNext operation. */
984
+ export type IotDpsResourceListValidSkusNextResponse = IotDpsSkuDefinitionListResult;
1510
985
 
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
- };
986
+ /** Optional parameters. */
987
+ export interface IotDpsResourceListKeysNextOptionalParams
988
+ extends coreClient.OperationOptions {}
1530
989
 
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
- };
990
+ /** Contains response data for the listKeysNext operation. */
991
+ export type IotDpsResourceListKeysNextResponse = SharedAccessSignatureAuthorizationRuleListResult;
992
+
993
+ /** Optional parameters. */
994
+ export interface IotDpsClientOptionalParams
995
+ extends coreClient.ServiceClientOptions {
996
+ /** server parameter */
997
+ $host?: string;
998
+ /** Api Version */
999
+ apiVersion?: string;
1000
+ /** Overrides client endpoint. */
1001
+ endpoint?: string;
1002
+ }