@azure/arm-digitaltwins 2.1.1 → 3.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 (174) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/LICENSE +21 -0
  3. package/README.md +69 -83
  4. package/dist/index.js +2613 -0
  5. package/dist/index.js.map +1 -0
  6. package/dist/index.min.js +1 -0
  7. package/dist/index.min.js.map +1 -0
  8. package/dist-esm/src/azureDigitalTwinsManagementClient.d.ts +22 -0
  9. package/dist-esm/src/azureDigitalTwinsManagementClient.d.ts.map +1 -0
  10. package/dist-esm/src/azureDigitalTwinsManagementClient.js +55 -0
  11. package/dist-esm/src/azureDigitalTwinsManagementClient.js.map +1 -0
  12. package/dist-esm/src/index.d.ts +5 -0
  13. package/dist-esm/src/index.d.ts.map +1 -0
  14. package/dist-esm/src/index.js +12 -0
  15. package/dist-esm/src/index.js.map +1 -0
  16. package/dist-esm/src/lroImpl.d.ts +16 -0
  17. package/dist-esm/src/lroImpl.d.ts.map +1 -0
  18. package/dist-esm/src/lroImpl.js +29 -0
  19. package/dist-esm/src/lroImpl.js.map +1 -0
  20. package/dist-esm/src/models/index.d.ts +677 -0
  21. package/dist-esm/src/models/index.d.ts.map +1 -0
  22. package/dist-esm/src/models/index.js +85 -0
  23. package/dist-esm/src/models/index.js.map +1 -0
  24. package/dist-esm/src/models/mappers.d.ts +40 -0
  25. package/dist-esm/src/models/mappers.d.ts.map +1 -0
  26. package/{esm → dist-esm/src}/models/mappers.js +441 -491
  27. package/dist-esm/src/models/mappers.js.map +1 -0
  28. package/dist-esm/src/models/parameters.d.ts +19 -0
  29. package/dist-esm/src/models/parameters.d.ts.map +1 -0
  30. package/dist-esm/src/models/parameters.js +171 -0
  31. package/dist-esm/src/models/parameters.js.map +1 -0
  32. package/dist-esm/src/operations/digitalTwins.d.ts +119 -0
  33. package/dist-esm/src/operations/digitalTwins.d.ts.map +1 -0
  34. package/dist-esm/src/operations/digitalTwins.js +549 -0
  35. package/dist-esm/src/operations/digitalTwins.js.map +1 -0
  36. package/dist-esm/src/operations/digitalTwinsEndpoint.d.ts +81 -0
  37. package/dist-esm/src/operations/digitalTwinsEndpoint.d.ts.map +1 -0
  38. package/dist-esm/src/operations/digitalTwinsEndpoint.js +345 -0
  39. package/dist-esm/src/operations/digitalTwinsEndpoint.js.map +1 -0
  40. package/{esm → dist-esm/src}/operations/index.d.ts +0 -0
  41. package/dist-esm/src/operations/index.d.ts.map +1 -0
  42. package/{esm → dist-esm/src}/operations/index.js +1 -2
  43. package/dist-esm/src/operations/index.js.map +1 -0
  44. package/dist-esm/src/operations/operations.d.ts +32 -0
  45. package/dist-esm/src/operations/operations.d.ts.map +1 -0
  46. package/dist-esm/src/operations/operations.js +120 -0
  47. package/dist-esm/src/operations/operations.js.map +1 -0
  48. package/dist-esm/src/operations/privateEndpointConnections.d.ts +63 -0
  49. package/dist-esm/src/operations/privateEndpointConnections.d.ts.map +1 -0
  50. package/dist-esm/src/operations/privateEndpointConnections.js +264 -0
  51. package/dist-esm/src/operations/privateEndpointConnections.js.map +1 -0
  52. package/dist-esm/src/operations/privateLinkResources.d.ts +28 -0
  53. package/dist-esm/src/operations/privateLinkResources.d.ts.map +1 -0
  54. package/dist-esm/src/operations/privateLinkResources.js +85 -0
  55. package/dist-esm/src/operations/privateLinkResources.js.map +1 -0
  56. package/dist-esm/src/operationsInterfaces/digitalTwins.d.ts +83 -0
  57. package/dist-esm/src/operationsInterfaces/digitalTwins.d.ts.map +1 -0
  58. package/{src/models/operationsMappers.ts → dist-esm/src/operationsInterfaces/digitalTwins.js} +2 -9
  59. package/dist-esm/src/operationsInterfaces/digitalTwins.js.map +1 -0
  60. package/dist-esm/src/operationsInterfaces/digitalTwinsEndpoint.d.ts +56 -0
  61. package/dist-esm/src/operationsInterfaces/digitalTwinsEndpoint.d.ts.map +1 -0
  62. package/{esm/models/operationsMappers.js → dist-esm/src/operationsInterfaces/digitalTwinsEndpoint.js} +2 -2
  63. package/dist-esm/src/operationsInterfaces/digitalTwinsEndpoint.js.map +1 -0
  64. package/dist-esm/src/operationsInterfaces/index.d.ts +6 -0
  65. package/dist-esm/src/operationsInterfaces/index.d.ts.map +1 -0
  66. package/dist-esm/src/operationsInterfaces/index.js +13 -0
  67. package/dist-esm/src/operationsInterfaces/index.js.map +1 -0
  68. package/dist-esm/src/operationsInterfaces/operations.d.ts +11 -0
  69. package/dist-esm/src/operationsInterfaces/operations.d.ts.map +1 -0
  70. package/{esm/models/index.js → dist-esm/src/operationsInterfaces/operations.js} +2 -1
  71. package/dist-esm/src/operationsInterfaces/operations.js.map +1 -0
  72. package/dist-esm/src/operationsInterfaces/privateEndpointConnections.d.ts +55 -0
  73. package/dist-esm/src/operationsInterfaces/privateEndpointConnections.d.ts.map +1 -0
  74. package/dist-esm/src/operationsInterfaces/privateEndpointConnections.js +9 -0
  75. package/dist-esm/src/operationsInterfaces/privateEndpointConnections.js.map +1 -0
  76. package/dist-esm/src/operationsInterfaces/privateLinkResources.d.ts +20 -0
  77. package/dist-esm/src/operationsInterfaces/privateLinkResources.d.ts.map +1 -0
  78. package/dist-esm/src/operationsInterfaces/privateLinkResources.js +9 -0
  79. package/dist-esm/src/operationsInterfaces/privateLinkResources.js.map +1 -0
  80. package/dist-esm/test/sampleTest.d.ts +2 -0
  81. package/dist-esm/test/sampleTest.d.ts.map +1 -0
  82. package/dist-esm/test/sampleTest.js +40 -0
  83. package/dist-esm/test/sampleTest.js.map +1 -0
  84. package/package.json +65 -32
  85. package/review/arm-digitaltwins.api.md +620 -0
  86. package/rollup.config.js +181 -30
  87. package/src/azureDigitalTwinsManagementClient.ts +80 -40
  88. package/src/{models/privateLinkResourcesMappers.ts → index.ts} +4 -9
  89. package/src/lroImpl.ts +34 -0
  90. package/src/models/index.ts +589 -1071
  91. package/src/models/mappers.ts +444 -492
  92. package/src/models/parameters.ts +119 -54
  93. package/src/operations/digitalTwins.ts +555 -371
  94. package/src/operations/digitalTwinsEndpoint.ts +338 -192
  95. package/src/operations/index.ts +1 -2
  96. package/src/operations/operations.ts +85 -73
  97. package/src/operations/privateEndpointConnections.ts +246 -151
  98. package/src/operations/privateLinkResources.ts +60 -92
  99. package/src/operationsInterfaces/digitalTwins.ts +164 -0
  100. package/src/operationsInterfaces/digitalTwinsEndpoint.ts +115 -0
  101. package/src/operationsInterfaces/index.ts +13 -0
  102. package/src/operationsInterfaces/operations.ts +22 -0
  103. package/src/operationsInterfaces/privateEndpointConnections.ts +108 -0
  104. package/src/operationsInterfaces/privateLinkResources.ts +42 -0
  105. package/tsconfig.json +3 -3
  106. package/types/arm-digitaltwins.d.ts +1009 -0
  107. package/types/tsdoc-metadata.json +11 -0
  108. package/dist/arm-digitaltwins.js +0 -2418
  109. package/dist/arm-digitaltwins.js.map +0 -1
  110. package/dist/arm-digitaltwins.min.js +0 -1
  111. package/dist/arm-digitaltwins.min.js.map +0 -1
  112. package/esm/azureDigitalTwinsManagementClient.d.ts +0 -28
  113. package/esm/azureDigitalTwinsManagementClient.d.ts.map +0 -1
  114. package/esm/azureDigitalTwinsManagementClient.js +0 -41
  115. package/esm/azureDigitalTwinsManagementClient.js.map +0 -1
  116. package/esm/azureDigitalTwinsManagementClientContext.d.ts +0 -22
  117. package/esm/azureDigitalTwinsManagementClientContext.d.ts.map +0 -1
  118. package/esm/azureDigitalTwinsManagementClientContext.js +0 -60
  119. package/esm/azureDigitalTwinsManagementClientContext.js.map +0 -1
  120. package/esm/models/digitalTwinsEndpointMappers.d.ts +0 -2
  121. package/esm/models/digitalTwinsEndpointMappers.d.ts.map +0 -1
  122. package/esm/models/digitalTwinsEndpointMappers.js +0 -9
  123. package/esm/models/digitalTwinsEndpointMappers.js.map +0 -1
  124. package/esm/models/digitalTwinsMappers.d.ts +0 -2
  125. package/esm/models/digitalTwinsMappers.d.ts.map +0 -1
  126. package/esm/models/digitalTwinsMappers.js +0 -9
  127. package/esm/models/digitalTwinsMappers.js.map +0 -1
  128. package/esm/models/index.d.ts +0 -1169
  129. package/esm/models/index.d.ts.map +0 -1
  130. package/esm/models/index.js.map +0 -1
  131. package/esm/models/mappers.d.ts +0 -42
  132. package/esm/models/mappers.d.ts.map +0 -1
  133. package/esm/models/mappers.js.map +0 -1
  134. package/esm/models/operationsMappers.d.ts +0 -2
  135. package/esm/models/operationsMappers.d.ts.map +0 -1
  136. package/esm/models/operationsMappers.js.map +0 -1
  137. package/esm/models/parameters.d.ts +0 -12
  138. package/esm/models/parameters.d.ts.map +0 -1
  139. package/esm/models/parameters.js +0 -132
  140. package/esm/models/parameters.js.map +0 -1
  141. package/esm/models/privateEndpointConnectionsMappers.d.ts +0 -2
  142. package/esm/models/privateEndpointConnectionsMappers.d.ts.map +0 -1
  143. package/esm/models/privateEndpointConnectionsMappers.js +0 -9
  144. package/esm/models/privateEndpointConnectionsMappers.js.map +0 -1
  145. package/esm/models/privateLinkResourcesMappers.d.ts +0 -2
  146. package/esm/models/privateLinkResourcesMappers.d.ts.map +0 -1
  147. package/esm/models/privateLinkResourcesMappers.js +0 -9
  148. package/esm/models/privateLinkResourcesMappers.js.map +0 -1
  149. package/esm/operations/digitalTwins.d.ts +0 -181
  150. package/esm/operations/digitalTwins.d.ts.map +0 -1
  151. package/esm/operations/digitalTwins.js +0 -383
  152. package/esm/operations/digitalTwins.js.map +0 -1
  153. package/esm/operations/digitalTwinsEndpoint.d.ts +0 -115
  154. package/esm/operations/digitalTwinsEndpoint.d.ts.map +0 -1
  155. package/esm/operations/digitalTwinsEndpoint.js +0 -242
  156. package/esm/operations/digitalTwinsEndpoint.js.map +0 -1
  157. package/esm/operations/index.d.ts.map +0 -1
  158. package/esm/operations/index.js.map +0 -1
  159. package/esm/operations/operations.d.ts +0 -46
  160. package/esm/operations/operations.d.ts.map +0 -1
  161. package/esm/operations/operations.js +0 -79
  162. package/esm/operations/operations.js.map +0 -1
  163. package/esm/operations/privateEndpointConnections.d.ts +0 -97
  164. package/esm/operations/privateEndpointConnections.d.ts.map +0 -1
  165. package/esm/operations/privateEndpointConnections.js +0 -209
  166. package/esm/operations/privateEndpointConnections.js.map +0 -1
  167. package/esm/operations/privateLinkResources.d.ts +0 -58
  168. package/esm/operations/privateLinkResources.d.ts.map +0 -1
  169. package/esm/operations/privateLinkResources.js +0 -90
  170. package/esm/operations/privateLinkResources.js.map +0 -1
  171. package/src/azureDigitalTwinsManagementClientContext.ts +0 -67
  172. package/src/models/digitalTwinsEndpointMappers.ts +0 -31
  173. package/src/models/digitalTwinsMappers.ts +0 -35
  174. package/src/models/privateEndpointConnectionsMappers.ts +0 -31
