@azure/arm-digitaltwins 1.0.0 → 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 (162) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/LICENSE +21 -0
  3. package/LICENSE.txt +1 -1
  4. package/README.md +72 -77
  5. package/dist/index.js +2613 -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/azureDigitalTwinsManagementClient.d.ts +22 -0
  10. package/dist-esm/src/azureDigitalTwinsManagementClient.d.ts.map +1 -0
  11. package/dist-esm/src/azureDigitalTwinsManagementClient.js +55 -0
  12. package/dist-esm/src/azureDigitalTwinsManagementClient.js.map +1 -0
  13. package/dist-esm/src/index.d.ts +5 -0
  14. package/dist-esm/src/index.d.ts.map +1 -0
  15. package/dist-esm/src/index.js +12 -0
  16. package/dist-esm/src/index.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 +677 -0
  22. package/dist-esm/src/models/index.d.ts.map +1 -0
  23. package/dist-esm/src/models/index.js +85 -0
  24. package/dist-esm/src/models/index.js.map +1 -0
  25. package/dist-esm/src/models/mappers.d.ts +40 -0
  26. package/dist-esm/src/models/mappers.d.ts.map +1 -0
  27. package/{esm → dist-esm/src}/models/mappers.js +609 -256
  28. package/dist-esm/src/models/mappers.js.map +1 -0
  29. package/dist-esm/src/models/parameters.d.ts +19 -0
  30. package/dist-esm/src/models/parameters.d.ts.map +1 -0
  31. package/dist-esm/src/models/parameters.js +171 -0
  32. package/dist-esm/src/models/parameters.js.map +1 -0
  33. package/dist-esm/src/operations/digitalTwins.d.ts +119 -0
  34. package/dist-esm/src/operations/digitalTwins.d.ts.map +1 -0
  35. package/dist-esm/src/operations/digitalTwins.js +549 -0
  36. package/dist-esm/src/operations/digitalTwins.js.map +1 -0
  37. package/dist-esm/src/operations/digitalTwinsEndpoint.d.ts +81 -0
  38. package/dist-esm/src/operations/digitalTwinsEndpoint.d.ts.map +1 -0
  39. package/dist-esm/src/operations/digitalTwinsEndpoint.js +345 -0
  40. package/dist-esm/src/operations/digitalTwinsEndpoint.js.map +1 -0
  41. package/dist-esm/src/operations/index.d.ts +6 -0
  42. package/dist-esm/src/operations/index.d.ts.map +1 -0
  43. package/{esm → dist-esm/src}/operations/index.js +5 -5
  44. package/dist-esm/src/operations/index.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/operations/privateEndpointConnections.d.ts +63 -0
  50. package/dist-esm/src/operations/privateEndpointConnections.d.ts.map +1 -0
  51. package/dist-esm/src/operations/privateEndpointConnections.js +264 -0
  52. package/dist-esm/src/operations/privateEndpointConnections.js.map +1 -0
  53. package/dist-esm/src/operations/privateLinkResources.d.ts +28 -0
  54. package/dist-esm/src/operations/privateLinkResources.d.ts.map +1 -0
  55. package/dist-esm/src/operations/privateLinkResources.js +85 -0
  56. package/dist-esm/src/operations/privateLinkResources.js.map +1 -0
  57. package/dist-esm/src/operationsInterfaces/digitalTwins.d.ts +83 -0
  58. package/dist-esm/src/operationsInterfaces/digitalTwins.d.ts.map +1 -0
  59. package/dist-esm/src/operationsInterfaces/digitalTwins.js +9 -0
  60. package/dist-esm/src/operationsInterfaces/digitalTwins.js.map +1 -0
  61. package/dist-esm/src/operationsInterfaces/digitalTwinsEndpoint.d.ts +56 -0
  62. package/dist-esm/src/operationsInterfaces/digitalTwinsEndpoint.d.ts.map +1 -0
  63. package/dist-esm/src/operationsInterfaces/digitalTwinsEndpoint.js +9 -0
  64. package/dist-esm/src/operationsInterfaces/digitalTwinsEndpoint.js.map +1 -0
  65. package/dist-esm/src/operationsInterfaces/index.d.ts +6 -0
  66. package/dist-esm/src/operationsInterfaces/index.d.ts.map +1 -0
  67. package/dist-esm/src/operationsInterfaces/index.js +13 -0
  68. package/dist-esm/src/operationsInterfaces/index.js.map +1 -0
  69. package/dist-esm/src/operationsInterfaces/operations.d.ts +11 -0
  70. package/dist-esm/src/operationsInterfaces/operations.d.ts.map +1 -0
  71. package/dist-esm/src/operationsInterfaces/operations.js +9 -0
  72. package/dist-esm/src/operationsInterfaces/operations.js.map +1 -0
  73. package/dist-esm/src/operationsInterfaces/privateEndpointConnections.d.ts +55 -0
  74. package/dist-esm/src/operationsInterfaces/privateEndpointConnections.d.ts.map +1 -0
  75. package/dist-esm/src/operationsInterfaces/privateEndpointConnections.js +9 -0
  76. package/dist-esm/src/operationsInterfaces/privateEndpointConnections.js.map +1 -0
  77. package/dist-esm/src/operationsInterfaces/privateLinkResources.d.ts +20 -0
  78. package/dist-esm/src/operationsInterfaces/privateLinkResources.d.ts.map +1 -0
  79. package/dist-esm/src/operationsInterfaces/privateLinkResources.js +9 -0
  80. package/dist-esm/src/operationsInterfaces/privateLinkResources.js.map +1 -0
  81. package/dist-esm/test/sampleTest.d.ts +2 -0
  82. package/dist-esm/test/sampleTest.d.ts.map +1 -0
  83. package/dist-esm/test/sampleTest.js +40 -0
  84. package/dist-esm/test/sampleTest.js.map +1 -0
  85. package/package.json +65 -31
  86. package/review/arm-digitaltwins.api.md +620 -0
  87. package/rollup.config.js +181 -30
  88. package/src/azureDigitalTwinsManagementClient.ts +82 -33
  89. package/src/index.ts +12 -0
  90. package/src/lroImpl.ts +34 -0
  91. package/src/models/index.ts +587 -684
  92. package/src/models/mappers.ts +638 -255
  93. package/src/models/parameters.ts +128 -44
  94. package/src/operations/digitalTwins.ts +557 -367
  95. package/src/operations/digitalTwinsEndpoint.ts +340 -192
  96. package/src/operations/index.ts +5 -5
  97. package/src/operations/operations.ts +87 -73
  98. package/src/operations/privateEndpointConnections.ts +377 -0
  99. package/src/operations/privateLinkResources.ts +116 -0
  100. package/src/operationsInterfaces/digitalTwins.ts +164 -0
  101. package/src/operationsInterfaces/digitalTwinsEndpoint.ts +115 -0
  102. package/src/operationsInterfaces/index.ts +13 -0
  103. package/src/operationsInterfaces/operations.ts +22 -0
  104. package/src/operationsInterfaces/privateEndpointConnections.ts +108 -0
  105. package/src/operationsInterfaces/privateLinkResources.ts +42 -0
  106. package/tsconfig.json +3 -3
  107. package/types/arm-digitaltwins.d.ts +1009 -0
  108. package/types/tsdoc-metadata.json +11 -0
  109. package/dist/arm-digitaltwins.js +0 -1601
  110. package/dist/arm-digitaltwins.js.map +0 -1
  111. package/dist/arm-digitaltwins.min.js +0 -1
  112. package/dist/arm-digitaltwins.min.js.map +0 -1
  113. package/esm/azureDigitalTwinsManagementClient.d.ts +0 -20
  114. package/esm/azureDigitalTwinsManagementClient.d.ts.map +0 -1
  115. package/esm/azureDigitalTwinsManagementClient.js +0 -35
  116. package/esm/azureDigitalTwinsManagementClient.js.map +0 -1
  117. package/esm/azureDigitalTwinsManagementClientContext.d.ts +0 -16
  118. package/esm/azureDigitalTwinsManagementClientContext.d.ts.map +0 -1
  119. package/esm/azureDigitalTwinsManagementClientContext.js +0 -56
  120. package/esm/azureDigitalTwinsManagementClientContext.js.map +0 -1
  121. package/esm/models/digitalTwinsEndpointMappers.d.ts +0 -2
  122. package/esm/models/digitalTwinsEndpointMappers.d.ts.map +0 -1
  123. package/esm/models/digitalTwinsEndpointMappers.js +0 -9
  124. package/esm/models/digitalTwinsEndpointMappers.js.map +0 -1
  125. package/esm/models/digitalTwinsMappers.d.ts +0 -2
  126. package/esm/models/digitalTwinsMappers.d.ts.map +0 -1
  127. package/esm/models/digitalTwinsMappers.js +0 -9
  128. package/esm/models/digitalTwinsMappers.js.map +0 -1
  129. package/esm/models/index.d.ts +0 -815
  130. package/esm/models/index.d.ts.map +0 -1
  131. package/esm/models/index.js +0 -8
  132. package/esm/models/index.js.map +0 -1
  133. package/esm/models/mappers.d.ts +0 -28
  134. package/esm/models/mappers.d.ts.map +0 -1
  135. package/esm/models/mappers.js.map +0 -1
  136. package/esm/models/operationsMappers.d.ts +0 -2
  137. package/esm/models/operationsMappers.d.ts.map +0 -1
  138. package/esm/models/operationsMappers.js +0 -9
  139. package/esm/models/operationsMappers.js.map +0 -1
  140. package/esm/models/parameters.d.ts +0 -10
  141. package/esm/models/parameters.d.ts.map +0 -1
  142. package/esm/models/parameters.js +0 -113
  143. package/esm/models/parameters.js.map +0 -1
  144. package/esm/operations/digitalTwins.d.ts +0 -179
  145. package/esm/operations/digitalTwins.d.ts.map +0 -1
  146. package/esm/operations/digitalTwins.js +0 -377
  147. package/esm/operations/digitalTwins.js.map +0 -1
  148. package/esm/operations/digitalTwinsEndpoint.d.ts +0 -113
  149. package/esm/operations/digitalTwinsEndpoint.d.ts.map +0 -1
  150. package/esm/operations/digitalTwinsEndpoint.js +0 -240
  151. package/esm/operations/digitalTwinsEndpoint.js.map +0 -1
  152. package/esm/operations/index.d.ts +0 -4
  153. package/esm/operations/index.d.ts.map +0 -1
  154. package/esm/operations/index.js.map +0 -1
  155. package/esm/operations/operations.d.ts +0 -46
  156. package/esm/operations/operations.d.ts.map +0 -1
  157. package/esm/operations/operations.js +0 -77
  158. package/esm/operations/operations.js.map +0 -1
  159. package/src/azureDigitalTwinsManagementClientContext.ts +0 -62
  160. package/src/models/digitalTwinsEndpointMappers.ts +0 -23
  161. package/src/models/digitalTwinsMappers.ts +0 -26
  162. package/src/models/operationsMappers.ts +0 -16
@@ -1,884 +1,787 @@
1
1
  /*
2
- * Copyright (c) Microsoft Corporation. All rights reserved.
3
- * Licensed under the MIT License. See License.txt in the project root for license information.
2
+ * Copyright (c) Microsoft Corporation.
3
+ * Licensed under the MIT License.
4
4
  *
5
5
  * Code generated by Microsoft (R) AutoRest Code Generator.
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 };
11
+ export type DigitalTwinsEndpointResourcePropertiesUnion =
12
+ | DigitalTwinsEndpointResourceProperties
13
+ | ServiceBus
14
+ | EventHub
15
+ | EventGrid;
13
16
 
14
- /**
15
- * The common properties of a DigitalTwinsInstance.
16
- */
17
- export interface DigitalTwinsResource extends BaseResource {
17
+ /** The private endpoint connection of a Digital Twin. */
18
+ export interface PrivateEndpointConnection {
18
19
  /**
19
20
  * The resource identifier.
20
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
21
+ * NOTE: This property will not be serialized. It can only be populated by the server.
21
22
  */
22
23
  readonly id?: string;
23
24
  /**
24
25
  * The resource name.
25
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
26
+ * NOTE: This property will not be serialized. It can only be populated by the server.
26
27
  */
27
28
  readonly name?: string;
28
29
  /**
29
30
  * The resource type.
30
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
31
+ * NOTE: This property will not be serialized. It can only be populated by the server.
31
32
  */
32
33
  readonly type?: string;
34
+ properties: PrivateEndpointConnectionProperties;
35
+ }
36
+
37
+ /** The properties of a private endpoint connection. */
38
+ export interface ConnectionProperties {
33
39
  /**
34
- * The resource location.
35
- */
36
- location: string;
37
- /**
38
- * The resource tags.
40
+ * The provisioning state.
41
+ * NOTE: This property will not be serialized. It can only be populated by the server.
39
42
  */
40
- tags?: { [propertyName: string]: string };
43
+ readonly provisioningState?: ConnectionPropertiesProvisioningState;
44
+ privateEndpoint?: ConnectionPropertiesPrivateEndpoint;
45
+ /** The list of group ids for the private endpoint connection. */
46
+ groupIds?: string[];
47
+ privateLinkServiceConnectionState?: ConnectionPropertiesPrivateLinkServiceConnectionState;
41
48
  }
42
49
 
43
- /**
44
- * The description of the DigitalTwins service.
45
- */
46
- export interface DigitalTwinsDescription extends DigitalTwinsResource {
50
+ /** The private endpoint property of a private endpoint connection. */
51
+ export interface PrivateEndpoint {
47
52
  /**
48
- * Time when DigitalTwinsInstance was created.
49
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
53
+ * The resource identifier.
54
+ * NOTE: This property will not be serialized. It can only be populated by the server.
50
55
  */
51
- readonly createdTime?: Date;
56
+ readonly id?: string;
57
+ }
58
+
59
+ /** The current state of a private endpoint connection. */
60
+ export interface ConnectionState {
61
+ /** The status of a private endpoint connection. */
62
+ status: PrivateLinkServiceConnectionStatus;
63
+ /** The description for the current state of a private endpoint connection. */
64
+ description: string;
65
+ /** Actions required for a private endpoint connection. */
66
+ actionsRequired?: string;
67
+ }
68
+
69
+ /** The common properties of a DigitalTwinsInstance. */
70
+ export interface DigitalTwinsResource {
52
71
  /**
53
- * Time when DigitalTwinsInstance was updated.
54
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
72
+ * The resource identifier.
73
+ * NOTE: This property will not be serialized. It can only be populated by the server.
55
74
  */
56
- readonly lastUpdatedTime?: Date;
75
+ readonly id?: string;
57
76
  /**
58
- * The provisioning state. Possible values include: 'Provisioning', 'Deleting', 'Succeeded',
59
- * 'Failed', 'Canceled', 'Deleted', 'Warning', 'Suspending', 'Restoring', 'Moving'
60
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
77
+ * The resource name.
78
+ * NOTE: This property will not be serialized. It can only be populated by the server.
61
79
  */
62
- readonly provisioningState?: ProvisioningState;
80
+ readonly name?: string;
63
81
  /**
64
- * Api endpoint to work with DigitalTwinsInstance.
65
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
82
+ * The resource type.
83
+ * NOTE: This property will not be serialized. It can only be populated by the server.
66
84
  */
67
- readonly hostName?: string;
85
+ readonly type?: string;
86
+ /** The resource location. */
87
+ location: string;
88
+ /** The resource tags. */
89
+ tags?: { [propertyName: string]: string };
90
+ /** The managed identity for the DigitalTwinsInstance. */
91
+ identity?: DigitalTwinsIdentity;
68
92
  }
69
93
 
70
- /**
71
- * The description of the DigitalTwins service.
72
- */
73
- export interface DigitalTwinsPatchDescription {
94
+ /** The managed identity for the DigitalTwinsInstance. */
95
+ export interface DigitalTwinsIdentity {
96
+ /** The type of Managed Identity used by the DigitalTwinsInstance. Only SystemAssigned is supported. */
97
+ type?: DigitalTwinsIdentityType;
74
98
  /**
75
- * Instance tags
99
+ * 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
100
+ * NOTE: This property will not be serialized. It can only be populated by the server.
76
101
  */
77
- tags?: { [propertyName: string]: string };
102
+ readonly principalId?: string;
103
+ /**
104
+ * 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
105
+ * NOTE: This property will not be serialized. It can only be populated by the server.
106
+ */
107
+ readonly tenantId?: string;
78
108
  }
79
109
 
80
- /**
81
- * Error definition.
82
- */
110
+ /** Error response. */
111
+ export interface ErrorResponse {
112
+ /** Error description */
113
+ error?: ErrorDefinition;
114
+ }
115
+
116
+ /** Error definition. */
83
117
  export interface ErrorDefinition {
84
118
  /**
85
119
  * Service specific error code which serves as the substatus for the HTTP error code.
86
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
120
+ * NOTE: This property will not be serialized. It can only be populated by the server.
87
121
  */
88
122
  readonly code?: string;
89
123
  /**
90
124
  * Description of the error.
91
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
125
+ * NOTE: This property will not be serialized. It can only be populated by the server.
92
126
  */
93
127
  readonly message?: string;
94
128
  /**
95
129
  * Internal error details.
96
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
130
+ * NOTE: This property will not be serialized. It can only be populated by the server.
97
131
  */
98
132
  readonly details?: ErrorDefinition[];
99
133
  }
100
134
 
101
- /**
102
- * Error response.
103
- */
104
- export interface ErrorResponse {
135
+ /** The description of the DigitalTwins service. */
136
+ export interface DigitalTwinsPatchDescription {
137
+ /** Instance patch properties */
138
+ tags?: { [propertyName: string]: string };
139
+ /** The managed identity for the DigitalTwinsInstance. */
140
+ identity?: DigitalTwinsIdentity;
141
+ /** Properties for the DigitalTwinsInstance. */
142
+ properties?: DigitalTwinsPatchProperties;
143
+ }
144
+
145
+ /** The properties of a DigitalTwinsInstance. */
146
+ export interface DigitalTwinsPatchProperties {
147
+ /** Public network access for the DigitalTwinsInstance. */
148
+ publicNetworkAccess?: PublicNetworkAccess;
149
+ }
150
+
151
+ /** A list of DigitalTwinsInstance Endpoints with a next link. */
152
+ export interface DigitalTwinsEndpointResourceListResult {
153
+ /** The link used to get the next page of DigitalTwinsInstance Endpoints. */
154
+ nextLink?: string;
155
+ /** A list of DigitalTwinsInstance Endpoints. */
156
+ value?: DigitalTwinsEndpointResource[];
157
+ }
158
+
159
+ /** Properties related to Digital Twins Endpoint */
160
+ export interface DigitalTwinsEndpointResourceProperties {
161
+ /** Polymorphic discriminator, which specifies the different types this object can be */
162
+ endpointType: "ServiceBus" | "EventHub" | "EventGrid";
105
163
  /**
106
- * Error description
164
+ * The provisioning state.
165
+ * NOTE: This property will not be serialized. It can only be populated by the server.
107
166
  */
108
- error?: ErrorDefinition;
167
+ readonly provisioningState?: EndpointProvisioningState;
168
+ /**
169
+ * Time when the Endpoint was added to DigitalTwinsInstance.
170
+ * NOTE: This property will not be serialized. It can only be populated by the server.
171
+ */
172
+ readonly createdTime?: Date;
173
+ /** Specifies the authentication type being used for connecting to the endpoint. */
174
+ authenticationType?: AuthenticationType;
175
+ /** Dead letter storage secret for key-based authentication. Will be obfuscated during read. */
176
+ deadLetterSecret?: string;
177
+ /** Dead letter storage URL for identity-based authentication. */
178
+ deadLetterUri?: string;
109
179
  }
110
180
 
111
- /**
112
- * The object that represents the operation.
113
- */
114
- export interface OperationDisplay {
181
+ /** Definition of a resource. */
182
+ export interface ExternalResource {
115
183
  /**
116
- * Service provider: Microsoft DigitalTwins
117
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
184
+ * The resource identifier.
185
+ * NOTE: This property will not be serialized. It can only be populated by the server.
118
186
  */
119
- readonly provider?: string;
187
+ readonly id?: string;
120
188
  /**
121
- * Resource Type: DigitalTwinsInstances
122
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
189
+ * Extension resource name.
190
+ * NOTE: This property will not be serialized. It can only be populated by the server.
123
191
  */
124
- readonly resource?: string;
192
+ readonly name?: string;
125
193
  /**
126
- * Name of the operation
127
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
194
+ * The resource type.
195
+ * NOTE: This property will not be serialized. It can only be populated by the server.
128
196
  */
129
- readonly operation?: string;
197
+ readonly type?: string;
198
+ }
199
+
200
+ /** A list of DigitalTwins description objects with a next link. */
201
+ export interface DigitalTwinsDescriptionListResult {
202
+ /** The link used to get the next page of DigitalTwins description objects. */
203
+ nextLink?: string;
204
+ /** A list of DigitalTwins description objects. */
205
+ value?: DigitalTwinsDescription[];
206
+ }
207
+
208
+ /** A list of DigitalTwins service operations. It contains a list of operations and a URL link to get the next set of results. */
209
+ export interface OperationListResult {
210
+ /** The link used to get the next page of DigitalTwins description objects. */
211
+ nextLink?: string;
130
212
  /**
131
- * Friendly description for the operation,
132
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
213
+ * A list of DigitalTwins operations supported by the Microsoft.DigitalTwins resource provider.
214
+ * NOTE: This property will not be serialized. It can only be populated by the server.
133
215
  */
134
- readonly description?: string;
216
+ readonly value?: Operation[];
135
217
  }
136
218
 
137
- /**
138
- * DigitalTwins service REST API operation
139
- */
219
+ /** DigitalTwins service REST API operation */
140
220
  export interface Operation {
141
221
  /**
142
222
  * Operation name: {provider}/{resource}/{read | write | action | delete}
143
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
223
+ * NOTE: This property will not be serialized. It can only be populated by the server.
144
224
  */
145
225
  readonly name?: string;
146
- /**
147
- * Operation properties display
148
- */
226
+ /** Operation properties display */
149
227
  display?: OperationDisplay;
150
228
  /**
151
229
  * The intended executor of the operation.
152
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
230
+ * NOTE: This property will not be serialized. It can only be populated by the server.
153
231
  */
154
232
  readonly origin?: string;
155
233
  /**
156
234
  * If the operation is a data action (for data plane rbac).
157
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
235
+ * NOTE: This property will not be serialized. It can only be populated by the server.
158
236
  */
159
237
  readonly isDataAction?: boolean;
160
238
  }
161
239
 
162
- /**
163
- * The result returned from a database check name availability request.
164
- */
165
- export interface CheckNameRequest {
240
+ /** The object that represents the operation. */
241
+ export interface OperationDisplay {
166
242
  /**
167
- * Resource name.
243
+ * Service provider: Microsoft DigitalTwins
244
+ * NOTE: This property will not be serialized. It can only be populated by the server.
168
245
  */
169
- name: string;
170
- }
171
-
172
- /**
173
- * The result returned from a check name availability request.
174
- */
175
- export interface CheckNameResult {
246
+ readonly provider?: string;
176
247
  /**
177
- * Specifies a Boolean value that indicates if the name is available.
248
+ * Resource Type: DigitalTwinsInstances
249
+ * NOTE: This property will not be serialized. It can only be populated by the server.
178
250
  */
179
- nameAvailable?: boolean;
251
+ readonly resource?: string;
180
252
  /**
181
- * Message indicating an unavailable name due to a conflict, or a description of the naming rules
182
- * that are violated.
253
+ * Name of the operation
254
+ * NOTE: This property will not be serialized. It can only be populated by the server.
183
255
  */
184
- message?: string;
256
+ readonly operation?: string;
185
257
  /**
186
- * Message providing the reason why the given name is invalid. Possible values include:
187
- * 'Invalid', 'AlreadyExists'
258
+ * Friendly description for the operation,
259
+ * NOTE: This property will not be serialized. It can only be populated by the server.
188
260
  */
261
+ readonly description?: string;
262
+ }
263
+
264
+ /** The result returned from a database check name availability request. */
265
+ export interface CheckNameRequest {
266
+ /** Resource name. */
267
+ name: string;
268
+ /** The type of resource, for instance Microsoft.DigitalTwins/digitalTwinsInstances. */
269
+ type: "Microsoft.DigitalTwins/digitalTwinsInstances";
270
+ }
271
+
272
+ /** The result returned from a check name availability request. */
273
+ export interface CheckNameResult {
274
+ /** Specifies a Boolean value that indicates if the name is available. */
275
+ nameAvailable?: boolean;
276
+ /** Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated. */
277
+ message?: string;
278
+ /** Message providing the reason why the given name is invalid. */
189
279
  reason?: Reason;
190
280
  }
191
281
 
192
- /**
193
- * Definition of a resource.
194
- */
195
- export interface ExternalResource extends BaseResource {
196
- /**
197
- * The resource identifier.
198
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
199
- */
200
- readonly id?: string;
282
+ /** The available private link resources for a Digital Twin. */
283
+ export interface GroupIdInformationResponse {
284
+ /** The list of available private link resources for a Digital Twin. */
285
+ value?: GroupIdInformation[];
286
+ }
287
+
288
+ /** The group information for creating a private endpoint on Digital Twin. */
289
+ export interface GroupIdInformation {
290
+ properties: GroupIdInformationProperties;
291
+ /** The resource identifier. */
292
+ id?: string;
201
293
  /**
202
- * Extension resource name.
203
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
294
+ * The resource name.
295
+ * NOTE: This property will not be serialized. It can only be populated by the server.
204
296
  */
205
297
  readonly name?: string;
206
298
  /**
207
299
  * The resource type.
208
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
300
+ * NOTE: This property will not be serialized. It can only be populated by the server.
209
301
  */
210
302
  readonly type?: string;
211
303
  }
212
304
 
213
- /**
214
- * Contains the possible cases for DigitalTwinsEndpointResourceProperties.
215
- */
216
- export type DigitalTwinsEndpointResourcePropertiesUnion = DigitalTwinsEndpointResourceProperties | ServiceBus | EventHub | EventGrid;
217
-
218
- /**
219
- * Properties related to Digital Twins Endpoint
220
- */
221
- export interface DigitalTwinsEndpointResourceProperties {
222
- /**
223
- * Polymorphic Discriminator
224
- */
225
- endpointType: "DigitalTwinsEndpointResourceProperties";
226
- /**
227
- * The provisioning state. Possible values include: 'Provisioning', 'Deleting', 'Succeeded',
228
- * 'Failed', 'Canceled', 'Deleted', 'Warning', 'Suspending', 'Restoring', 'Moving', 'Disabled'
229
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
230
- */
231
- readonly provisioningState?: EndpointProvisioningState;
232
- /**
233
- * Time when the Endpoint was added to DigitalTwinsInstance.
234
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
235
- */
236
- readonly createdTime?: Date;
237
- /**
238
- * Dead letter storage secret. Will be obfuscated during read.
239
- */
240
- deadLetterSecret?: string;
305
+ /** The properties for a group information object. */
306
+ export interface GroupIdInformationPropertiesAutoGenerated {
307
+ /** The group id */
308
+ groupId?: string;
309
+ /** The required members for a specific group id. */
310
+ requiredMembers?: string[];
311
+ /** The required DNS zones for a specific group id. */
312
+ requiredZoneNames?: string[];
241
313
  }
242
314
 
243
- /**
244
- * DigitalTwinsInstance endpoint resource.
245
- */
246
- export interface DigitalTwinsEndpointResource extends ExternalResource {
247
- /**
248
- * DigitalTwinsInstance endpoint resource properties.
249
- */
250
- properties?: DigitalTwinsEndpointResourcePropertiesUnion;
315
+ /** The available private link connections for a Digital Twin. */
316
+ export interface PrivateEndpointConnectionsResponse {
317
+ /** The list of available private link connections for a Digital Twin. */
318
+ value?: PrivateEndpointConnection[];
251
319
  }
252
320
 
253
- /**
254
- * Properties related to ServiceBus.
255
- */
256
- export interface ServiceBus {
257
- /**
258
- * Polymorphic Discriminator
259
- */
260
- endpointType: "ServiceBus";
261
- /**
262
- * The provisioning state. Possible values include: 'Provisioning', 'Deleting', 'Succeeded',
263
- * 'Failed', 'Canceled', 'Deleted', 'Warning', 'Suspending', 'Restoring', 'Moving', 'Disabled'
264
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
265
- */
266
- readonly provisioningState?: EndpointProvisioningState;
321
+ export type PrivateEndpointConnectionProperties = ConnectionProperties & {};
322
+
323
+ export type ConnectionPropertiesPrivateEndpoint = PrivateEndpoint & {};
324
+
325
+ export type ConnectionPropertiesPrivateLinkServiceConnectionState = ConnectionState & {};
326
+
327
+ /** The description of the DigitalTwins service. */
328
+ export type DigitalTwinsDescription = DigitalTwinsResource & {
267
329
  /**
268
- * Time when the Endpoint was added to DigitalTwinsInstance.
269
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
330
+ * Time when DigitalTwinsInstance was created.
331
+ * NOTE: This property will not be serialized. It can only be populated by the server.
270
332
  */
271
333
  readonly createdTime?: Date;
272
334
  /**
273
- * Dead letter storage secret. Will be obfuscated during read.
335
+ * Time when DigitalTwinsInstance was updated.
336
+ * NOTE: This property will not be serialized. It can only be populated by the server.
274
337
  */
275
- deadLetterSecret?: string;
338
+ readonly lastUpdatedTime?: Date;
276
339
  /**
277
- * PrimaryConnectionString of the endpoint. Will be obfuscated during read.
340
+ * The provisioning state.
341
+ * NOTE: This property will not be serialized. It can only be populated by the server.
278
342
  */
279
- primaryConnectionString: string;
343
+ readonly provisioningState?: ProvisioningState;
280
344
  /**
281
- * SecondaryConnectionString of the endpoint. Will be obfuscated during read.
345
+ * Api endpoint to work with DigitalTwinsInstance.
346
+ * NOTE: This property will not be serialized. It can only be populated by the server.
282
347
  */
348
+ readonly hostName?: string;
349
+ privateEndpointConnections?: PrivateEndpointConnection[];
350
+ /** Public network access for the DigitalTwinsInstance. */
351
+ publicNetworkAccess?: PublicNetworkAccess;
352
+ };
353
+
354
+ /** Properties related to ServiceBus. */
355
+ export type ServiceBus = DigitalTwinsEndpointResourceProperties & {
356
+ /** Polymorphic discriminator, which specifies the different types this object can be */
357
+ endpointType: "ServiceBus";
358
+ /** PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read. */
359
+ primaryConnectionString?: string;
360
+ /** SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read. */
283
361
  secondaryConnectionString?: string;
284
- }
362
+ /** The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol sb:// */
363
+ endpointUri?: string;
364
+ /** The ServiceBus Topic name for identity-based authentication */
365
+ entityPath?: string;
366
+ };
285
367
 
286
- /**
287
- * Properties related to EventHub.
288
- */
289
- export interface EventHub {
290
- /**
291
- * Polymorphic Discriminator
292
- */
368
+ /** Properties related to EventHub. */
369
+ export type EventHub = DigitalTwinsEndpointResourceProperties & {
370
+ /** Polymorphic discriminator, which specifies the different types this object can be */
293
371
  endpointType: "EventHub";
294
- /**
295
- * The provisioning state. Possible values include: 'Provisioning', 'Deleting', 'Succeeded',
296
- * 'Failed', 'Canceled', 'Deleted', 'Warning', 'Suspending', 'Restoring', 'Moving', 'Disabled'
297
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
298
- */
299
- readonly provisioningState?: EndpointProvisioningState;
300
- /**
301
- * Time when the Endpoint was added to DigitalTwinsInstance.
302
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
303
- */
304
- readonly createdTime?: Date;
305
- /**
306
- * Dead letter storage secret. Will be obfuscated during read.
307
- */
308
- deadLetterSecret?: string;
309
- /**
310
- * PrimaryConnectionString of the endpoint. Will be obfuscated during read.
311
- */
312
- connectionStringPrimaryKey: string;
313
- /**
314
- * SecondaryConnectionString of the endpoint. Will be obfuscated during read.
315
- */
372
+ /** PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read. */
373
+ connectionStringPrimaryKey?: string;
374
+ /** SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read. */
316
375
  connectionStringSecondaryKey?: string;
317
- }
376
+ /** The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb:// */
377
+ endpointUri?: string;
378
+ /** The EventHub name in the EventHub namespace for identity-based authentication. */
379
+ entityPath?: string;
380
+ };
318
381
 
319
- /**
320
- * Properties related to EventGrid.
321
- */
322
- export interface EventGrid {
323
- /**
324
- * Polymorphic Discriminator
325
- */
382
+ /** Properties related to EventGrid. */
383
+ export type EventGrid = DigitalTwinsEndpointResourceProperties & {
384
+ /** Polymorphic discriminator, which specifies the different types this object can be */
326
385
  endpointType: "EventGrid";
327
- /**
328
- * The provisioning state. Possible values include: 'Provisioning', 'Deleting', 'Succeeded',
329
- * 'Failed', 'Canceled', 'Deleted', 'Warning', 'Suspending', 'Restoring', 'Moving', 'Disabled'
330
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
331
- */
332
- readonly provisioningState?: EndpointProvisioningState;
333
- /**
334
- * Time when the Endpoint was added to DigitalTwinsInstance.
335
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
336
- */
337
- readonly createdTime?: Date;
338
- /**
339
- * Dead letter storage secret. Will be obfuscated during read.
340
- */
341
- deadLetterSecret?: string;
342
- /**
343
- * EventGrid Topic Endpoint
344
- */
386
+ /** EventGrid Topic Endpoint */
345
387
  topicEndpoint: string;
346
- /**
347
- * EventGrid secondary accesskey. Will be obfuscated during read.
348
- */
349
- accessKey1: string;
350
- /**
351
- * EventGrid secondary accesskey. Will be obfuscated during read.
352
- */
388
+ /** EventGrid secondary accesskey. Will be obfuscated during read. */
389
+ accessKey1: string | null;
390
+ /** EventGrid secondary accesskey. Will be obfuscated during read. */
353
391
  accessKey2?: string;
354
- }
392
+ };
355
393
 
356
- /**
357
- * Optional Parameters.
358
- */
359
- export interface DigitalTwinsUpdateOptionalParams extends msRest.RequestOptionsBase {
360
- /**
361
- * Instance tags
362
- */
363
- tags?: { [propertyName: string]: string };
394
+ /** DigitalTwinsInstance endpoint resource. */
395
+ export type DigitalTwinsEndpointResource = ExternalResource & {
396
+ /** DigitalTwinsInstance endpoint resource properties. */
397
+ properties: DigitalTwinsEndpointResourcePropertiesUnion;
398
+ };
399
+
400
+ export type GroupIdInformationProperties = GroupIdInformationPropertiesAutoGenerated & {};
401
+
402
+ /** Known values of {@link ProvisioningState} that the service accepts. */
403
+ export enum KnownProvisioningState {
404
+ Provisioning = "Provisioning",
405
+ Deleting = "Deleting",
406
+ Updating = "Updating",
407
+ Succeeded = "Succeeded",
408
+ Failed = "Failed",
409
+ Canceled = "Canceled",
410
+ Deleted = "Deleted",
411
+ Warning = "Warning",
412
+ Suspending = "Suspending",
413
+ Restoring = "Restoring",
414
+ Moving = "Moving"
364
415
  }
365
416
 
366
417
  /**
367
- * Optional Parameters.
368
- */
369
- export interface DigitalTwinsBeginUpdateOptionalParams extends msRest.RequestOptionsBase {
370
- /**
371
- * Instance tags
372
- */
373
- tags?: { [propertyName: string]: string };
418
+ * Defines values for ProvisioningState. \
419
+ * {@link KnownProvisioningState} can be used interchangeably with ProvisioningState,
420
+ * this enum contains the known values that the service supports.
421
+ * ### Known values supported by the service
422
+ * **Provisioning** \
423
+ * **Deleting** \
424
+ * **Updating** \
425
+ * **Succeeded** \
426
+ * **Failed** \
427
+ * **Canceled** \
428
+ * **Deleted** \
429
+ * **Warning** \
430
+ * **Suspending** \
431
+ * **Restoring** \
432
+ * **Moving**
433
+ */
434
+ export type ProvisioningState = string;
435
+
436
+ /** Known values of {@link ConnectionPropertiesProvisioningState} that the service accepts. */
437
+ export enum KnownConnectionPropertiesProvisioningState {
438
+ Pending = "Pending",
439
+ Approved = "Approved",
440
+ Rejected = "Rejected",
441
+ Disconnected = "Disconnected"
374
442
  }
375
443
 
376
444
  /**
377
- * Optional Parameters.
445
+ * Defines values for ConnectionPropertiesProvisioningState. \
446
+ * {@link KnownConnectionPropertiesProvisioningState} can be used interchangeably with ConnectionPropertiesProvisioningState,
447
+ * this enum contains the known values that the service supports.
448
+ * ### Known values supported by the service
449
+ * **Pending** \
450
+ * **Approved** \
451
+ * **Rejected** \
452
+ * **Disconnected**
378
453
  */
379
- export interface DigitalTwinsEndpointCreateOrUpdateOptionalParams extends msRest.RequestOptionsBase {
380
- /**
381
- * DigitalTwinsInstance endpoint resource properties.
382
- */
383
- properties?: DigitalTwinsEndpointResourcePropertiesUnion;
454
+ export type ConnectionPropertiesProvisioningState = string;
455
+
456
+ /** Known values of {@link PrivateLinkServiceConnectionStatus} that the service accepts. */
457
+ export enum KnownPrivateLinkServiceConnectionStatus {
458
+ Pending = "Pending",
459
+ Approved = "Approved",
460
+ Rejected = "Rejected",
461
+ Disconnected = "Disconnected"
384
462
  }
385
463
 
386
464
  /**
387
- * Optional Parameters.
465
+ * Defines values for PrivateLinkServiceConnectionStatus. \
466
+ * {@link KnownPrivateLinkServiceConnectionStatus} can be used interchangeably with PrivateLinkServiceConnectionStatus,
467
+ * this enum contains the known values that the service supports.
468
+ * ### Known values supported by the service
469
+ * **Pending** \
470
+ * **Approved** \
471
+ * **Rejected** \
472
+ * **Disconnected**
388
473
  */
389
- export interface DigitalTwinsEndpointBeginCreateOrUpdateOptionalParams extends msRest.RequestOptionsBase {
390
- /**
391
- * DigitalTwinsInstance endpoint resource properties.
392
- */
393
- properties?: DigitalTwinsEndpointResourcePropertiesUnion;
474
+ export type PrivateLinkServiceConnectionStatus = string;
475
+
476
+ /** Known values of {@link PublicNetworkAccess} that the service accepts. */
477
+ export enum KnownPublicNetworkAccess {
478
+ Enabled = "Enabled",
479
+ Disabled = "Disabled"
394
480
  }
395
481
 
396
482
  /**
397
- * An interface representing AzureDigitalTwinsManagementClientOptions.
483
+ * Defines values for PublicNetworkAccess. \
484
+ * {@link KnownPublicNetworkAccess} can be used interchangeably with PublicNetworkAccess,
485
+ * this enum contains the known values that the service supports.
486
+ * ### Known values supported by the service
487
+ * **Enabled** \
488
+ * **Disabled**
398
489
  */
399
- export interface AzureDigitalTwinsManagementClientOptions extends AzureServiceClientOptions {
400
- baseUri?: string;
490
+ export type PublicNetworkAccess = string;
491
+
492
+ /** Known values of {@link DigitalTwinsIdentityType} that the service accepts. */
493
+ export enum KnownDigitalTwinsIdentityType {
494
+ None = "None",
495
+ SystemAssigned = "SystemAssigned"
401
496
  }
402
497
 
403
498
  /**
404
- * @interface
405
- * A list of DigitalTwins description objects with a next link.
406
- * @extends Array<DigitalTwinsDescription>
499
+ * Defines values for DigitalTwinsIdentityType. \
500
+ * {@link KnownDigitalTwinsIdentityType} can be used interchangeably with DigitalTwinsIdentityType,
501
+ * this enum contains the known values that the service supports.
502
+ * ### Known values supported by the service
503
+ * **None** \
504
+ * **SystemAssigned**
407
505
  */
408
- export interface DigitalTwinsDescriptionListResult extends Array<DigitalTwinsDescription> {
409
- /**
410
- * The link used to get the next page of DigitalTwins description objects.
411
- */
412
- nextLink?: string;
506
+ export type DigitalTwinsIdentityType = string;
507
+
508
+ /** Known values of {@link EndpointType} that the service accepts. */
509
+ export enum KnownEndpointType {
510
+ EventHub = "EventHub",
511
+ EventGrid = "EventGrid",
512
+ ServiceBus = "ServiceBus"
413
513
  }
414
514
 
415
515
  /**
416
- * @interface
417
- * A list of DigitalTwinsInstance Endpoints with a next link.
418
- * @extends Array<DigitalTwinsEndpointResource>
419
- */
420
- export interface DigitalTwinsEndpointResourceListResult extends Array<DigitalTwinsEndpointResource> {
421
- /**
422
- * The link used to get the next page of DigitalTwinsInstance Endpoints.
423
- */
424
- nextLink?: string;
516
+ * Defines values for EndpointType. \
517
+ * {@link KnownEndpointType} can be used interchangeably with EndpointType,
518
+ * this enum contains the known values that the service supports.
519
+ * ### Known values supported by the service
520
+ * **EventHub** \
521
+ * **EventGrid** \
522
+ * **ServiceBus**
523
+ */
524
+ export type EndpointType = string;
525
+
526
+ /** Known values of {@link EndpointProvisioningState} that the service accepts. */
527
+ export enum KnownEndpointProvisioningState {
528
+ Provisioning = "Provisioning",
529
+ Deleting = "Deleting",
530
+ Succeeded = "Succeeded",
531
+ Failed = "Failed",
532
+ Canceled = "Canceled",
533
+ Deleted = "Deleted",
534
+ Warning = "Warning",
535
+ Suspending = "Suspending",
536
+ Restoring = "Restoring",
537
+ Moving = "Moving",
538
+ Disabled = "Disabled"
425
539
  }
426
540
 
427
541
  /**
428
- * @interface
429
- * A list of DigitalTwins service operations. It contains a list of operations and a URL link to
430
- * get the next set of results.
431
- * @extends Array<Operation>
432
- */
433
- export interface OperationListResult extends Array<Operation> {
434
- /**
435
- * The link used to get the next page of DigitalTwins description objects.
436
- */
437
- nextLink?: string;
542
+ * Defines values for EndpointProvisioningState. \
543
+ * {@link KnownEndpointProvisioningState} can be used interchangeably with EndpointProvisioningState,
544
+ * this enum contains the known values that the service supports.
545
+ * ### Known values supported by the service
546
+ * **Provisioning** \
547
+ * **Deleting** \
548
+ * **Succeeded** \
549
+ * **Failed** \
550
+ * **Canceled** \
551
+ * **Deleted** \
552
+ * **Warning** \
553
+ * **Suspending** \
554
+ * **Restoring** \
555
+ * **Moving** \
556
+ * **Disabled**
557
+ */
558
+ export type EndpointProvisioningState = string;
559
+
560
+ /** Known values of {@link AuthenticationType} that the service accepts. */
561
+ export enum KnownAuthenticationType {
562
+ KeyBased = "KeyBased",
563
+ IdentityBased = "IdentityBased"
438
564
  }
439
565
 
440
566
  /**
441
- * Defines values for ProvisioningState.
442
- * Possible values include: 'Provisioning', 'Deleting', 'Succeeded', 'Failed', 'Canceled',
443
- * 'Deleted', 'Warning', 'Suspending', 'Restoring', 'Moving'
444
- * @readonly
445
- * @enum {string}
567
+ * Defines values for AuthenticationType. \
568
+ * {@link KnownAuthenticationType} can be used interchangeably with AuthenticationType,
569
+ * this enum contains the known values that the service supports.
570
+ * ### Known values supported by the service
571
+ * **KeyBased** \
572
+ * **IdentityBased**
446
573
  */
447
- export type ProvisioningState = 'Provisioning' | 'Deleting' | 'Succeeded' | 'Failed' | 'Canceled' | 'Deleted' | 'Warning' | 'Suspending' | 'Restoring' | 'Moving';
574
+ export type AuthenticationType = string;
448
575
 
449
- /**
450
- * Defines values for Reason.
451
- * Possible values include: 'Invalid', 'AlreadyExists'
452
- * @readonly
453
- * @enum {string}
454
- */
455
- export type Reason = 'Invalid' | 'AlreadyExists';
576
+ /** Known values of {@link Reason} that the service accepts. */
577
+ export enum KnownReason {
578
+ Invalid = "Invalid",
579
+ AlreadyExists = "AlreadyExists"
580
+ }
456
581
 
457
582
  /**
458
- * Defines values for EndpointProvisioningState.
459
- * Possible values include: 'Provisioning', 'Deleting', 'Succeeded', 'Failed', 'Canceled',
460
- * 'Deleted', 'Warning', 'Suspending', 'Restoring', 'Moving', 'Disabled'
461
- * @readonly
462
- * @enum {string}
583
+ * Defines values for Reason. \
584
+ * {@link KnownReason} can be used interchangeably with Reason,
585
+ * this enum contains the known values that the service supports.
586
+ * ### Known values supported by the service
587
+ * **Invalid** \
588
+ * **AlreadyExists**
463
589
  */
464
- export type EndpointProvisioningState = 'Provisioning' | 'Deleting' | 'Succeeded' | 'Failed' | 'Canceled' | 'Deleted' | 'Warning' | 'Suspending' | 'Restoring' | 'Moving' | 'Disabled';
590
+ export type Reason = string;
465
591
 
466
- /**
467
- * Contains response data for the get operation.
468
- */
469
- export type DigitalTwinsGetResponse = DigitalTwinsDescription & {
470
- /**
471
- * The underlying HTTP response.
472
- */
473
- _response: msRest.HttpResponse & {
474
- /**
475
- * The response body as text (string format)
476
- */
477
- bodyAsText: string;
592
+ /** Optional parameters. */
593
+ export interface DigitalTwinsGetOptionalParams
594
+ extends coreClient.OperationOptions {}
478
595
 
479
- /**
480
- * The response body as parsed JSON or XML
481
- */
482
- parsedBody: DigitalTwinsDescription;
483
- };
484
- };
596
+ /** Contains response data for the get operation. */
597
+ export type DigitalTwinsGetResponse = DigitalTwinsDescription;
485
598
 
486
- /**
487
- * Contains response data for the createOrUpdate operation.
488
- */
489
- export type DigitalTwinsCreateOrUpdateResponse = DigitalTwinsDescription & {
490
- /**
491
- * The underlying HTTP response.
492
- */
493
- _response: msRest.HttpResponse & {
494
- /**
495
- * The response body as text (string format)
496
- */
497
- bodyAsText: string;
599
+ /** Optional parameters. */
600
+ export interface DigitalTwinsCreateOrUpdateOptionalParams
601
+ extends coreClient.OperationOptions {
602
+ /** Delay to wait until next poll, in milliseconds. */
603
+ updateIntervalInMs?: number;
604
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
605
+ resumeFrom?: string;
606
+ }
498
607
 
499
- /**
500
- * The response body as parsed JSON or XML
501
- */
502
- parsedBody: DigitalTwinsDescription;
503
- };
504
- };
608
+ /** Contains response data for the createOrUpdate operation. */
609
+ export type DigitalTwinsCreateOrUpdateResponse = DigitalTwinsDescription;
505
610
 
506
- /**
507
- * Contains response data for the update operation.
508
- */
509
- export type DigitalTwinsUpdateResponse = DigitalTwinsDescription & {
510
- /**
511
- * The underlying HTTP response.
512
- */
513
- _response: msRest.HttpResponse & {
514
- /**
515
- * The response body as text (string format)
516
- */
517
- bodyAsText: string;
611
+ /** Optional parameters. */
612
+ export interface DigitalTwinsUpdateOptionalParams
613
+ extends coreClient.OperationOptions {
614
+ /** Delay to wait until next poll, in milliseconds. */
615
+ updateIntervalInMs?: number;
616
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
617
+ resumeFrom?: string;
618
+ }
518
619
 
519
- /**
520
- * The response body as parsed JSON or XML
521
- */
522
- parsedBody: DigitalTwinsDescription;
523
- };
524
- };
620
+ /** Contains response data for the update operation. */
621
+ export type DigitalTwinsUpdateResponse = DigitalTwinsDescription;
525
622
 
526
- /**
527
- * Contains response data for the deleteMethod operation.
528
- */
529
- export type DigitalTwinsDeleteMethodResponse = DigitalTwinsDescription & {
530
- /**
531
- * The underlying HTTP response.
532
- */
533
- _response: msRest.HttpResponse & {
534
- /**
535
- * The response body as text (string format)
536
- */
537
- bodyAsText: string;
623
+ /** Optional parameters. */
624
+ export interface DigitalTwinsDeleteOptionalParams
625
+ extends coreClient.OperationOptions {
626
+ /** Delay to wait until next poll, in milliseconds. */
627
+ updateIntervalInMs?: number;
628
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
629
+ resumeFrom?: string;
630
+ }
538
631
 
539
- /**
540
- * The response body as parsed JSON or XML
541
- */
542
- parsedBody: DigitalTwinsDescription;
543
- };
544
- };
632
+ /** Contains response data for the delete operation. */
633
+ export type DigitalTwinsDeleteResponse = DigitalTwinsDescription;
545
634
 
546
- /**
547
- * Contains response data for the list operation.
548
- */
549
- export type DigitalTwinsListResponse = DigitalTwinsDescriptionListResult & {
550
- /**
551
- * The underlying HTTP response.
552
- */
553
- _response: msRest.HttpResponse & {
554
- /**
555
- * The response body as text (string format)
556
- */
557
- bodyAsText: string;
635
+ /** Optional parameters. */
636
+ export interface DigitalTwinsListOptionalParams
637
+ extends coreClient.OperationOptions {}
558
638
 
559
- /**
560
- * The response body as parsed JSON or XML
561
- */
562
- parsedBody: DigitalTwinsDescriptionListResult;
563
- };
564
- };
639
+ /** Contains response data for the list operation. */
640
+ export type DigitalTwinsListResponse = DigitalTwinsDescriptionListResult;
565
641
 
566
- /**
567
- * Contains response data for the listByResourceGroup operation.
568
- */
569
- export type DigitalTwinsListByResourceGroupResponse = DigitalTwinsDescriptionListResult & {
570
- /**
571
- * The underlying HTTP response.
572
- */
573
- _response: msRest.HttpResponse & {
574
- /**
575
- * The response body as text (string format)
576
- */
577
- bodyAsText: string;
642
+ /** Optional parameters. */
643
+ export interface DigitalTwinsListByResourceGroupOptionalParams
644
+ extends coreClient.OperationOptions {}
578
645
 
579
- /**
580
- * The response body as parsed JSON or XML
581
- */
582
- parsedBody: DigitalTwinsDescriptionListResult;
583
- };
584
- };
646
+ /** Contains response data for the listByResourceGroup operation. */
647
+ export type DigitalTwinsListByResourceGroupResponse = DigitalTwinsDescriptionListResult;
585
648
 
586
- /**
587
- * Contains response data for the checkNameAvailability operation.
588
- */
589
- export type DigitalTwinsCheckNameAvailabilityResponse = CheckNameResult & {
590
- /**
591
- * The underlying HTTP response.
592
- */
593
- _response: msRest.HttpResponse & {
594
- /**
595
- * The response body as text (string format)
596
- */
597
- bodyAsText: string;
649
+ /** Optional parameters. */
650
+ export interface DigitalTwinsCheckNameAvailabilityOptionalParams
651
+ extends coreClient.OperationOptions {}
598
652
 
599
- /**
600
- * The response body as parsed JSON or XML
601
- */
602
- parsedBody: CheckNameResult;
603
- };
604
- };
653
+ /** Contains response data for the checkNameAvailability operation. */
654
+ export type DigitalTwinsCheckNameAvailabilityResponse = CheckNameResult;
605
655
 
606
- /**
607
- * Contains response data for the beginCreateOrUpdate operation.
608
- */
609
- export type DigitalTwinsBeginCreateOrUpdateResponse = DigitalTwinsDescription & {
610
- /**
611
- * The underlying HTTP response.
612
- */
613
- _response: msRest.HttpResponse & {
614
- /**
615
- * The response body as text (string format)
616
- */
617
- bodyAsText: string;
656
+ /** Optional parameters. */
657
+ export interface DigitalTwinsListNextOptionalParams
658
+ extends coreClient.OperationOptions {}
618
659
 
619
- /**
620
- * The response body as parsed JSON or XML
621
- */
622
- parsedBody: DigitalTwinsDescription;
623
- };
624
- };
660
+ /** Contains response data for the listNext operation. */
661
+ export type DigitalTwinsListNextResponse = DigitalTwinsDescriptionListResult;
625
662
 
626
- /**
627
- * Contains response data for the beginUpdate operation.
628
- */
629
- export type DigitalTwinsBeginUpdateResponse = DigitalTwinsDescription & {
630
- /**
631
- * The underlying HTTP response.
632
- */
633
- _response: msRest.HttpResponse & {
634
- /**
635
- * The response body as text (string format)
636
- */
637
- bodyAsText: string;
663
+ /** Optional parameters. */
664
+ export interface DigitalTwinsListByResourceGroupNextOptionalParams
665
+ extends coreClient.OperationOptions {}
638
666
 
639
- /**
640
- * The response body as parsed JSON or XML
641
- */
642
- parsedBody: DigitalTwinsDescription;
643
- };
644
- };
667
+ /** Contains response data for the listByResourceGroupNext operation. */
668
+ export type DigitalTwinsListByResourceGroupNextResponse = DigitalTwinsDescriptionListResult;
645
669
 
646
- /**
647
- * Contains response data for the beginDeleteMethod operation.
648
- */
649
- export type DigitalTwinsBeginDeleteMethodResponse = DigitalTwinsDescription & {
650
- /**
651
- * The underlying HTTP response.
652
- */
653
- _response: msRest.HttpResponse & {
654
- /**
655
- * The response body as text (string format)
656
- */
657
- bodyAsText: string;
670
+ /** Optional parameters. */
671
+ export interface DigitalTwinsEndpointListOptionalParams
672
+ extends coreClient.OperationOptions {}
658
673
 
659
- /**
660
- * The response body as parsed JSON or XML
661
- */
662
- parsedBody: DigitalTwinsDescription;
663
- };
664
- };
674
+ /** Contains response data for the list operation. */
675
+ export type DigitalTwinsEndpointListResponse = DigitalTwinsEndpointResourceListResult;
665
676
 
666
- /**
667
- * Contains response data for the listNext operation.
668
- */
669
- export type DigitalTwinsListNextResponse = DigitalTwinsDescriptionListResult & {
670
- /**
671
- * The underlying HTTP response.
672
- */
673
- _response: msRest.HttpResponse & {
674
- /**
675
- * The response body as text (string format)
676
- */
677
- bodyAsText: string;
677
+ /** Optional parameters. */
678
+ export interface DigitalTwinsEndpointGetOptionalParams
679
+ extends coreClient.OperationOptions {}
678
680
 
679
- /**
680
- * The response body as parsed JSON or XML
681
- */
682
- parsedBody: DigitalTwinsDescriptionListResult;
683
- };
684
- };
681
+ /** Contains response data for the get operation. */
682
+ export type DigitalTwinsEndpointGetResponse = DigitalTwinsEndpointResource;
685
683
 
686
- /**
687
- * Contains response data for the listByResourceGroupNext operation.
688
- */
689
- export type DigitalTwinsListByResourceGroupNextResponse = DigitalTwinsDescriptionListResult & {
690
- /**
691
- * The underlying HTTP response.
692
- */
693
- _response: msRest.HttpResponse & {
694
- /**
695
- * The response body as text (string format)
696
- */
697
- bodyAsText: string;
684
+ /** Optional parameters. */
685
+ export interface DigitalTwinsEndpointCreateOrUpdateOptionalParams
686
+ extends coreClient.OperationOptions {
687
+ /** Delay to wait until next poll, in milliseconds. */
688
+ updateIntervalInMs?: number;
689
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
690
+ resumeFrom?: string;
691
+ }
698
692
 
699
- /**
700
- * The response body as parsed JSON or XML
701
- */
702
- parsedBody: DigitalTwinsDescriptionListResult;
703
- };
704
- };
693
+ /** Contains response data for the createOrUpdate operation. */
694
+ export type DigitalTwinsEndpointCreateOrUpdateResponse = DigitalTwinsEndpointResource;
705
695
 
706
- /**
707
- * Contains response data for the list operation.
708
- */
709
- export type DigitalTwinsEndpointListResponse = DigitalTwinsEndpointResourceListResult & {
710
- /**
711
- * The underlying HTTP response.
712
- */
713
- _response: msRest.HttpResponse & {
714
- /**
715
- * The response body as text (string format)
716
- */
717
- bodyAsText: string;
696
+ /** Optional parameters. */
697
+ export interface DigitalTwinsEndpointDeleteOptionalParams
698
+ extends coreClient.OperationOptions {
699
+ /** Delay to wait until next poll, in milliseconds. */
700
+ updateIntervalInMs?: number;
701
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
702
+ resumeFrom?: string;
703
+ }
718
704
 
719
- /**
720
- * The response body as parsed JSON or XML
721
- */
722
- parsedBody: DigitalTwinsEndpointResourceListResult;
723
- };
724
- };
705
+ /** Contains response data for the delete operation. */
706
+ export type DigitalTwinsEndpointDeleteResponse = DigitalTwinsEndpointResource;
725
707
 
726
- /**
727
- * Contains response data for the get operation.
728
- */
729
- export type DigitalTwinsEndpointGetResponse = DigitalTwinsEndpointResource & {
730
- /**
731
- * The underlying HTTP response.
732
- */
733
- _response: msRest.HttpResponse & {
734
- /**
735
- * The response body as text (string format)
736
- */
737
- bodyAsText: string;
708
+ /** Optional parameters. */
709
+ export interface DigitalTwinsEndpointListNextOptionalParams
710
+ extends coreClient.OperationOptions {}
738
711
 
739
- /**
740
- * The response body as parsed JSON or XML
741
- */
742
- parsedBody: DigitalTwinsEndpointResource;
743
- };
744
- };
712
+ /** Contains response data for the listNext operation. */
713
+ export type DigitalTwinsEndpointListNextResponse = DigitalTwinsEndpointResourceListResult;
745
714
 
746
- /**
747
- * Contains response data for the createOrUpdate operation.
748
- */
749
- export type DigitalTwinsEndpointCreateOrUpdateResponse = DigitalTwinsEndpointResource & {
750
- /**
751
- * The underlying HTTP response.
752
- */
753
- _response: msRest.HttpResponse & {
754
- /**
755
- * The response body as text (string format)
756
- */
757
- bodyAsText: string;
715
+ /** Optional parameters. */
716
+ export interface OperationsListOptionalParams
717
+ extends coreClient.OperationOptions {}
758
718
 
759
- /**
760
- * The response body as parsed JSON or XML
761
- */
762
- parsedBody: DigitalTwinsEndpointResource;
763
- };
764
- };
719
+ /** Contains response data for the list operation. */
720
+ export type OperationsListResponse = OperationListResult;
765
721
 
766
- /**
767
- * Contains response data for the deleteMethod operation.
768
- */
769
- export type DigitalTwinsEndpointDeleteMethodResponse = DigitalTwinsEndpointResource & {
770
- /**
771
- * The underlying HTTP response.
772
- */
773
- _response: msRest.HttpResponse & {
774
- /**
775
- * The response body as text (string format)
776
- */
777
- bodyAsText: string;
722
+ /** Optional parameters. */
723
+ export interface OperationsListNextOptionalParams
724
+ extends coreClient.OperationOptions {}
778
725
 
779
- /**
780
- * The response body as parsed JSON or XML
781
- */
782
- parsedBody: DigitalTwinsEndpointResource;
783
- };
784
- };
726
+ /** Contains response data for the listNext operation. */
727
+ export type OperationsListNextResponse = OperationListResult;
785
728
 
786
- /**
787
- * Contains response data for the beginCreateOrUpdate operation.
788
- */
789
- export type DigitalTwinsEndpointBeginCreateOrUpdateResponse = DigitalTwinsEndpointResource & {
790
- /**
791
- * The underlying HTTP response.
792
- */
793
- _response: msRest.HttpResponse & {
794
- /**
795
- * The response body as text (string format)
796
- */
797
- bodyAsText: string;
729
+ /** Optional parameters. */
730
+ export interface PrivateLinkResourcesListOptionalParams
731
+ extends coreClient.OperationOptions {}
798
732
 
799
- /**
800
- * The response body as parsed JSON or XML
801
- */
802
- parsedBody: DigitalTwinsEndpointResource;
803
- };
804
- };
733
+ /** Contains response data for the list operation. */
734
+ export type PrivateLinkResourcesListResponse = GroupIdInformationResponse;
805
735
 
806
- /**
807
- * Contains response data for the beginDeleteMethod operation.
808
- */
809
- export type DigitalTwinsEndpointBeginDeleteMethodResponse = DigitalTwinsEndpointResource & {
810
- /**
811
- * The underlying HTTP response.
812
- */
813
- _response: msRest.HttpResponse & {
814
- /**
815
- * The response body as text (string format)
816
- */
817
- bodyAsText: string;
736
+ /** Optional parameters. */
737
+ export interface PrivateLinkResourcesGetOptionalParams
738
+ extends coreClient.OperationOptions {}
818
739
 
819
- /**
820
- * The response body as parsed JSON or XML
821
- */
822
- parsedBody: DigitalTwinsEndpointResource;
823
- };
824
- };
740
+ /** Contains response data for the get operation. */
741
+ export type PrivateLinkResourcesGetResponse = GroupIdInformation;
825
742
 
826
- /**
827
- * Contains response data for the listNext operation.
828
- */
829
- export type DigitalTwinsEndpointListNextResponse = DigitalTwinsEndpointResourceListResult & {
830
- /**
831
- * The underlying HTTP response.
832
- */
833
- _response: msRest.HttpResponse & {
834
- /**
835
- * The response body as text (string format)
836
- */
837
- bodyAsText: string;
743
+ /** Optional parameters. */
744
+ export interface PrivateEndpointConnectionsListOptionalParams
745
+ extends coreClient.OperationOptions {}
838
746
 
839
- /**
840
- * The response body as parsed JSON or XML
841
- */
842
- parsedBody: DigitalTwinsEndpointResourceListResult;
843
- };
844
- };
747
+ /** Contains response data for the list operation. */
748
+ export type PrivateEndpointConnectionsListResponse = PrivateEndpointConnectionsResponse;
845
749
 
846
- /**
847
- * Contains response data for the list operation.
848
- */
849
- export type OperationsListResponse = OperationListResult & {
850
- /**
851
- * The underlying HTTP response.
852
- */
853
- _response: msRest.HttpResponse & {
854
- /**
855
- * The response body as text (string format)
856
- */
857
- bodyAsText: string;
750
+ /** Optional parameters. */
751
+ export interface PrivateEndpointConnectionsGetOptionalParams
752
+ extends coreClient.OperationOptions {}
858
753
 
859
- /**
860
- * The response body as parsed JSON or XML
861
- */
862
- parsedBody: OperationListResult;
863
- };
864
- };
754
+ /** Contains response data for the get operation. */
755
+ export type PrivateEndpointConnectionsGetResponse = PrivateEndpointConnection;
865
756
 
866
- /**
867
- * Contains response data for the listNext operation.
868
- */
869
- export type OperationsListNextResponse = OperationListResult & {
870
- /**
871
- * The underlying HTTP response.
872
- */
873
- _response: msRest.HttpResponse & {
874
- /**
875
- * The response body as text (string format)
876
- */
877
- bodyAsText: string;
757
+ /** Optional parameters. */
758
+ export interface PrivateEndpointConnectionsDeleteOptionalParams
759
+ extends coreClient.OperationOptions {
760
+ /** Delay to wait until next poll, in milliseconds. */
761
+ updateIntervalInMs?: number;
762
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
763
+ resumeFrom?: string;
764
+ }
878
765
 
879
- /**
880
- * The response body as parsed JSON or XML
881
- */
882
- parsedBody: OperationListResult;
883
- };
884
- };
766
+ /** Optional parameters. */
767
+ export interface PrivateEndpointConnectionsCreateOrUpdateOptionalParams
768
+ extends coreClient.OperationOptions {
769
+ /** Delay to wait until next poll, in milliseconds. */
770
+ updateIntervalInMs?: number;
771
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
772
+ resumeFrom?: string;
773
+ }
774
+
775
+ /** Contains response data for the createOrUpdate operation. */
776
+ export type PrivateEndpointConnectionsCreateOrUpdateResponse = PrivateEndpointConnection;
777
+
778
+ /** Optional parameters. */
779
+ export interface AzureDigitalTwinsManagementClientOptionalParams
780
+ extends coreClient.ServiceClientOptions {
781
+ /** server parameter */
782
+ $host?: string;
783
+ /** Api Version */
784
+ apiVersion?: string;
785
+ /** Overrides client endpoint. */
786
+ endpoint?: string;
787
+ }