@@ -0,0 +1,677 @@
1
+ import * as coreClient from "@azure/core-client";
2
+ export declare type DigitalTwinsEndpointResourcePropertiesUnion = DigitalTwinsEndpointResourceProperties | ServiceBus | EventHub | EventGrid;
3
+ /** The private endpoint connection of a Digital Twin. */
4
+ export interface PrivateEndpointConnection {
5
+ /**
6
+ * The resource identifier.
7
+ * NOTE: This property will not be serialized. It can only be populated by the server.
8
+ */
9
+ readonly id?: string;
10
+ /**
11
+ * The resource name.
12
+ * NOTE: This property will not be serialized. It can only be populated by the server.
13
+ */
14
+ readonly name?: string;
15
+ /**
16
+ * The resource type.
17
+ * NOTE: This property will not be serialized. It can only be populated by the server.
18
+ */
19
+ readonly type?: string;
20
+ properties: PrivateEndpointConnectionProperties;
21
+ }
22
+ /** The properties of a private endpoint connection. */
23
+ export interface ConnectionProperties {
24
+ /**
25
+ * The provisioning state.
26
+ * NOTE: This property will not be serialized. It can only be populated by the server.
27
+ */
28
+ readonly provisioningState?: ConnectionPropertiesProvisioningState;
29
+ privateEndpoint?: ConnectionPropertiesPrivateEndpoint;
30
+ /** The list of group ids for the private endpoint connection. */
31
+ groupIds?: string[];
32
+ privateLinkServiceConnectionState?: ConnectionPropertiesPrivateLinkServiceConnectionState;
33
+ }
34
+ /** The private endpoint property of a private endpoint connection. */
35
+ export interface PrivateEndpoint {
36
+ /**
37
+ * The resource identifier.
38
+ * NOTE: This property will not be serialized. It can only be populated by the server.
39
+ */
40
+ readonly id?: string;
41
+ }
42
+ /** The current state of a private endpoint connection. */
43
+ export interface ConnectionState {
44
+ /** The status of a private endpoint connection. */
45
+ status: PrivateLinkServiceConnectionStatus;
46
+ /** The description for the current state of a private endpoint connection. */
47
+ description: string;
48
+ /** Actions required for a private endpoint connection. */
49
+ actionsRequired?: string;
50
+ }
51
+ /** The common properties of a DigitalTwinsInstance. */
52
+ export interface DigitalTwinsResource {
53
+ /**
54
+ * The resource identifier.
55
+ * NOTE: This property will not be serialized. It can only be populated by the server.
56
+ */
57
+ readonly id?: string;
58
+ /**
59
+ * The resource name.
60
+ * NOTE: This property will not be serialized. It can only be populated by the server.
61
+ */
62
+ readonly name?: string;
63
+ /**
64
+ * The resource type.
65
+ * NOTE: This property will not be serialized. It can only be populated by the server.
66
+ */
67
+ readonly type?: string;
68
+ /** The resource location. */
69
+ location: string;
70
+ /** The resource tags. */
71
+ tags?: {
72
+ [propertyName: string]: string;
73
+ };
74
+ /** The managed identity for the DigitalTwinsInstance. */
75
+ identity?: DigitalTwinsIdentity;
76
+ }
77
+ /** The managed identity for the DigitalTwinsInstance. */
78
+ export interface DigitalTwinsIdentity {
79
+ /** The type of Managed Identity used by the DigitalTwinsInstance. Only SystemAssigned is supported. */
80
+ type?: DigitalTwinsIdentityType;
81
+ /**
82
+ * The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity
83
+ * NOTE: This property will not be serialized. It can only be populated by the server.
84
+ */
85
+ readonly principalId?: string;
86
+ /**
87
+ * The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity
88
+ * NOTE: This property will not be serialized. It can only be populated by the server.
89
+ */
90
+ readonly tenantId?: string;
91
+ }
92
+ /** Error response. */
93
+ export interface ErrorResponse {
94
+ /** Error description */
95
+ error?: ErrorDefinition;
96
+ }
97
+ /** Error definition. */
98
+ export interface ErrorDefinition {
99
+ /**
100
+ * Service specific error code which serves as the substatus for the HTTP error code.
101
+ * NOTE: This property will not be serialized. It can only be populated by the server.
102
+ */
103
+ readonly code?: string;
104
+ /**
105
+ * Description of the error.
106
+ * NOTE: This property will not be serialized. It can only be populated by the server.
107
+ */
108
+ readonly message?: string;
109
+ /**
110
+ * Internal error details.
111
+ * NOTE: This property will not be serialized. It can only be populated by the server.
112
+ */
113
+ readonly details?: ErrorDefinition[];
114
+ }
115
+ /** The description of the DigitalTwins service. */
116
+ export interface DigitalTwinsPatchDescription {
117
+ /** Instance patch properties */
118
+ tags?: {
119
+ [propertyName: string]: string;
120
+ };
121
+ /** The managed identity for the DigitalTwinsInstance. */
122
+ identity?: DigitalTwinsIdentity;
123
+ /** Properties for the DigitalTwinsInstance. */
124
+ properties?: DigitalTwinsPatchProperties;
125
+ }
126
+ /** The properties of a DigitalTwinsInstance. */
127
+ export interface DigitalTwinsPatchProperties {
128
+ /** Public network access for the DigitalTwinsInstance. */
129
+ publicNetworkAccess?: PublicNetworkAccess;
130
+ }
131
+ /** A list of DigitalTwinsInstance Endpoints with a next link. */
132
+ export interface DigitalTwinsEndpointResourceListResult {
133
+ /** The link used to get the next page of DigitalTwinsInstance Endpoints. */
134
+ nextLink?: string;
135
+ /** A list of DigitalTwinsInstance Endpoints. */
136
+ value?: DigitalTwinsEndpointResource[];
137
+ }
138
+ /** Properties related to Digital Twins Endpoint */
139
+ export interface DigitalTwinsEndpointResourceProperties {
140
+ /** Polymorphic discriminator, which specifies the different types this object can be */
141
+ endpointType: "ServiceBus" | "EventHub" | "EventGrid";
142
+ /**
143
+ * The provisioning state.
144
+ * NOTE: This property will not be serialized. It can only be populated by the server.
145
+ */
146
+ readonly provisioningState?: EndpointProvisioningState;
147
+ /**
148
+ * Time when the Endpoint was added to DigitalTwinsInstance.
149
+ * NOTE: This property will not be serialized. It can only be populated by the server.
150
+ */
151
+ readonly createdTime?: Date;
152
+ /** Specifies the authentication type being used for connecting to the endpoint. */
153
+ authenticationType?: AuthenticationType;
154
+ /** Dead letter storage secret for key-based authentication. Will be obfuscated during read. */
155
+ deadLetterSecret?: string;
156
+ /** Dead letter storage URL for identity-based authentication. */
157
+ deadLetterUri?: string;
158
+ }
159
+ /** Definition of a resource. */
160
+ export interface ExternalResource {
161
+ /**
162
+ * The resource identifier.
163
+ * NOTE: This property will not be serialized. It can only be populated by the server.
164
+ */
165
+ readonly id?: string;
166
+ /**
167
+ * Extension resource name.
168
+ * NOTE: This property will not be serialized. It can only be populated by the server.
169
+ */
170
+ readonly name?: string;
171
+ /**
172
+ * The resource type.
173
+ * NOTE: This property will not be serialized. It can only be populated by the server.
174
+ */
175
+ readonly type?: string;
176
+ }
177
+ /** A list of DigitalTwins description objects with a next link. */
178
+ export interface DigitalTwinsDescriptionListResult {
179
+ /** The link used to get the next page of DigitalTwins description objects. */
180
+ nextLink?: string;
181
+ /** A list of DigitalTwins description objects. */
182
+ value?: DigitalTwinsDescription[];
183
+ }
184
+ /** A list of DigitalTwins service operations. It contains a list of operations and a URL link to get the next set of results. */
185
+ export interface OperationListResult {
186
+ /** The link used to get the next page of DigitalTwins description objects. */
187
+ nextLink?: string;
188
+ /**
189
+ * A list of DigitalTwins operations supported by the Microsoft.DigitalTwins resource provider.
190
+ * NOTE: This property will not be serialized. It can only be populated by the server.
191
+ */
192
+ readonly value?: Operation[];
193
+ }
194
+ /** DigitalTwins service REST API operation */
195
+ export interface Operation {
196
+ /**
197
+ * Operation name: {provider}/{resource}/{read | write | action | delete}
198
+ * NOTE: This property will not be serialized. It can only be populated by the server.
199
+ */
200
+ readonly name?: string;
201
+ /** Operation properties display */
202
+ display?: OperationDisplay;
203
+ /**
204
+ * The intended executor of the operation.
205
+ * NOTE: This property will not be serialized. It can only be populated by the server.
206
+ */
207
+ readonly origin?: string;
208
+ /**
209
+ * If the operation is a data action (for data plane rbac).
210
+ * NOTE: This property will not be serialized. It can only be populated by the server.
211
+ */
212
+ readonly isDataAction?: boolean;
213
+ }
214
+ /** The object that represents the operation. */
215
+ export interface OperationDisplay {
216
+ /**
217
+ * Service provider: Microsoft DigitalTwins
218
+ * NOTE: This property will not be serialized. It can only be populated by the server.
219
+ */
220
+ readonly provider?: string;
221
+ /**
222
+ * Resource Type: DigitalTwinsInstances
223
+ * NOTE: This property will not be serialized. It can only be populated by the server.
224
+ */
225
+ readonly resource?: string;
226
+ /**
227
+ * Name of the operation
228
+ * NOTE: This property will not be serialized. It can only be populated by the server.
229
+ */
230
+ readonly operation?: string;
231
+ /**
232
+ * Friendly description for the operation,
233
+ * NOTE: This property will not be serialized. It can only be populated by the server.
234
+ */
235
+ readonly description?: string;
236
+ }
237
+ /** The result returned from a database check name availability request. */
238
+ export interface CheckNameRequest {
239
+ /** Resource name. */
240
+ name: string;
241
+ /** The type of resource, for instance Microsoft.DigitalTwins/digitalTwinsInstances. */
242
+ type: "Microsoft.DigitalTwins/digitalTwinsInstances";
243
+ }
244
+ /** The result returned from a check name availability request. */
245
+ export interface CheckNameResult {
246
+ /** Specifies a Boolean value that indicates if the name is available. */
247
+ nameAvailable?: boolean;
248
+ /** Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated. */
249
+ message?: string;
250
+ /** Message providing the reason why the given name is invalid. */
251
+ reason?: Reason;
252
+ }
253
+ /** The available private link resources for a Digital Twin. */
254
+ export interface GroupIdInformationResponse {
255
+ /** The list of available private link resources for a Digital Twin. */
256
+ value?: GroupIdInformation[];
257
+ }
258
+ /** The group information for creating a private endpoint on Digital Twin. */
259
+ export interface GroupIdInformation {
260
+ properties: GroupIdInformationProperties;
261
+ /** The resource identifier. */
262
+ id?: string;
263
+ /**
264
+ * The resource name.
265
+ * NOTE: This property will not be serialized. It can only be populated by the server.
266
+ */
267
+ readonly name?: string;
268
+ /**
269
+ * The resource type.
270
+ * NOTE: This property will not be serialized. It can only be populated by the server.
271
+ */
272
+ readonly type?: string;
273
+ }
274
+ /** The properties for a group information object. */
275
+ export interface GroupIdInformationPropertiesAutoGenerated {
276
+ /** The group id */
277
+ groupId?: string;
278
+ /** The required members for a specific group id. */
279
+ requiredMembers?: string[];
280
+ /** The required DNS zones for a specific group id. */
281
+ requiredZoneNames?: string[];
282
+ }
283
+ /** The available private link connections for a Digital Twin. */
284
+ export interface PrivateEndpointConnectionsResponse {
285
+ /** The list of available private link connections for a Digital Twin. */
286
+ value?: PrivateEndpointConnection[];
287
+ }
288
+ export declare type PrivateEndpointConnectionProperties = ConnectionProperties & {};
289
+ export declare type ConnectionPropertiesPrivateEndpoint = PrivateEndpoint & {};
290
+ export declare type ConnectionPropertiesPrivateLinkServiceConnectionState = ConnectionState & {};
291
+ /** The description of the DigitalTwins service. */
292
+ export declare type DigitalTwinsDescription = DigitalTwinsResource & {
293
+ /**
294
+ * Time when DigitalTwinsInstance was created.
295
+ * NOTE: This property will not be serialized. It can only be populated by the server.
296
+ */
297
+ readonly createdTime?: Date;
298
+ /**
299
+ * Time when DigitalTwinsInstance was updated.
300
+ * NOTE: This property will not be serialized. It can only be populated by the server.
301
+ */
302
+ readonly lastUpdatedTime?: Date;
303
+ /**
304
+ * The provisioning state.
305
+ * NOTE: This property will not be serialized. It can only be populated by the server.
306
+ */
307
+ readonly provisioningState?: ProvisioningState;
308
+ /**
309
+ * Api endpoint to work with DigitalTwinsInstance.
310
+ * NOTE: This property will not be serialized. It can only be populated by the server.
311
+ */
312
+ readonly hostName?: string;
313
+ privateEndpointConnections?: PrivateEndpointConnection[];
314
+ /** Public network access for the DigitalTwinsInstance. */
315
+ publicNetworkAccess?: PublicNetworkAccess;
316
+ };
317
+ /** Properties related to ServiceBus. */
318
+ export declare type ServiceBus = DigitalTwinsEndpointResourceProperties & {
319
+ /** Polymorphic discriminator, which specifies the different types this object can be */
320
+ endpointType: "ServiceBus";
321
+ /** PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read. */
322
+ primaryConnectionString?: string;
323
+ /** SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read. */
324
+ secondaryConnectionString?: string;
325
+ /** The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol sb:// */
326
+ endpointUri?: string;
327
+ /** The ServiceBus Topic name for identity-based authentication */
328
+ entityPath?: string;
329
+ };
330
+ /** Properties related to EventHub. */
331
+ export declare type EventHub = DigitalTwinsEndpointResourceProperties & {
332
+ /** Polymorphic discriminator, which specifies the different types this object can be */
333
+ endpointType: "EventHub";
334
+ /** PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read. */
335
+ connectionStringPrimaryKey?: string;
336
+ /** SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read. */
337
+ connectionStringSecondaryKey?: string;
338
+ /** The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb:// */
339
+ endpointUri?: string;
340
+ /** The EventHub name in the EventHub namespace for identity-based authentication. */
341
+ entityPath?: string;
342
+ };
343
+ /** Properties related to EventGrid. */
344
+ export declare type EventGrid = DigitalTwinsEndpointResourceProperties & {
345
+ /** Polymorphic discriminator, which specifies the different types this object can be */
346
+ endpointType: "EventGrid";
347
+ /** EventGrid Topic Endpoint */
348
+ topicEndpoint: string;
349
+ /** EventGrid secondary accesskey. Will be obfuscated during read. */
350
+ accessKey1: string | null;
351
+ /** EventGrid secondary accesskey. Will be obfuscated during read. */
352
+ accessKey2?: string;
353
+ };
354
+ /** DigitalTwinsInstance endpoint resource. */
355
+ export declare type DigitalTwinsEndpointResource = ExternalResource & {
356
+ /** DigitalTwinsInstance endpoint resource properties. */
357
+ properties: DigitalTwinsEndpointResourcePropertiesUnion;
358
+ };
359
+ export declare type GroupIdInformationProperties = GroupIdInformationPropertiesAutoGenerated & {};
360
+ /** Known values of {@link ProvisioningState} that the service accepts. */
361
+ export declare enum KnownProvisioningState {
362
+ Provisioning = "Provisioning",
363
+ Deleting = "Deleting",
364
+ Updating = "Updating",
365
+ Succeeded = "Succeeded",
366
+ Failed = "Failed",
367
+ Canceled = "Canceled",
368
+ Deleted = "Deleted",
369
+ Warning = "Warning",
370
+ Suspending = "Suspending",
371
+ Restoring = "Restoring",
372
+ Moving = "Moving"
373
+ }
374
+ /**
375
+ * Defines values for ProvisioningState. \
376
+ * {@link KnownProvisioningState} can be used interchangeably with ProvisioningState,
377
+ * this enum contains the known values that the service supports.
378
+ * ### Known values supported by the service
379
+ * **Provisioning** \
380
+ * **Deleting** \
381
+ * **Updating** \
382
+ * **Succeeded** \
383
+ * **Failed** \
384
+ * **Canceled** \
385
+ * **Deleted** \
386
+ * **Warning** \
387
+ * **Suspending** \
388
+ * **Restoring** \
389
+ * **Moving**
390
+ */
391
+ export declare type ProvisioningState = string;
392
+ /** Known values of {@link ConnectionPropertiesProvisioningState} that the service accepts. */
393
+ export declare enum KnownConnectionPropertiesProvisioningState {
394
+ Pending = "Pending",
395
+ Approved = "Approved",
396
+ Rejected = "Rejected",
397
+ Disconnected = "Disconnected"
398
+ }
399
+ /**
400
+ * Defines values for ConnectionPropertiesProvisioningState. \
401
+ * {@link KnownConnectionPropertiesProvisioningState} can be used interchangeably with ConnectionPropertiesProvisioningState,
402
+ * this enum contains the known values that the service supports.
403
+ * ### Known values supported by the service
404
+ * **Pending** \
405
+ * **Approved** \
406
+ * **Rejected** \
407
+ * **Disconnected**
408
+ */
409
+ export declare type ConnectionPropertiesProvisioningState = string;
410
+ /** Known values of {@link PrivateLinkServiceConnectionStatus} that the service accepts. */
411
+ export declare enum KnownPrivateLinkServiceConnectionStatus {
412
+ Pending = "Pending",
413
+ Approved = "Approved",
414
+ Rejected = "Rejected",
415
+ Disconnected = "Disconnected"
416
+ }
417
+ /**
418
+ * Defines values for PrivateLinkServiceConnectionStatus. \
419
+ * {@link KnownPrivateLinkServiceConnectionStatus} can be used interchangeably with PrivateLinkServiceConnectionStatus,
420
+ * this enum contains the known values that the service supports.
421
+ * ### Known values supported by the service
422
+ * **Pending** \
423
+ * **Approved** \
424
+ * **Rejected** \
425
+ * **Disconnected**
426
+ */
427
+ export declare type PrivateLinkServiceConnectionStatus = string;
428
+ /** Known values of {@link PublicNetworkAccess} that the service accepts. */
429
+ export declare enum KnownPublicNetworkAccess {
430
+ Enabled = "Enabled",
431
+ Disabled = "Disabled"
432
+ }
433
+ /**
434
+ * Defines values for PublicNetworkAccess. \
435
+ * {@link KnownPublicNetworkAccess} can be used interchangeably with PublicNetworkAccess,
436
+ * this enum contains the known values that the service supports.
437
+ * ### Known values supported by the service
438
+ * **Enabled** \
439
+ * **Disabled**
440
+ */
441
+ export declare type PublicNetworkAccess = string;
442
+ /** Known values of {@link DigitalTwinsIdentityType} that the service accepts. */
443
+ export declare enum KnownDigitalTwinsIdentityType {
444
+ None = "None",
445
+ SystemAssigned = "SystemAssigned"
446
+ }
447
+ /**
448
+ * Defines values for DigitalTwinsIdentityType. \
449
+ * {@link KnownDigitalTwinsIdentityType} can be used interchangeably with DigitalTwinsIdentityType,
450
+ * this enum contains the known values that the service supports.
451
+ * ### Known values supported by the service
452
+ * **None** \
453
+ * **SystemAssigned**
454
+ */
455
+ export declare type DigitalTwinsIdentityType = string;
456
+ /** Known values of {@link EndpointType} that the service accepts. */
457
+ export declare enum KnownEndpointType {
458
+ EventHub = "EventHub",
459
+ EventGrid = "EventGrid",
460
+ ServiceBus = "ServiceBus"
461
+ }
462
+ /**
463
+ * Defines values for EndpointType. \
464
+ * {@link KnownEndpointType} can be used interchangeably with EndpointType,
465
+ * this enum contains the known values that the service supports.
466
+ * ### Known values supported by the service
467
+ * **EventHub** \
468
+ * **EventGrid** \
469
+ * **ServiceBus**
470
+ */
471
+ export declare type EndpointType = string;
472
+ /** Known values of {@link EndpointProvisioningState} that the service accepts. */
473
+ export declare enum KnownEndpointProvisioningState {
474
+ Provisioning = "Provisioning",
475
+ Deleting = "Deleting",
476
+ Succeeded = "Succeeded",
477
+ Failed = "Failed",
478
+ Canceled = "Canceled",
479
+ Deleted = "Deleted",
480
+ Warning = "Warning",
481
+ Suspending = "Suspending",
482
+ Restoring = "Restoring",
483
+ Moving = "Moving",
484
+ Disabled = "Disabled"
485
+ }
486
+ /**
487
+ * Defines values for EndpointProvisioningState. \
488
+ * {@link KnownEndpointProvisioningState} can be used interchangeably with EndpointProvisioningState,
489
+ * this enum contains the known values that the service supports.
490
+ * ### Known values supported by the service
491
+ * **Provisioning** \
492
+ * **Deleting** \
493
+ * **Succeeded** \
494
+ * **Failed** \
495
+ * **Canceled** \
496
+ * **Deleted** \
497
+ * **Warning** \
498
+ * **Suspending** \
499
+ * **Restoring** \
500
+ * **Moving** \
501
+ * **Disabled**
502
+ */
503
+ export declare type EndpointProvisioningState = string;
504
+ /** Known values of {@link AuthenticationType} that the service accepts. */
505
+ export declare enum KnownAuthenticationType {
506
+ KeyBased = "KeyBased",
507
+ IdentityBased = "IdentityBased"
508
+ }
509
+ /**
510
+ * Defines values for AuthenticationType. \
511
+ * {@link KnownAuthenticationType} can be used interchangeably with AuthenticationType,
512
+ * this enum contains the known values that the service supports.
513
+ * ### Known values supported by the service
514
+ * **KeyBased** \
515
+ * **IdentityBased**
516
+ */
517
+ export declare type AuthenticationType = string;
518
+ /** Known values of {@link Reason} that the service accepts. */
519
+ export declare enum KnownReason {
520
+ Invalid = "Invalid",
521
+ AlreadyExists = "AlreadyExists"
522
+ }
523
+ /**
524
+ * Defines values for Reason. \
525
+ * {@link KnownReason} can be used interchangeably with Reason,
526
+ * this enum contains the known values that the service supports.
527
+ * ### Known values supported by the service
528
+ * **Invalid** \
529
+ * **AlreadyExists**
530
+ */
531
+ export declare type Reason = string;
532
+ /** Optional parameters. */
533
+ export interface DigitalTwinsGetOptionalParams extends coreClient.OperationOptions {
534
+ }
535
+ /** Contains response data for the get operation. */
536
+ export declare type DigitalTwinsGetResponse = DigitalTwinsDescription;
537
+ /** Optional parameters. */
538
+ export interface DigitalTwinsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
539
+ /** Delay to wait until next poll, in milliseconds. */
540
+ updateIntervalInMs?: number;
541
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
542
+ resumeFrom?: string;
543
+ }
544
+ /** Contains response data for the createOrUpdate operation. */
545
+ export declare type DigitalTwinsCreateOrUpdateResponse = DigitalTwinsDescription;
546
+ /** Optional parameters. */
547
+ export interface DigitalTwinsUpdateOptionalParams extends coreClient.OperationOptions {
548
+ /** Delay to wait until next poll, in milliseconds. */
549
+ updateIntervalInMs?: number;
550
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
551
+ resumeFrom?: string;
552
+ }
553
+ /** Contains response data for the update operation. */
554
+ export declare type DigitalTwinsUpdateResponse = DigitalTwinsDescription;
555
+ /** Optional parameters. */
556
+ export interface DigitalTwinsDeleteOptionalParams extends coreClient.OperationOptions {
557
+ /** Delay to wait until next poll, in milliseconds. */
558
+ updateIntervalInMs?: number;
559
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
560
+ resumeFrom?: string;
561
+ }
562
+ /** Contains response data for the delete operation. */
563
+ export declare type DigitalTwinsDeleteResponse = DigitalTwinsDescription;
564
+ /** Optional parameters. */
565
+ export interface DigitalTwinsListOptionalParams extends coreClient.OperationOptions {
566
+ }
567
+ /** Contains response data for the list operation. */
568
+ export declare type DigitalTwinsListResponse = DigitalTwinsDescriptionListResult;
569
+ /** Optional parameters. */
570
+ export interface DigitalTwinsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
571
+ }
572
+ /** Contains response data for the listByResourceGroup operation. */
573
+ export declare type DigitalTwinsListByResourceGroupResponse = DigitalTwinsDescriptionListResult;
574
+ /** Optional parameters. */
575
+ export interface DigitalTwinsCheckNameAvailabilityOptionalParams extends coreClient.OperationOptions {
576
+ }
577
+ /** Contains response data for the checkNameAvailability operation. */
578
+ export declare type DigitalTwinsCheckNameAvailabilityResponse = CheckNameResult;
579
+ /** Optional parameters. */
580
+ export interface DigitalTwinsListNextOptionalParams extends coreClient.OperationOptions {
581
+ }
582
+ /** Contains response data for the listNext operation. */
583
+ export declare type DigitalTwinsListNextResponse = DigitalTwinsDescriptionListResult;
584
+ /** Optional parameters. */
585
+ export interface DigitalTwinsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
586
+ }
587
+ /** Contains response data for the listByResourceGroupNext operation. */
588
+ export declare type DigitalTwinsListByResourceGroupNextResponse = DigitalTwinsDescriptionListResult;
589
+ /** Optional parameters. */
590
+ export interface DigitalTwinsEndpointListOptionalParams extends coreClient.OperationOptions {
591
+ }
592
+ /** Contains response data for the list operation. */
593
+ export declare type DigitalTwinsEndpointListResponse = DigitalTwinsEndpointResourceListResult;
594
+ /** Optional parameters. */
595
+ export interface DigitalTwinsEndpointGetOptionalParams extends coreClient.OperationOptions {
596
+ }
597
+ /** Contains response data for the get operation. */
598
+ export declare type DigitalTwinsEndpointGetResponse = DigitalTwinsEndpointResource;
599
+ /** Optional parameters. */
600
+ export interface DigitalTwinsEndpointCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
601
+ /** Delay to wait until next poll, in milliseconds. */
602
+ updateIntervalInMs?: number;
603
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
604
+ resumeFrom?: string;
605
+ }
606
+ /** Contains response data for the createOrUpdate operation. */
607
+ export declare type DigitalTwinsEndpointCreateOrUpdateResponse = DigitalTwinsEndpointResource;
608
+ /** Optional parameters. */
609
+ export interface DigitalTwinsEndpointDeleteOptionalParams extends coreClient.OperationOptions {
610
+ /** Delay to wait until next poll, in milliseconds. */
611
+ updateIntervalInMs?: number;
612
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
613
+ resumeFrom?: string;
614
+ }
615
+ /** Contains response data for the delete operation. */
616
+ export declare type DigitalTwinsEndpointDeleteResponse = DigitalTwinsEndpointResource;
617
+ /** Optional parameters. */
618
+ export interface DigitalTwinsEndpointListNextOptionalParams extends coreClient.OperationOptions {
619
+ }
620
+ /** Contains response data for the listNext operation. */
621
+ export declare type DigitalTwinsEndpointListNextResponse = DigitalTwinsEndpointResourceListResult;
622
+ /** Optional parameters. */
623
+ export interface OperationsListOptionalParams extends coreClient.OperationOptions {
624
+ }
625
+ /** Contains response data for the list operation. */
626
+ export declare type OperationsListResponse = OperationListResult;
627
+ /** Optional parameters. */
628
+ export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
629
+ }
630
+ /** Contains response data for the listNext operation. */
631
+ export declare type OperationsListNextResponse = OperationListResult;
632
+ /** Optional parameters. */
633
+ export interface PrivateLinkResourcesListOptionalParams extends coreClient.OperationOptions {
634
+ }
635
+ /** Contains response data for the list operation. */
636
+ export declare type PrivateLinkResourcesListResponse = GroupIdInformationResponse;
637
+ /** Optional parameters. */
638
+ export interface PrivateLinkResourcesGetOptionalParams extends coreClient.OperationOptions {
639
+ }
640
+ /** Contains response data for the get operation. */
641
+ export declare type PrivateLinkResourcesGetResponse = GroupIdInformation;
642
+ /** Optional parameters. */
643
+ export interface PrivateEndpointConnectionsListOptionalParams extends coreClient.OperationOptions {
644
+ }
645
+ /** Contains response data for the list operation. */
646
+ export declare type PrivateEndpointConnectionsListResponse = PrivateEndpointConnectionsResponse;
647
+ /** Optional parameters. */
648
+ export interface PrivateEndpointConnectionsGetOptionalParams extends coreClient.OperationOptions {
649
+ }
650
+ /** Contains response data for the get operation. */
651
+ export declare type PrivateEndpointConnectionsGetResponse = PrivateEndpointConnection;
652
+ /** Optional parameters. */
653
+ export interface PrivateEndpointConnectionsDeleteOptionalParams extends coreClient.OperationOptions {
654
+ /** Delay to wait until next poll, in milliseconds. */
655
+ updateIntervalInMs?: number;
656
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
657
+ resumeFrom?: string;
658
+ }
659
+ /** Optional parameters. */
660
+ export interface PrivateEndpointConnectionsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
661
+ /** Delay to wait until next poll, in milliseconds. */
662
+ updateIntervalInMs?: number;
663
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
664
+ resumeFrom?: string;
665
+ }
666
+ /** Contains response data for the createOrUpdate operation. */
667
+ export declare type PrivateEndpointConnectionsCreateOrUpdateResponse = PrivateEndpointConnection;
668
+ /** Optional parameters. */
669
+ export interface AzureDigitalTwinsManagementClientOptionalParams extends coreClient.ServiceClientOptions {
670
+ /** server parameter */
671
+ $host?: string;
672
+ /** Api Version */
673
+ apiVersion?: string;
674
+ /** Overrides client endpoint. */
675
+ endpoint?: string;
676
+ }
677
+ //# sourceMappingURL=index.d.ts.map