@azure/arm-timeseriesinsights 1.3.1 → 2.0.0-alpha.20220208.1

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 (179) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/LICENSE +21 -0
  3. package/README.md +69 -80
  4. package/dist/index.js +3489 -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/index.d.ts +5 -0
  9. package/dist-esm/src/index.d.ts.map +1 -0
  10. package/dist-esm/src/index.js +12 -0
  11. package/dist-esm/src/index.js.map +1 -0
  12. package/dist-esm/src/lroImpl.d.ts +16 -0
  13. package/dist-esm/src/lroImpl.d.ts.map +1 -0
  14. package/dist-esm/src/lroImpl.js +29 -0
  15. package/dist-esm/src/lroImpl.js.map +1 -0
  16. package/dist-esm/src/models/index.d.ts +1102 -0
  17. package/dist-esm/src/models/index.d.ts.map +1 -0
  18. package/dist-esm/src/models/index.js +109 -0
  19. package/dist-esm/src/models/index.js.map +1 -0
  20. package/dist-esm/src/models/mappers.d.ts +94 -0
  21. package/dist-esm/src/models/mappers.d.ts.map +1 -0
  22. package/dist-esm/src/models/mappers.js +1965 -0
  23. package/dist-esm/src/models/mappers.js.map +1 -0
  24. package/dist-esm/src/models/parameters.d.ts +26 -0
  25. package/dist-esm/src/models/parameters.d.ts.map +1 -0
  26. package/dist-esm/src/models/parameters.js +225 -0
  27. package/dist-esm/src/models/parameters.js.map +1 -0
  28. package/dist-esm/src/operations/accessPolicies.d.ts +65 -0
  29. package/dist-esm/src/operations/accessPolicies.d.ts.map +1 -0
  30. package/dist-esm/src/operations/accessPolicies.js +212 -0
  31. package/dist-esm/src/operations/accessPolicies.js.map +1 -0
  32. package/dist-esm/src/operations/environments.d.ts +78 -0
  33. package/dist-esm/src/operations/environments.d.ts.map +1 -0
  34. package/dist-esm/src/operations/environments.js +314 -0
  35. package/dist-esm/src/operations/environments.js.map +1 -0
  36. package/dist-esm/src/operations/eventSources.d.ts +66 -0
  37. package/dist-esm/src/operations/eventSources.d.ts.map +1 -0
  38. package/dist-esm/src/operations/eventSources.js +213 -0
  39. package/dist-esm/src/operations/eventSources.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 +3 -5
  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/referenceDataSets.d.ts +66 -0
  49. package/dist-esm/src/operations/referenceDataSets.d.ts.map +1 -0
  50. package/dist-esm/src/operations/referenceDataSets.js +213 -0
  51. package/dist-esm/src/operations/referenceDataSets.js.map +1 -0
  52. package/dist-esm/src/operationsInterfaces/accessPolicies.d.ts +57 -0
  53. package/dist-esm/src/operationsInterfaces/accessPolicies.d.ts.map +1 -0
  54. package/dist-esm/src/operationsInterfaces/accessPolicies.js +9 -0
  55. package/dist-esm/src/operationsInterfaces/accessPolicies.js.map +1 -0
  56. package/dist-esm/src/operationsInterfaces/environments.d.ts +70 -0
  57. package/dist-esm/src/operationsInterfaces/environments.d.ts.map +1 -0
  58. package/dist-esm/src/operationsInterfaces/environments.js +9 -0
  59. package/dist-esm/src/operationsInterfaces/environments.js.map +1 -0
  60. package/dist-esm/src/operationsInterfaces/eventSources.d.ts +58 -0
  61. package/dist-esm/src/operationsInterfaces/eventSources.d.ts.map +1 -0
  62. package/dist-esm/src/operationsInterfaces/eventSources.js +9 -0
  63. package/dist-esm/src/operationsInterfaces/eventSources.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/dist-esm/src/operationsInterfaces/operations.js +9 -0
  71. package/dist-esm/src/operationsInterfaces/operations.js.map +1 -0
  72. package/dist-esm/src/operationsInterfaces/referenceDataSets.d.ts +58 -0
  73. package/dist-esm/src/operationsInterfaces/referenceDataSets.d.ts.map +1 -0
  74. package/dist-esm/src/operationsInterfaces/referenceDataSets.js +9 -0
  75. package/dist-esm/src/operationsInterfaces/referenceDataSets.js.map +1 -0
  76. package/dist-esm/src/timeSeriesInsightsClient.d.ts +22 -0
  77. package/dist-esm/src/timeSeriesInsightsClient.d.ts.map +1 -0
  78. package/dist-esm/src/timeSeriesInsightsClient.js +55 -0
  79. package/dist-esm/src/timeSeriesInsightsClient.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 +73 -22
  85. package/review/arm-timeseriesinsights.api.md +943 -0
  86. package/rollup.config.js +181 -30
  87. package/src/index.ts +12 -0
  88. package/src/lroImpl.ts +34 -0
  89. package/src/models/index.ts +1032 -1259
  90. package/src/models/mappers.ts +1568 -811
  91. package/src/models/parameters.ts +157 -69
  92. package/src/operations/accessPolicies.ts +144 -250
  93. package/src/operations/environments.ts +322 -267
  94. package/src/operations/eventSources.ts +144 -250
  95. package/src/operations/index.ts +3 -5
  96. package/src/operations/operations.ts +87 -73
  97. package/src/operations/referenceDataSets.ts +144 -250
  98. package/src/operationsInterfaces/accessPolicies.ts +103 -0
  99. package/src/operationsInterfaces/environments.ts +135 -0
  100. package/src/operationsInterfaces/eventSources.ts +104 -0
  101. package/src/operationsInterfaces/index.ts +13 -0
  102. package/src/operationsInterfaces/operations.ts +22 -0
  103. package/src/operationsInterfaces/referenceDataSets.ts +104 -0
  104. package/src/timeSeriesInsightsClient.ts +82 -43
  105. package/tsconfig.json +3 -3
  106. package/types/arm-timeseriesinsights.d.ts +1523 -0
  107. package/types/tsdoc-metadata.json +11 -0
  108. package/dist/arm-timeseriesinsights.js +0 -2806
  109. package/dist/arm-timeseriesinsights.js.map +0 -1
  110. package/dist/arm-timeseriesinsights.min.js +0 -1
  111. package/dist/arm-timeseriesinsights.min.js.map +0 -1
  112. package/esm/models/accessPoliciesMappers.d.ts +0 -2
  113. package/esm/models/accessPoliciesMappers.d.ts.map +0 -1
  114. package/esm/models/accessPoliciesMappers.js +0 -9
  115. package/esm/models/accessPoliciesMappers.js.map +0 -1
  116. package/esm/models/environmentsMappers.d.ts +0 -2
  117. package/esm/models/environmentsMappers.d.ts.map +0 -1
  118. package/esm/models/environmentsMappers.js +0 -9
  119. package/esm/models/environmentsMappers.js.map +0 -1
  120. package/esm/models/eventSourcesMappers.d.ts +0 -2
  121. package/esm/models/eventSourcesMappers.d.ts.map +0 -1
  122. package/esm/models/eventSourcesMappers.js +0 -9
  123. package/esm/models/eventSourcesMappers.js.map +0 -1
  124. package/esm/models/index.d.ts +0 -1413
  125. package/esm/models/index.d.ts.map +0 -1
  126. package/esm/models/index.js +0 -8
  127. package/esm/models/index.js.map +0 -1
  128. package/esm/models/mappers.d.ts +0 -54
  129. package/esm/models/mappers.d.ts.map +0 -1
  130. package/esm/models/mappers.js +0 -1321
  131. package/esm/models/mappers.js.map +0 -1
  132. package/esm/models/operationsMappers.d.ts +0 -2
  133. package/esm/models/operationsMappers.d.ts.map +0 -1
  134. package/esm/models/operationsMappers.js +0 -9
  135. package/esm/models/operationsMappers.js.map +0 -1
  136. package/esm/models/parameters.d.ts +0 -16
  137. package/esm/models/parameters.d.ts.map +0 -1
  138. package/esm/models/parameters.js +0 -173
  139. package/esm/models/parameters.js.map +0 -1
  140. package/esm/models/referenceDataSetsMappers.d.ts +0 -2
  141. package/esm/models/referenceDataSetsMappers.d.ts.map +0 -1
  142. package/esm/models/referenceDataSetsMappers.js +0 -9
  143. package/esm/models/referenceDataSetsMappers.js.map +0 -1
  144. package/esm/operations/accessPolicies.d.ts +0 -165
  145. package/esm/operations/accessPolicies.d.ts.map +0 -1
  146. package/esm/operations/accessPolicies.js +0 -203
  147. package/esm/operations/accessPolicies.js.map +0 -1
  148. package/esm/operations/environments.d.ts +0 -139
  149. package/esm/operations/environments.d.ts.map +0 -1
  150. package/esm/operations/environments.js +0 -268
  151. package/esm/operations/environments.js.map +0 -1
  152. package/esm/operations/eventSources.d.ts +0 -166
  153. package/esm/operations/eventSources.d.ts.map +0 -1
  154. package/esm/operations/eventSources.js +0 -203
  155. package/esm/operations/eventSources.js.map +0 -1
  156. package/esm/operations/index.d.ts.map +0 -1
  157. package/esm/operations/index.js.map +0 -1
  158. package/esm/operations/operations.d.ts +0 -46
  159. package/esm/operations/operations.d.ts.map +0 -1
  160. package/esm/operations/operations.js +0 -77
  161. package/esm/operations/operations.js.map +0 -1
  162. package/esm/operations/referenceDataSets.d.ts +0 -166
  163. package/esm/operations/referenceDataSets.d.ts.map +0 -1
  164. package/esm/operations/referenceDataSets.js +0 -203
  165. package/esm/operations/referenceDataSets.js.map +0 -1
  166. package/esm/timeSeriesInsightsClient.d.ts +0 -28
  167. package/esm/timeSeriesInsightsClient.d.ts.map +0 -1
  168. package/esm/timeSeriesInsightsClient.js +0 -42
  169. package/esm/timeSeriesInsightsClient.js.map +0 -1
  170. package/esm/timeSeriesInsightsClientContext.d.ts +0 -22
  171. package/esm/timeSeriesInsightsClientContext.d.ts.map +0 -1
  172. package/esm/timeSeriesInsightsClientContext.js +0 -61
  173. package/esm/timeSeriesInsightsClientContext.js.map +0 -1
  174. package/src/models/accessPoliciesMappers.ts +0 -30
  175. package/src/models/environmentsMappers.ts +0 -35
  176. package/src/models/eventSourcesMappers.ts +0 -39
  177. package/src/models/operationsMappers.ts +0 -15
  178. package/src/models/referenceDataSetsMappers.ts +0 -35
  179. package/src/timeSeriesInsightsClientContext.ts +0 -68
@@ -1,1496 +1,1269 @@
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";
10
+
11
+ export type EnvironmentUpdateParametersUnion =
12
+ | EnvironmentUpdateParameters
13
+ | Gen1EnvironmentUpdateParameters
14
+ | Gen2EnvironmentUpdateParameters;
15
+ export type EventSourceUpdateParametersUnion =
16
+ | EventSourceUpdateParameters
17
+ | EventHubEventSourceUpdateParameters
18
+ | IoTHubEventSourceUpdateParameters;
19
+ export type EnvironmentCreateOrUpdateParametersUnion =
20
+ | EnvironmentCreateOrUpdateParameters
21
+ | Gen1EnvironmentCreateOrUpdateParameters
22
+ | Gen2EnvironmentCreateOrUpdateParameters;
23
+ export type EventSourceCreateOrUpdateParametersUnion =
24
+ | EventSourceCreateOrUpdateParameters
25
+ | EventHubEventSourceCreateOrUpdateParameters
26
+ | IoTHubEventSourceCreateOrUpdateParameters;
27
+ export type EnvironmentResourceUnion =
28
+ | EnvironmentResource
29
+ | Gen1EnvironmentResource
30
+ | Gen2EnvironmentResource;
31
+ export type EventSourceResourceUnion =
32
+ | EventSourceResource
33
+ | EventHubEventSourceResource
34
+ | IoTHubEventSourceResource;
35
+
36
+ /** Result of the request to list Time Series Insights operations. It contains a list of operations and a URL link to get the next set of results. */
37
+ export interface OperationListResult {
38
+ /**
39
+ * List of Time Series Insights operations supported by the Microsoft.TimeSeriesInsights resource provider.
40
+ * NOTE: This property will not be serialized. It can only be populated by the server.
41
+ */
42
+ readonly value?: Operation[];
43
+ /**
44
+ * URL to get the next set of operation list results if there are any.
45
+ * NOTE: This property will not be serialized. It can only be populated by the server.
46
+ */
47
+ readonly nextLink?: string;
48
+ }
11
49
 
12
- export { BaseResource, CloudError };
50
+ /** A Time Series Insights REST API operation */
51
+ export interface Operation {
52
+ /**
53
+ * The name of the operation being performed on this particular object.
54
+ * NOTE: This property will not be serialized. It can only be populated by the server.
55
+ */
56
+ readonly name?: string;
57
+ /**
58
+ * Contains the localized display information for this particular operation / action.
59
+ * NOTE: This property will not be serialized. It can only be populated by the server.
60
+ */
61
+ readonly display?: OperationDisplay;
62
+ /** The intended executor of the operation. */
63
+ origin?: string;
64
+ /** One property of operation, include metric specifications. */
65
+ serviceSpecification?: ServiceSpecification;
66
+ }
13
67
 
14
- /**
15
- * Contains the localized display information for this particular operation / action.
16
- */
68
+ /** Contains the localized display information for this particular operation / action. */
17
69
  export interface OperationDisplay {
18
70
  /**
19
71
  * The localized friendly form of the resource provider name.
20
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
72
+ * NOTE: This property will not be serialized. It can only be populated by the server.
21
73
  */
22
74
  readonly provider?: string;
23
75
  /**
24
76
  * The localized friendly form of the resource type related to this action/operation.
25
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
77
+ * NOTE: This property will not be serialized. It can only be populated by the server.
26
78
  */
27
79
  readonly resource?: string;
28
80
  /**
29
81
  * The localized friendly name for the operation.
30
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
82
+ * NOTE: This property will not be serialized. It can only be populated by the server.
31
83
  */
32
84
  readonly operation?: string;
33
85
  /**
34
86
  * The localized friendly description for the operation.
35
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
87
+ * NOTE: This property will not be serialized. It can only be populated by the server.
36
88
  */
37
89
  readonly description?: string;
38
90
  }
39
91
 
40
- /**
41
- * A Time Series Insights REST API operation
42
- */
43
- export interface Operation {
44
- /**
45
- * The name of the operation being performed on this particular object.
46
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
47
- */
48
- readonly name?: string;
49
- /**
50
- * Contains the localized display information for this particular operation / action.
51
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
52
- */
53
- readonly display?: OperationDisplay;
92
+ /** One property of operation, include metric specifications. */
93
+ export interface ServiceSpecification {
94
+ /** Metric specifications of operation. */
95
+ metricSpecifications?: MetricSpecification[];
96
+ /** A list of Azure Monitoring log definitions. */
97
+ logSpecifications?: LogSpecification[];
54
98
  }
55
99
 
56
- /**
57
- * Time Series Insights resource
58
- */
59
- export interface Resource extends BaseResource {
100
+ /** Metric specification of operation. */
101
+ export interface MetricSpecification {
102
+ /** Name of metric specification. */
103
+ name?: string;
104
+ /** Display name of metric specification. */
105
+ displayName?: string;
106
+ /** Display description of metric specification. */
107
+ displayDescription?: string;
108
+ /** Unit could be Bytes or Count. */
109
+ unit?: string;
110
+ /** Dimensions of blobs, including blob type and access tier. */
111
+ dimensions?: Dimension[];
112
+ /** Aggregation type could be Average. */
113
+ aggregationType?: string;
114
+ /** Retention policies of a resource metric. */
115
+ availabilities?: MetricAvailability[];
116
+ /** The category this metric specification belong to, could be Capacity. */
117
+ category?: string;
118
+ /** Account Resource Id. */
119
+ resourceIdDimensionNameOverride?: string;
120
+ }
121
+
122
+ /** Dimension of blobs, possibly be blob type or access tier. */
123
+ export interface Dimension {
124
+ /** Display name of dimension. */
125
+ name?: string;
126
+ /** Display name of dimension. */
127
+ displayName?: string;
128
+ }
129
+
130
+ /** Retention policy of a resource metric. */
131
+ export interface MetricAvailability {
132
+ timeGrain?: string;
133
+ blobDuration?: string;
134
+ }
135
+
136
+ /** The specification of an Azure Monitoring log. */
137
+ export interface LogSpecification {
138
+ /** Log name. */
139
+ name?: string;
140
+ /** Log display name. */
141
+ displayName?: string;
142
+ }
143
+
144
+ /** Contains information about an API error. */
145
+ export interface CloudError {
146
+ /** Describes a particular API error with an error code and a message. */
147
+ error?: CloudErrorBody;
148
+ }
149
+
150
+ /** Describes a particular API error with an error code and a message. */
151
+ export interface CloudErrorBody {
152
+ /** An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. */
153
+ code?: string;
154
+ /** A message that describes the error in detail and provides debugging information. */
155
+ message?: string;
156
+ /** The target of the particular error (for example, the name of the property in error). */
157
+ target?: string;
158
+ /** Contains nested errors that are related to this error. */
159
+ details?: CloudErrorBody[];
160
+ }
161
+
162
+ /** The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku determines the capacity of the environment, the ingress rate, and the billing rate. */
163
+ export interface Sku {
164
+ /** The name of this SKU. */
165
+ name: SkuName;
166
+ /** The capacity of the sku. For Gen1 environments, this value can be changed to support scale out of environments after they have been created. */
167
+ capacity: number;
168
+ }
169
+
170
+ /** Properties required to create any resource tracked by Azure Resource Manager. */
171
+ export interface CreateOrUpdateTrackedResourceProperties {
172
+ /** The location of the resource. */
173
+ location: string;
174
+ /** Key-value pairs of additional properties for the resource. */
175
+ tags?: { [propertyName: string]: string };
176
+ }
177
+
178
+ /** Time Series Insights resource */
179
+ export interface Resource {
60
180
  /**
61
181
  * Resource Id
62
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
182
+ * NOTE: This property will not be serialized. It can only be populated by the server.
63
183
  */
64
184
  readonly id?: string;
65
185
  /**
66
186
  * Resource name
67
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
187
+ * NOTE: This property will not be serialized. It can only be populated by the server.
68
188
  */
69
189
  readonly name?: string;
70
190
  /**
71
191
  * Resource type
72
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
192
+ * NOTE: This property will not be serialized. It can only be populated by the server.
73
193
  */
74
194
  readonly type?: string;
75
195
  }
76
196
 
77
- /**
78
- * Time Series Insights resource that is tracked by Azure Resource Manager.
79
- */
80
- export interface TrackedResource extends Resource {
81
- /**
82
- * Resource location
83
- */
84
- location: string;
85
- /**
86
- * Resource tags
87
- */
197
+ /** Parameters supplied to the Update Environment operation. */
198
+ export interface EnvironmentUpdateParameters {
199
+ /** Polymorphic discriminator, which specifies the different types this object can be */
200
+ kind: "Gen1" | "Gen2";
201
+ /** Key-value pairs of additional properties for the environment. */
88
202
  tags?: { [propertyName: string]: string };
89
203
  }
90
204
 
91
- /**
92
- * Properties that are common to all tracked resources.
93
- */
205
+ /** The response of the List Environments operation. */
206
+ export interface EnvironmentListResponse {
207
+ /** Result of the List Environments operation. */
208
+ value?: EnvironmentResourceUnion[];
209
+ }
210
+
211
+ /** An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events. */
212
+ export interface LocalTimestamp {
213
+ /** An enum that represents the format of the local timestamp property that needs to be set. */
214
+ format?: LocalTimestampFormat;
215
+ /** An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded. */
216
+ timeZoneOffset?: LocalTimestampTimeZoneOffset;
217
+ }
218
+
219
+ /** An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded. */
220
+ export interface LocalTimestampTimeZoneOffset {
221
+ /** The event property that will be contain the offset information to calculate the local timestamp. When the LocalTimestampFormat is Iana, the property name will contain the name of the column which contains IANA Timezone Name (eg: Americas/Los Angeles). When LocalTimestampFormat is Timespan, it contains the name of property which contains values representing the offset (eg: P1D or 1.00:00:00) */
222
+ propertyName?: string;
223
+ }
224
+
225
+ /** Parameters supplied to the Update Event Source operation. */
226
+ export interface EventSourceUpdateParameters {
227
+ /** Polymorphic discriminator, which specifies the different types this object can be */
228
+ kind: "Microsoft.EventHub" | "Microsoft.IoTHub";
229
+ /** Key-value pairs of additional properties for the event source. */
230
+ tags?: { [propertyName: string]: string };
231
+ }
232
+
233
+ /** The response of the List EventSources operation. */
234
+ export interface EventSourceListResponse {
235
+ /** Result of the List EventSources operation. */
236
+ value?: EventSourceResourceUnion[];
237
+ }
238
+
239
+ /** Properties used to create a reference data set. */
240
+ export interface ReferenceDataSetCreationProperties {
241
+ /** The list of key properties for the reference data set. */
242
+ keyProperties: ReferenceDataSetKeyProperty[];
243
+ /** The reference data set key comparison behavior can be set using this property. By default, the value is 'Ordinal' - which means case sensitive key comparison will be performed while joining reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set, case insensitive comparison will be used. */
244
+ dataStringComparisonBehavior?: DataStringComparisonBehavior;
245
+ }
246
+
247
+ /** A key property for the reference data set. A reference data set can have multiple key properties. */
248
+ export interface ReferenceDataSetKeyProperty {
249
+ /** The name of the key property. */
250
+ name?: string;
251
+ /** The type of the key property. */
252
+ type?: ReferenceDataKeyPropertyType;
253
+ }
254
+
255
+ /** Properties that are common to all tracked resources. */
94
256
  export interface ResourceProperties {
95
257
  /**
96
- * Provisioning state of the resource. Possible values include: 'Accepted', 'Creating',
97
- * 'Updating', 'Succeeded', 'Failed', 'Deleting'
258
+ * Provisioning state of the resource.
259
+ * NOTE: This property will not be serialized. It can only be populated by the server.
98
260
  */
99
- provisioningState?: ProvisioningState;
261
+ readonly provisioningState?: ProvisioningState;
100
262
  /**
101
263
  * The time the resource was created.
102
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
264
+ * NOTE: This property will not be serialized. It can only be populated by the server.
103
265
  */
104
266
  readonly creationTime?: Date;
105
267
  }
106
268
 
107
- /**
108
- * The sku determines the capacity of the environment, the SLA (in queries-per-minute and total
109
- * capacity), and the billing rate.
110
- */
111
- export interface Sku {
112
- /**
113
- * The name of this SKU. Possible values include: 'S1', 'S2'
114
- */
115
- name: SkuName;
116
- /**
117
- * The capacity of the sku. This value can be changed to support scale out of environments after
118
- * they have been created.
119
- */
120
- capacity: number;
269
+ /** Parameters supplied to the Update Reference Data Set operation. */
270
+ export interface ReferenceDataSetUpdateParameters {
271
+ /** Key-value pairs of additional properties for the reference data set. */
272
+ tags?: { [propertyName: string]: string };
121
273
  }
122
274
 
123
- /**
124
- * Properties required to create any resource tracked by Azure Resource Manager.
125
- */
126
- export interface CreateOrUpdateTrackedResourceProperties {
127
- /**
128
- * The location of the resource.
129
- */
130
- location: string;
131
- /**
132
- * Key-value pairs of additional properties for the resource.
133
- */
134
- tags?: { [propertyName: string]: string };
275
+ /** The response of the List Reference Data Sets operation. */
276
+ export interface ReferenceDataSetListResponse {
277
+ /** Result of the List Reference Data Sets operation. */
278
+ value?: ReferenceDataSetResource[];
135
279
  }
136
280
 
137
- /**
138
- * The structure of the property that a partition key can have. An environment can have multiple
139
- * such properties.
140
- */
141
- export interface PartitionKeyProperty {
142
- /**
143
- * The name of the property.
144
- */
145
- name?: string;
146
- /**
147
- * The type of the property. Possible values include: 'String'
148
- */
149
- type?: PropertyType;
281
+ export interface AccessPolicyCreateOrUpdateParameters {
282
+ /** The objectId of the principal in Azure Active Directory. */
283
+ principalObjectId?: string;
284
+ /** An description of the access policy. */
285
+ description?: string;
286
+ /** The list of roles the principal is assigned on the environment. */
287
+ roles?: AccessPolicyRole[];
150
288
  }
151
289
 
152
- /**
153
- * Parameters supplied to the CreateOrUpdate Environment operation.
154
- */
155
- export interface EnvironmentCreateOrUpdateParameters extends CreateOrUpdateTrackedResourceProperties {
156
- /**
157
- * The sku determines the capacity of the environment, the SLA (in queries-per-minute and total
158
- * capacity), and the billing rate.
159
- */
160
- sku: Sku;
161
- /**
162
- * ISO8601 timespan specifying the minimum number of days the environment's events will be
163
- * available for query.
164
- */
290
+ export interface AccessPolicyUpdateParameters {
291
+ /** An description of the access policy. */
292
+ description?: string;
293
+ /** The list of roles the principal is assigned on the environment. */
294
+ roles?: AccessPolicyRole[];
295
+ }
296
+
297
+ /** The response of the List access policies operation. */
298
+ export interface AccessPolicyListResponse {
299
+ /** Result of the List access policies operation. */
300
+ value?: AccessPolicyResource[];
301
+ }
302
+
303
+ /** The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query. */
304
+ export interface WarmStoreConfigurationProperties {
305
+ /** ISO8601 timespan specifying the number of days the environment's events will be available for query from the warm store. */
306
+ dataRetention: string;
307
+ }
308
+
309
+ /** The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data. */
310
+ export interface Gen2StorageConfigurationInput {
311
+ /** The name of the storage account that will hold the environment's Gen2 data. */
312
+ accountName: string;
313
+ /** The value of the management key that grants the Time Series Insights service write access to the storage account. This property is not shown in environment responses. */
314
+ managementKey: string;
315
+ }
316
+
317
+ /** The storage configuration provides the non-secret connection details about the customer storage account that is used to store the environment's data. */
318
+ export interface Gen2StorageConfigurationOutput {
319
+ /** The name of the storage account that will hold the environment's Gen2 data. */
320
+ accountName: string;
321
+ }
322
+
323
+ /** The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data. */
324
+ export interface Gen2StorageConfigurationMutableProperties {
325
+ /** The value of the management key that grants the Time Series Insights service write access to the storage account. This property is not shown in environment responses. */
326
+ managementKey: string;
327
+ }
328
+
329
+ /** Properties used to create a Gen1 environment. */
330
+ export interface Gen1EnvironmentCreationProperties {
331
+ /** ISO8601 timespan specifying the minimum number of days the environment's events will be available for query. */
165
332
  dataRetentionTime: string;
166
- /**
167
- * The behavior the Time Series Insights service should take when the environment's capacity has
168
- * been exceeded. If "PauseIngress" is specified, new events will not be read from the event
169
- * source. If "PurgeOldData" is specified, new events will continue to be read and old events
170
- * will be deleted from the environment. The default behavior is PurgeOldData. Possible values
171
- * include: 'PurgeOldData', 'PauseIngress'
172
- */
333
+ /** The behavior the Time Series Insights service should take when the environment's capacity has been exceeded. If "PauseIngress" is specified, new events will not be read from the event source. If "PurgeOldData" is specified, new events will continue to be read and old events will be deleted from the environment. The default behavior is PurgeOldData. */
173
334
  storageLimitExceededBehavior?: StorageLimitExceededBehavior;
174
- /**
175
- * The list of partition keys according to which the data in the environment will be ordered.
176
- */
177
- partitionKeyProperties?: PartitionKeyProperty[];
335
+ /** The list of event properties which will be used to partition data in the environment. Currently, only a single partition key property is supported. */
336
+ partitionKeyProperties?: TimeSeriesIdProperty[];
178
337
  }
179
338
 
180
- /**
181
- * Parameters supplied to the Update Environment operation.
182
- */
183
- export interface EnvironmentUpdateParameters {
184
- /**
185
- * The sku of the environment.
186
- */
187
- sku?: Sku;
188
- /**
189
- * Key-value pairs of additional properties for the environment.
190
- */
191
- tags?: { [propertyName: string]: string };
192
- /**
193
- * ISO8601 timespan specifying the minimum number of days the environment's events will be
194
- * available for query.
195
- */
196
- dataRetentionTime?: string;
197
- /**
198
- * The behavior the Time Series Insights service should take when the environment's capacity has
199
- * been exceeded. If "PauseIngress" is specified, new events will not be read from the event
200
- * source. If "PurgeOldData" is specified, new events will continue to be read and old events
201
- * will be deleted from the environment. The default behavior is PurgeOldData. Possible values
202
- * include: 'PurgeOldData', 'PauseIngress'
203
- */
204
- storageLimitExceededBehavior?: StorageLimitExceededBehavior;
205
- /**
206
- * The list of event properties which will be used to partition data in the environment.
207
- */
208
- partitionKeyProperties?: PartitionKeyProperty[];
339
+ /** The structure of the property that a time series id can have. An environment can have multiple such properties. */
340
+ export interface TimeSeriesIdProperty {
341
+ /** The name of the property. */
342
+ name?: string;
343
+ /** The type of the property. */
344
+ type?: PropertyType;
209
345
  }
210
346
 
211
- /**
212
- * An object that contains the details about an environment's state.
213
- */
214
- export interface EnvironmentStateDetails {
347
+ /** An object that represents the status of the environment, and its internal state in the Time Series Insights service. */
348
+ export interface EnvironmentStatus {
215
349
  /**
216
- * Contains the code that represents the reason of an environment being in a particular state.
217
- * Can be used to programmatically handle specific cases.
350
+ * An object that represents the status of ingress on an environment.
351
+ * NOTE: This property will not be serialized. It can only be populated by the server.
218
352
  */
219
- code?: string;
353
+ readonly ingress?: IngressEnvironmentStatus;
220
354
  /**
221
- * A message that describes the state in detail.
355
+ * An object that represents the status of warm storage on an environment.
356
+ * NOTE: This property will not be serialized. It can only be populated by the server.
222
357
  */
223
- message?: string;
358
+ readonly warmStorage?: WarmStorageEnvironmentStatus;
224
359
  }
225
360
 
226
- /**
227
- * An object that represents the status of ingress on an environment.
228
- */
361
+ /** An object that represents the status of ingress on an environment. */
229
362
  export interface IngressEnvironmentStatus {
230
- /**
231
- * This string represents the state of ingress operations on an environment. It can be
232
- * "Disabled", "Ready", "Running", "Paused" or "Unknown". Possible values include: 'Disabled',
233
- * 'Ready', 'Running', 'Paused', 'Unknown'
234
- */
363
+ /** This string represents the state of ingress operations on an environment. It can be "Disabled", "Ready", "Running", "Paused" or "Unknown" */
235
364
  state?: IngressState;
236
365
  /**
237
366
  * An object that contains the details about an environment's state.
367
+ * NOTE: This property will not be serialized. It can only be populated by the server.
238
368
  */
239
- stateDetails?: EnvironmentStateDetails;
369
+ readonly stateDetails?: EnvironmentStateDetails;
240
370
  }
241
371
 
242
- /**
243
- * An object that represents the status of the environment, and its internal state in the Time
244
- * Series Insights service.
245
- */
246
- export interface EnvironmentStatus {
247
- /**
248
- * An object that represents the status of ingress on an environment.
249
- */
250
- ingress?: IngressEnvironmentStatus;
372
+ /** An object that contains the details about an environment's state. */
373
+ export interface EnvironmentStateDetails {
374
+ /** Contains the code that represents the reason of an environment being in a particular state. Can be used to programmatically handle specific cases. */
375
+ code?: string;
376
+ /** A message that describes the state in detail. */
377
+ message?: string;
251
378
  }
252
379
 
253
- /**
254
- * An environment is a set of time-series data available for query, and is the top level Azure Time
255
- * Series Insights resource.
256
- */
257
- export interface EnvironmentResource extends TrackedResource {
258
- /**
259
- * The sku determines the capacity of the environment, the SLA (in queries-per-minute and total
260
- * capacity), and the billing rate.
261
- */
380
+ /** An object that represents the status of warm storage on an environment. */
381
+ export interface WarmStorageEnvironmentStatus {
382
+ /** This string represents the state of warm storage properties usage. It can be "Ok", "Error", "Unknown". */
383
+ state?: WarmStoragePropertiesState;
384
+ /** A value that represents the number of properties used by the environment for S1/S2 SKU and number of properties used by Warm Store for PAYG SKU */
385
+ currentCount?: number;
386
+ /** A value that represents the maximum number of properties used allowed by the environment for S1/S2 SKU and maximum number of properties allowed by Warm Store for PAYG SKU. */
387
+ maxCount?: number;
388
+ }
389
+
390
+ /** An object that represents a set of mutable event source resource properties. */
391
+ export interface EventSourceMutableProperties {
392
+ /** The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used. */
393
+ timestampPropertyName?: string;
394
+ }
395
+
396
+ /** Parameters supplied to the CreateOrUpdate Environment operation. */
397
+ export type EnvironmentCreateOrUpdateParameters = CreateOrUpdateTrackedResourceProperties & {
398
+ /** The kind of the environment. */
399
+ kind: EnvironmentKind;
400
+ /** The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku determines the capacity of the environment, the ingress rate, and the billing rate. */
401
+ sku: Sku;
402
+ };
403
+
404
+ /** Parameters supplied to the Create or Update Event Source operation. */
405
+ export type EventSourceCreateOrUpdateParameters = CreateOrUpdateTrackedResourceProperties & {
406
+ /** The kind of the event source. */
407
+ kind: EventSourceKind;
408
+ /** An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events. */
409
+ localTimestamp?: LocalTimestamp;
410
+ };
411
+
412
+ export type ReferenceDataSetCreateOrUpdateParameters = CreateOrUpdateTrackedResourceProperties & {
413
+ /** The list of key properties for the reference data set. */
414
+ keyProperties: ReferenceDataSetKeyProperty[];
415
+ /** The reference data set key comparison behavior can be set using this property. By default, the value is 'Ordinal' - which means case sensitive key comparison will be performed while joining reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set, case insensitive comparison will be used. */
416
+ dataStringComparisonBehavior?: DataStringComparisonBehavior;
417
+ };
418
+
419
+ /** Time Series Insights resource that is tracked by Azure Resource Manager. */
420
+ export type TrackedResource = Resource & {
421
+ /** Resource location */
422
+ location: string;
423
+ /** Resource tags */
424
+ tags?: { [propertyName: string]: string };
425
+ };
426
+
427
+ /** An access policy is used to grant users and applications access to the environment. Roles are assigned to service principals in Azure Active Directory. These roles define the actions the principal can perform through the Time Series Insights data plane APIs. */
428
+ export type AccessPolicyResource = Resource & {
429
+ /** The objectId of the principal in Azure Active Directory. */
430
+ principalObjectId?: string;
431
+ /** An description of the access policy. */
432
+ description?: string;
433
+ /** The list of roles the principal is assigned on the environment. */
434
+ roles?: AccessPolicyRole[];
435
+ };
436
+
437
+ /** Parameters supplied to the Update Environment operation to update a Gen1 environment. */
438
+ export type Gen1EnvironmentUpdateParameters = EnvironmentUpdateParameters & {
439
+ /** Polymorphic discriminator, which specifies the different types this object can be */
440
+ kind: "Gen1";
441
+ /** The sku of the environment. */
262
442
  sku?: Sku;
263
- /**
264
- * ISO8601 timespan specifying the minimum number of days the environment's events will be
265
- * available for query.
266
- */
267
- dataRetentionTime: string;
268
- /**
269
- * The behavior the Time Series Insights service should take when the environment's capacity has
270
- * been exceeded. If "PauseIngress" is specified, new events will not be read from the event
271
- * source. If "PurgeOldData" is specified, new events will continue to be read and old events
272
- * will be deleted from the environment. The default behavior is PurgeOldData. Possible values
273
- * include: 'PurgeOldData', 'PauseIngress'
274
- */
443
+ /** ISO8601 timespan specifying the minimum number of days the environment's events will be available for query. */
444
+ dataRetentionTime?: string;
445
+ /** The behavior the Time Series Insights service should take when the environment's capacity has been exceeded. If "PauseIngress" is specified, new events will not be read from the event source. If "PurgeOldData" is specified, new events will continue to be read and old events will be deleted from the environment. The default behavior is PurgeOldData. */
275
446
  storageLimitExceededBehavior?: StorageLimitExceededBehavior;
447
+ };
448
+
449
+ /** Parameters supplied to the Update Environment operation to update a Gen2 environment. */
450
+ export type Gen2EnvironmentUpdateParameters = EnvironmentUpdateParameters & {
451
+ /** Polymorphic discriminator, which specifies the different types this object can be */
452
+ kind: "Gen2";
453
+ /** The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data. */
454
+ storageConfiguration?: Gen2StorageConfigurationMutableProperties;
455
+ /** The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query. */
456
+ warmStoreConfiguration?: WarmStoreConfigurationProperties;
457
+ };
458
+
459
+ /** Parameters supplied to the Update Event Source operation to update an EventHub event source. */
460
+ export type EventHubEventSourceUpdateParameters = EventSourceUpdateParameters & {
461
+ /** Polymorphic discriminator, which specifies the different types this object can be */
462
+ kind: "Microsoft.EventHub";
463
+ /** The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used. */
464
+ timestampPropertyName?: string;
465
+ /** The value of the shared access key that grants the Time Series Insights service read access to the event hub. This property is not shown in event source responses. */
466
+ sharedAccessKey?: string;
467
+ };
468
+
469
+ /** Parameters supplied to the Update Event Source operation to update an IoTHub event source. */
470
+ export type IoTHubEventSourceUpdateParameters = EventSourceUpdateParameters & {
471
+ /** Polymorphic discriminator, which specifies the different types this object can be */
472
+ kind: "Microsoft.IoTHub";
473
+ /** The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used. */
474
+ timestampPropertyName?: string;
475
+ /** The value of the shared access key that grants the Time Series Insights service read access to the iot hub. This property is not shown in event source responses. */
476
+ sharedAccessKey?: string;
477
+ };
478
+
479
+ /** Properties of the reference data set. */
480
+ export type ReferenceDataSetResourceProperties = ReferenceDataSetCreationProperties &
481
+ ResourceProperties & {};
482
+
483
+ /** Properties of the environment. */
484
+ export type EnvironmentResourceProperties = ResourceProperties & {
276
485
  /**
277
- * The list of partition keys according to which the data in the environment will be ordered.
278
- */
279
- partitionKeyProperties?: PartitionKeyProperty[];
280
- /**
281
- * Provisioning state of the resource. Possible values include: 'Accepted', 'Creating',
282
- * 'Updating', 'Succeeded', 'Failed', 'Deleting'
283
- */
284
- provisioningState?: ProvisioningState;
285
- /**
286
- * The time the resource was created.
287
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
288
- */
289
- readonly creationTime?: Date;
290
- /**
291
- * An id used to access the environment data, e.g. to query the environment's events or upload
292
- * reference data for the environment.
293
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
486
+ * An id used to access the environment data, e.g. to query the environment's events or upload reference data for the environment.
487
+ * NOTE: This property will not be serialized. It can only be populated by the server.
294
488
  */
295
489
  readonly dataAccessId?: string;
296
490
  /**
297
- * The fully qualified domain name used to access the environment data, e.g. to query the
298
- * environment's events or upload reference data for the environment.
299
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
491
+ * The fully qualified domain name used to access the environment data, e.g. to query the environment's events or upload reference data for the environment.
492
+ * NOTE: This property will not be serialized. It can only be populated by the server.
300
493
  */
301
494
  readonly dataAccessFqdn?: string;
302
495
  /**
303
- * An object that represents the status of the environment, and its internal state in the Time
304
- * Series Insights service.
496
+ * An object that represents the status of the environment, and its internal state in the Time Series Insights service.
497
+ * NOTE: This property will not be serialized. It can only be populated by the server.
305
498
  */
306
- status?: EnvironmentStatus;
307
- }
308
-
309
- /**
310
- * The response of the List Environments operation.
311
- */
312
- export interface EnvironmentListResponse {
313
- /**
314
- * Result of the List Environments operation.
315
- */
316
- value?: EnvironmentResource[];
317
- }
318
-
319
- /**
320
- * Contains the possible cases for EventSourceCreateOrUpdateParameters.
321
- */
322
- export type EventSourceCreateOrUpdateParametersUnion = EventSourceCreateOrUpdateParameters | EventHubEventSourceCreateOrUpdateParameters | IoTHubEventSourceCreateOrUpdateParameters;
323
-
324
- /**
325
- * Parameters supplied to the Create or Update Event Source operation.
326
- */
327
- export interface EventSourceCreateOrUpdateParameters {
328
- /**
329
- * Polymorphic Discriminator
330
- */
331
- kind: "EventSourceCreateOrUpdateParameters";
332
- /**
333
- * The location of the resource.
334
- */
335
- location: string;
336
- /**
337
- * Key-value pairs of additional properties for the resource.
338
- */
339
- tags?: { [propertyName: string]: string };
340
- }
341
-
342
- /**
343
- * Parameters supplied to the Create or Update Event Source operation for an EventHub event source.
344
- */
345
- export interface EventHubEventSourceCreateOrUpdateParameters {
346
- /**
347
- * Polymorphic Discriminator
348
- */
349
- kind: "Microsoft.EventHub";
350
- /**
351
- * The location of the resource.
352
- */
353
- location: string;
354
- /**
355
- * Key-value pairs of additional properties for the resource.
356
- */
357
- tags?: { [propertyName: string]: string };
358
- /**
359
- * Provisioning state of the resource. Possible values include: 'Accepted', 'Creating',
360
- * 'Updating', 'Succeeded', 'Failed', 'Deleting'
361
- */
362
- provisioningState?: ProvisioningState;
363
- /**
364
- * The time the resource was created.
365
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
366
- */
367
- readonly creationTime?: Date;
368
- /**
369
- * The event property that will be used as the event source's timestamp. If a value isn't
370
- * specified for timestampPropertyName, or if null or empty-string is specified, the event
371
- * creation time will be used.
372
- */
373
- timestampPropertyName?: string;
374
- /**
375
- * The resource id of the event source in Azure Resource Manager.
376
- */
377
- eventSourceResourceId: string;
378
- /**
379
- * The name of the service bus that contains the event hub.
380
- */
381
- serviceBusNamespace: string;
382
- /**
383
- * The name of the event hub.
384
- */
385
- eventHubName: string;
386
- /**
387
- * The name of the event hub's consumer group that holds the partitions from which events will be
388
- * read.
389
- */
390
- consumerGroupName: string;
391
- /**
392
- * The name of the SAS key that grants the Time Series Insights service access to the event hub.
393
- * The shared access policies for this key must grant 'Listen' permissions to the event hub.
394
- */
395
- keyName: string;
396
- /**
397
- * The value of the shared access key that grants the Time Series Insights service read access to
398
- * the event hub. This property is not shown in event source responses.
399
- */
400
- sharedAccessKey: string;
401
- }
499
+ readonly status?: EnvironmentStatus;
500
+ };
402
501
 
403
- /**
404
- * Parameters supplied to the Create or Update Event Source operation for an IoTHub event source.
405
- */
406
- export interface IoTHubEventSourceCreateOrUpdateParameters {
407
- /**
408
- * Polymorphic Discriminator
409
- */
410
- kind: "Microsoft.IoTHub";
411
- /**
412
- * The location of the resource.
413
- */
414
- location: string;
415
- /**
416
- * Key-value pairs of additional properties for the resource.
417
- */
418
- tags?: { [propertyName: string]: string };
419
- /**
420
- * Provisioning state of the resource. Possible values include: 'Accepted', 'Creating',
421
- * 'Updating', 'Succeeded', 'Failed', 'Deleting'
422
- */
423
- provisioningState?: ProvisioningState;
424
- /**
425
- * The time the resource was created.
426
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
427
- */
428
- readonly creationTime?: Date;
429
- /**
430
- * The event property that will be used as the event source's timestamp. If a value isn't
431
- * specified for timestampPropertyName, or if null or empty-string is specified, the event
432
- * creation time will be used.
433
- */
502
+ /** Properties of the event source. */
503
+ export type EventSourceCommonProperties = ResourceProperties & {
504
+ /** The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used. */
434
505
  timestampPropertyName?: string;
435
- /**
436
- * The resource id of the event source in Azure Resource Manager.
437
- */
438
- eventSourceResourceId: string;
439
- /**
440
- * The name of the iot hub.
441
- */
442
- iotHubName: string;
443
- /**
444
- * The name of the iot hub's consumer group that holds the partitions from which events will be
445
- * read.
446
- */
447
- consumerGroupName: string;
448
- /**
449
- * The name of the Shared Access Policy key that grants the Time Series Insights service access
450
- * to the iot hub. This shared access policy key must grant 'service connect' permissions to the
451
- * iot hub.
452
- */
453
- keyName: string;
454
- /**
455
- * The value of the Shared Access Policy key that grants the Time Series Insights service read
456
- * access to the iot hub. This property is not shown in event source responses.
457
- */
458
- sharedAccessKey: string;
459
- }
506
+ /** An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events. */
507
+ localTimestamp?: LocalTimestamp;
508
+ /** The type of the ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime". */
509
+ type?: IngressStartAtType;
510
+ /** ISO8601 UTC datetime with seconds precision (milliseconds are optional), specifying the date and time that will be the starting point for Events to be consumed. */
511
+ time?: string;
512
+ };
460
513
 
461
- /**
462
- * Parameters supplied to the Update Event Source operation.
463
- */
464
- export interface EventSourceUpdateParameters {
465
- /**
466
- * Key-value pairs of additional properties for the event source.
467
- */
468
- tags?: { [propertyName: string]: string };
469
- }
514
+ /** Properties of the Gen1 environment. */
515
+ export type Gen1EnvironmentResourceProperties = Gen1EnvironmentCreationProperties &
516
+ EnvironmentResourceProperties & {};
470
517
 
471
- /**
472
- * Parameters supplied to the Update Event Source operation to update an EventHub event source.
473
- */
474
- export interface EventHubEventSourceUpdateParameters extends EventSourceUpdateParameters {
475
- /**
476
- * The event property that will be used as the event source's timestamp. If a value isn't
477
- * specified for timestampPropertyName, or if null or empty-string is specified, the event
478
- * creation time will be used.
479
- */
480
- timestampPropertyName?: string;
481
- /**
482
- * An object that represents the local timestamp property. It contains the format of local
483
- * timestamp that needs to be used and the corresponding timezone offset information. If a value
484
- * isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed
485
- * with the events.
486
- */
487
- localTimestamp?: LocalTimestamp;
488
- /**
489
- * The value of the shared access key that grants the Time Series Insights service read access to
490
- * the event hub. This property is not shown in event source responses.
491
- */
518
+ /** An object that represents a set of mutable EventHub event source resource properties. */
519
+ export type EventHubEventSourceMutableProperties = EventSourceMutableProperties & {
520
+ /** The value of the shared access key that grants the Time Series Insights service read access to the event hub. This property is not shown in event source responses. */
492
521
  sharedAccessKey?: string;
493
- }
522
+ };
494
523
 
495
- /**
496
- * Parameters supplied to the Update Event Source operation to update an IoTHub event source.
497
- */
498
- export interface IoTHubEventSourceUpdateParameters extends EventSourceUpdateParameters {
499
- /**
500
- * The event property that will be used as the event source's timestamp. If a value isn't
501
- * specified for timestampPropertyName, or if null or empty-string is specified, the event
502
- * creation time will be used.
503
- */
504
- timestampPropertyName?: string;
505
- /**
506
- * An object that represents the local timestamp property. It contains the format of local
507
- * timestamp that needs to be used and the corresponding timezone offset information. If a value
508
- * isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed
509
- * with the events.
510
- */
511
- localTimestamp?: LocalTimestamp;
512
- /**
513
- * The value of the shared access key that grants the Time Series Insights service read access to
514
- * the iot hub. This property is not shown in event source responses.
515
- */
524
+ /** An object that represents a set of mutable IoTHub event source resource properties. */
525
+ export type IoTHubEventSourceMutableProperties = EventSourceMutableProperties & {
526
+ /** The value of the shared access key that grants the Time Series Insights service read access to the iot hub. This property is not shown in event source responses. */
516
527
  sharedAccessKey?: string;
517
- }
518
-
519
- /**
520
- * Contains the possible cases for EventSourceResource.
521
- */
522
- export type EventSourceResourceUnion = EventSourceResource | EventHubEventSourceResource | IoTHubEventSourceResource;
528
+ };
523
529
 
524
- /**
525
- * An environment receives data from one or more event sources. Each event source has associated
526
- * connection info that allows the Time Series Insights ingress pipeline to connect to and pull
527
- * data from the event source
528
- */
529
- export interface EventSourceResource {
530
- /**
531
- * Polymorphic Discriminator
532
- */
533
- kind: "EventSourceResource";
534
- /**
535
- * Resource Id
536
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
537
- */
538
- readonly id?: string;
539
- /**
540
- * Resource name
541
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
542
- */
543
- readonly name?: string;
544
- /**
545
- * Resource type
546
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
547
- */
548
- readonly type?: string;
549
- /**
550
- * Resource location
551
- */
552
- location: string;
553
- /**
554
- * Resource tags
555
- */
556
- tags?: { [propertyName: string]: string };
557
- }
530
+ /** Parameters supplied to the Create or Update Environment operation for a Gen1 environment. */
531
+ export type Gen1EnvironmentCreateOrUpdateParameters = EnvironmentCreateOrUpdateParameters & {
532
+ /** ISO8601 timespan specifying the minimum number of days the environment's events will be available for query. */
533
+ dataRetentionTime: string;
534
+ /** The behavior the Time Series Insights service should take when the environment's capacity has been exceeded. If "PauseIngress" is specified, new events will not be read from the event source. If "PurgeOldData" is specified, new events will continue to be read and old events will be deleted from the environment. The default behavior is PurgeOldData. */
535
+ storageLimitExceededBehavior?: StorageLimitExceededBehavior;
536
+ /** The list of event properties which will be used to partition data in the environment. Currently, only a single partition key property is supported. */
537
+ partitionKeyProperties?: TimeSeriesIdProperty[];
538
+ };
558
539
 
559
- /**
560
- * The response of the List EventSources operation.
561
- */
562
- export interface EventSourceListResponse {
563
- /**
564
- * Result of the List EventSources operation.
565
- */
566
- value?: EventSourceResourceUnion[];
567
- }
540
+ /** Parameters supplied to the Create or Update Environment operation for a Gen2 environment. */
541
+ export type Gen2EnvironmentCreateOrUpdateParameters = EnvironmentCreateOrUpdateParameters & {
542
+ /** The list of event properties which will be used to define the environment's time series id. */
543
+ timeSeriesIdProperties: TimeSeriesIdProperty[];
544
+ /** The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data. */
545
+ storageConfiguration: Gen2StorageConfigurationInput;
546
+ /** The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query. */
547
+ warmStoreConfiguration?: WarmStoreConfigurationProperties;
548
+ };
568
549
 
569
- /**
570
- * An event source that receives its data from an Azure EventHub.
571
- */
572
- export interface EventHubEventSourceResource {
573
- /**
574
- * Polymorphic Discriminator
575
- */
576
- kind: "Microsoft.EventHub";
577
- /**
578
- * Resource Id
579
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
580
- */
581
- readonly id?: string;
582
- /**
583
- * Resource name
584
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
585
- */
586
- readonly name?: string;
587
- /**
588
- * Resource type
589
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
590
- */
591
- readonly type?: string;
592
- /**
593
- * Resource location
594
- */
595
- location: string;
596
- /**
597
- * Resource tags
598
- */
599
- tags?: { [propertyName: string]: string };
550
+ /** Parameters supplied to the Create or Update Event Source operation for an EventHub event source. */
551
+ export type EventHubEventSourceCreateOrUpdateParameters = EventSourceCreateOrUpdateParameters & {
600
552
  /**
601
- * Provisioning state of the resource. Possible values include: 'Accepted', 'Creating',
602
- * 'Updating', 'Succeeded', 'Failed', 'Deleting'
553
+ * Provisioning state of the resource.
554
+ * NOTE: This property will not be serialized. It can only be populated by the server.
603
555
  */
604
- provisioningState?: ProvisioningState;
556
+ readonly provisioningState?: ProvisioningState;
605
557
  /**
606
558
  * The time the resource was created.
607
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
559
+ * NOTE: This property will not be serialized. It can only be populated by the server.
608
560
  */
609
561
  readonly creationTime?: Date;
610
- /**
611
- * The event property that will be used as the event source's timestamp. If a value isn't
612
- * specified for timestampPropertyName, or if null or empty-string is specified, the event
613
- * creation time will be used.
614
- */
562
+ /** The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used. */
615
563
  timestampPropertyName?: string;
616
- /**
617
- * The resource id of the event source in Azure Resource Manager.
618
- */
564
+ /** An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events. */
565
+ localTimestampPropertiesLocalTimestamp?: LocalTimestamp;
566
+ /** The type of the ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime". */
567
+ type?: IngressStartAtType;
568
+ /** ISO8601 UTC datetime with seconds precision (milliseconds are optional), specifying the date and time that will be the starting point for Events to be consumed. */
569
+ time?: string;
570
+ /** The resource id of the event source in Azure Resource Manager. */
619
571
  eventSourceResourceId: string;
620
- /**
621
- * The name of the service bus that contains the event hub.
622
- */
572
+ /** The name of the service bus that contains the event hub. */
623
573
  serviceBusNamespace: string;
624
- /**
625
- * The name of the event hub.
626
- */
574
+ /** The name of the event hub. */
627
575
  eventHubName: string;
628
- /**
629
- * The name of the event hub's consumer group that holds the partitions from which events will be
630
- * read.
631
- */
576
+ /** The name of the event hub's consumer group that holds the partitions from which events will be read. */
632
577
  consumerGroupName: string;
633
- /**
634
- * The name of the SAS key that grants the Time Series Insights service access to the event hub.
635
- * The shared access policies for this key must grant 'Listen' permissions to the event hub.
636
- */
578
+ /** The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access policies for this key must grant 'Listen' permissions to the event hub. */
637
579
  keyName: string;
638
- }
580
+ /** The value of the shared access key that grants the Time Series Insights service read access to the event hub. This property is not shown in event source responses. */
581
+ sharedAccessKey: string;
582
+ };
639
583
 
640
- /**
641
- * An event source that receives its data from an Azure IoTHub.
642
- */
643
- export interface IoTHubEventSourceResource {
584
+ /** Parameters supplied to the Create or Update Event Source operation for an IoTHub event source. */
585
+ export type IoTHubEventSourceCreateOrUpdateParameters = EventSourceCreateOrUpdateParameters & {
644
586
  /**
645
- * Polymorphic Discriminator
587
+ * Provisioning state of the resource.
588
+ * NOTE: This property will not be serialized. It can only be populated by the server.
646
589
  */
647
- kind: "Microsoft.IotHub";
648
- /**
649
- * Resource Id
650
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
651
- */
652
- readonly id?: string;
653
- /**
654
- * Resource name
655
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
656
- */
657
- readonly name?: string;
658
- /**
659
- * Resource type
660
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
661
- */
662
- readonly type?: string;
663
- /**
664
- * Resource location
665
- */
666
- location: string;
667
- /**
668
- * Resource tags
669
- */
670
- tags?: { [propertyName: string]: string };
671
- /**
672
- * Provisioning state of the resource. Possible values include: 'Accepted', 'Creating',
673
- * 'Updating', 'Succeeded', 'Failed', 'Deleting'
674
- */
675
- provisioningState?: ProvisioningState;
590
+ readonly provisioningState?: ProvisioningState;
676
591
  /**
677
592
  * The time the resource was created.
678
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
593
+ * NOTE: This property will not be serialized. It can only be populated by the server.
679
594
  */
680
595
  readonly creationTime?: Date;
681
- /**
682
- * The event property that will be used as the event source's timestamp. If a value isn't
683
- * specified for timestampPropertyName, or if null or empty-string is specified, the event
684
- * creation time will be used.
685
- */
596
+ /** The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used. */
686
597
  timestampPropertyName?: string;
687
- /**
688
- * The resource id of the event source in Azure Resource Manager.
689
- */
598
+ /** An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events. */
599
+ localTimestampPropertiesLocalTimestamp?: LocalTimestamp;
600
+ /** The type of the ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime". */
601
+ type?: IngressStartAtType;
602
+ /** ISO8601 UTC datetime with seconds precision (milliseconds are optional), specifying the date and time that will be the starting point for Events to be consumed. */
603
+ time?: string;
604
+ /** The resource id of the event source in Azure Resource Manager. */
690
605
  eventSourceResourceId: string;
691
- /**
692
- * The name of the iot hub.
693
- */
606
+ /** The name of the iot hub. */
694
607
  iotHubName: string;
695
- /**
696
- * The name of the iot hub's consumer group that holds the partitions from which events will be
697
- * read.
698
- */
608
+ /** The name of the iot hub's consumer group that holds the partitions from which events will be read. */
699
609
  consumerGroupName: string;
700
- /**
701
- * The name of the Shared Access Policy key that grants the Time Series Insights service access
702
- * to the iot hub. This shared access policy key must grant 'service connect' permissions to the
703
- * iot hub.
704
- */
610
+ /** The name of the Shared Access Policy key that grants the Time Series Insights service access to the iot hub. This shared access policy key must grant 'service connect' permissions to the iot hub. */
705
611
  keyName: string;
706
- }
707
-
708
- /**
709
- * Properties of the event source.
710
- */
711
- export interface EventSourceCommonProperties extends ResourceProperties {
712
- /**
713
- * The event property that will be used as the event source's timestamp. If a value isn't
714
- * specified for timestampPropertyName, or if null or empty-string is specified, the event
715
- * creation time will be used.
716
- */
717
- timestampPropertyName?: string;
718
- }
719
-
720
- /**
721
- * Properties of an event source that reads events from an event broker in Azure.
722
- */
723
- export interface AzureEventSourceProperties extends EventSourceCommonProperties {
724
- /**
725
- * The resource id of the event source in Azure Resource Manager.
726
- */
727
- eventSourceResourceId: string;
728
- }
729
-
730
- /**
731
- * Properties of the EventHub event source.
732
- */
733
- export interface EventHubEventSourceCommonProperties extends AzureEventSourceProperties {
734
- /**
735
- * The name of the service bus that contains the event hub.
736
- */
737
- serviceBusNamespace: string;
738
- /**
739
- * The name of the event hub.
740
- */
741
- eventHubName: string;
742
- /**
743
- * The name of the event hub's consumer group that holds the partitions from which events will be
744
- * read.
745
- */
746
- consumerGroupName: string;
747
- /**
748
- * The name of the SAS key that grants the Time Series Insights service access to the event hub.
749
- * The shared access policies for this key must grant 'Listen' permissions to the event hub.
750
- */
751
- keyName: string;
752
- }
612
+ /** The value of the Shared Access Policy key that grants the Time Series Insights service read access to the iot hub. This property is not shown in event source responses. */
613
+ sharedAccessKey: string;
614
+ };
753
615
 
754
- /**
755
- * Properties of the IoTHub event source.
756
- */
757
- export interface IoTHubEventSourceCommonProperties extends AzureEventSourceProperties {
758
- /**
759
- * The name of the iot hub.
760
- */
761
- iotHubName: string;
762
- /**
763
- * The name of the iot hub's consumer group that holds the partitions from which events will be
764
- * read.
765
- */
766
- consumerGroupName: string;
767
- /**
768
- * The name of the Shared Access Policy key that grants the Time Series Insights service access
769
- * to the iot hub. This shared access policy key must grant 'service connect' permissions to the
770
- * iot hub.
771
- */
772
- keyName: string;
773
- }
616
+ /** An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource. */
617
+ export type EnvironmentResource = TrackedResource & {
618
+ /** The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku determines the capacity of the environment, the ingress rate, and the billing rate. */
619
+ sku: Sku;
620
+ /** The kind of the environment. */
621
+ kind: EnvironmentResourceKind;
622
+ };
774
623
 
775
- /**
776
- * An object that represents the offset information for the local timestamp format specified.
777
- * Should not be specified for LocalTimestampFormat - Embedded.
778
- */
779
- export interface LocalTimestampTimeZoneOffset {
780
- /**
781
- * The event property that will be contain the offset information to calculate the local
782
- * timestamp. When the LocalTimestampFormat is Iana, the property name will contain the name of
783
- * the column which contains IANA Timezone Name (eg: Americas/Los Angeles). When
784
- * LocalTimestampFormat is Timespan, it contains the name of property which contains values
785
- * representing the offset (eg: P1D or 1.00:00:00)
786
- */
787
- propertyName?: string;
788
- }
624
+ /** An environment receives data from one or more event sources. Each event source has associated connection info that allows the Time Series Insights ingress pipeline to connect to and pull data from the event source */
625
+ export type EventSourceResource = TrackedResource & {
626
+ /** The kind of the event source. */
627
+ kind: EventSourceResourceKind;
628
+ };
789
629
 
790
- /**
791
- * An object that represents the local timestamp property. It contains the format of local
792
- * timestamp that needs to be used and the corresponding timezone offset information. If a value
793
- * isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed
794
- * with the events.
795
- */
796
- export interface LocalTimestamp {
630
+ /** A reference data set provides metadata about the events in an environment. Metadata in the reference data set will be joined with events as they are read from event sources. The metadata that makes up the reference data set is uploaded or modified through the Time Series Insights data plane APIs. */
631
+ export type ReferenceDataSetResource = TrackedResource & {
632
+ /** The list of key properties for the reference data set. */
633
+ keyProperties?: ReferenceDataSetKeyProperty[];
634
+ /** The reference data set key comparison behavior can be set using this property. By default, the value is 'Ordinal' - which means case sensitive key comparison will be performed while joining reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set, case insensitive comparison will be used. */
635
+ dataStringComparisonBehavior?: DataStringComparisonBehavior;
797
636
  /**
798
- * An enum that represents the format of the local timestamp property that needs to be set.
799
- * Possible values include: 'Embedded', 'Iana', 'TimeSpan'
637
+ * Provisioning state of the resource.
638
+ * NOTE: This property will not be serialized. It can only be populated by the server.
800
639
  */
801
- format?: LocalTimestampFormat;
640
+ readonly provisioningState?: ProvisioningState;
802
641
  /**
803
- * An object that represents the offset information for the local timestamp format specified.
804
- * Should not be specified for LocalTimestampFormat - Embedded.
642
+ * The time the resource was created.
643
+ * NOTE: This property will not be serialized. It can only be populated by the server.
805
644
  */
806
- timeZoneOffset?: LocalTimestampTimeZoneOffset;
807
- }
645
+ readonly creationTime?: Date;
646
+ };
808
647
 
809
- /**
810
- * An object that represents a set of mutable event source resource properties.
811
- */
812
- export interface EventSourceMutableProperties {
813
- /**
814
- * The event property that will be used as the event source's timestamp. If a value isn't
815
- * specified for timestampPropertyName, or if null or empty-string is specified, the event
816
- * creation time will be used.
817
- */
818
- timestampPropertyName?: string;
819
- /**
820
- * An object that represents the local timestamp property. It contains the format of local
821
- * timestamp that needs to be used and the corresponding timezone offset information. If a value
822
- * isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed
823
- * with the events.
824
- */
825
- localTimestamp?: LocalTimestamp;
826
- }
648
+ /** Properties of the Gen2 environment. */
649
+ export type Gen2EnvironmentResourceProperties = EnvironmentResourceProperties & {
650
+ /** The list of event properties which will be used to define the environment's time series id. */
651
+ timeSeriesIdProperties: TimeSeriesIdProperty[];
652
+ /** The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data. */
653
+ storageConfiguration: Gen2StorageConfigurationOutput;
654
+ /** The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query. */
655
+ warmStoreConfiguration?: WarmStoreConfigurationProperties;
656
+ };
827
657
 
828
- /**
829
- * A key property for the reference data set. A reference data set can have multiple key
830
- * properties.
831
- */
832
- export interface ReferenceDataSetKeyProperty {
833
- /**
834
- * The name of the key property.
835
- */
836
- name?: string;
837
- /**
838
- * The type of the key property. Possible values include: 'String', 'Double', 'Bool', 'DateTime'
839
- */
840
- type?: ReferenceDataKeyPropertyType;
841
- }
658
+ /** Properties of an event source that reads events from an event broker in Azure. */
659
+ export type AzureEventSourceProperties = EventSourceCommonProperties & {
660
+ /** The resource id of the event source in Azure Resource Manager. */
661
+ eventSourceResourceId: string;
662
+ };
842
663
 
843
- /**
844
- * An interface representing ReferenceDataSetCreateOrUpdateParameters.
845
- */
846
- export interface ReferenceDataSetCreateOrUpdateParameters extends CreateOrUpdateTrackedResourceProperties {
664
+ /** An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource. Gen1 environments have data retention limits. */
665
+ export type Gen1EnvironmentResource = EnvironmentResource & {
666
+ /** ISO8601 timespan specifying the minimum number of days the environment's events will be available for query. */
667
+ dataRetentionTime: string;
668
+ /** The behavior the Time Series Insights service should take when the environment's capacity has been exceeded. If "PauseIngress" is specified, new events will not be read from the event source. If "PurgeOldData" is specified, new events will continue to be read and old events will be deleted from the environment. The default behavior is PurgeOldData. */
669
+ storageLimitExceededBehavior?: StorageLimitExceededBehavior;
670
+ /** The list of event properties which will be used to partition data in the environment. Currently, only a single partition key property is supported. */
671
+ partitionKeyProperties?: TimeSeriesIdProperty[];
847
672
  /**
848
- * The list of key properties for the reference data set.
673
+ * Provisioning state of the resource.
674
+ * NOTE: This property will not be serialized. It can only be populated by the server.
849
675
  */
850
- keyProperties: ReferenceDataSetKeyProperty[];
676
+ readonly provisioningState?: ProvisioningState;
851
677
  /**
852
- * The reference data set key comparison behavior can be set using this property. By default, the
853
- * value is 'Ordinal' - which means case sensitive key comparison will be performed while joining
854
- * reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is
855
- * set, case insensitive comparison will be used. Possible values include: 'Ordinal',
856
- * 'OrdinalIgnoreCase'
678
+ * The time the resource was created.
679
+ * NOTE: This property will not be serialized. It can only be populated by the server.
857
680
  */
858
- dataStringComparisonBehavior?: DataStringComparisonBehavior;
859
- }
860
-
861
- /**
862
- * Parameters supplied to the Update Reference Data Set operation.
863
- */
864
- export interface ReferenceDataSetUpdateParameters {
681
+ readonly creationTime?: Date;
865
682
  /**
866
- * Key-value pairs of additional properties for the reference data set.
683
+ * An id used to access the environment data, e.g. to query the environment's events or upload reference data for the environment.
684
+ * NOTE: This property will not be serialized. It can only be populated by the server.
867
685
  */
868
- tags?: { [propertyName: string]: string };
869
- }
870
-
871
- /**
872
- * A reference data set provides metadata about the events in an environment. Metadata in the
873
- * reference data set will be joined with events as they are read from event sources. The metadata
874
- * that makes up the reference data set is uploaded or modified through the Time Series Insights
875
- * data plane APIs.
876
- */
877
- export interface ReferenceDataSetResource extends TrackedResource {
686
+ readonly dataAccessId?: string;
878
687
  /**
879
- * The list of key properties for the reference data set.
688
+ * The fully qualified domain name used to access the environment data, e.g. to query the environment's events or upload reference data for the environment.
689
+ * NOTE: This property will not be serialized. It can only be populated by the server.
880
690
  */
881
- keyProperties: ReferenceDataSetKeyProperty[];
691
+ readonly dataAccessFqdn?: string;
882
692
  /**
883
- * The reference data set key comparison behavior can be set using this property. By default, the
884
- * value is 'Ordinal' - which means case sensitive key comparison will be performed while joining
885
- * reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is
886
- * set, case insensitive comparison will be used. Possible values include: 'Ordinal',
887
- * 'OrdinalIgnoreCase'
693
+ * An object that represents the status of the environment, and its internal state in the Time Series Insights service.
694
+ * NOTE: This property will not be serialized. It can only be populated by the server.
888
695
  */
889
- dataStringComparisonBehavior?: DataStringComparisonBehavior;
696
+ readonly status?: EnvironmentStatus;
697
+ };
698
+
699
+ /** An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource. Gen2 environments do not have set data retention limits. */
700
+ export type Gen2EnvironmentResource = EnvironmentResource & {
890
701
  /**
891
- * Provisioning state of the resource. Possible values include: 'Accepted', 'Creating',
892
- * 'Updating', 'Succeeded', 'Failed', 'Deleting'
702
+ * Provisioning state of the resource.
703
+ * NOTE: This property will not be serialized. It can only be populated by the server.
893
704
  */
894
- provisioningState?: ProvisioningState;
705
+ readonly provisioningState?: ProvisioningState;
895
706
  /**
896
707
  * The time the resource was created.
897
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
708
+ * NOTE: This property will not be serialized. It can only be populated by the server.
898
709
  */
899
710
  readonly creationTime?: Date;
900
- }
901
-
902
- /**
903
- * The response of the List Reference Data Sets operation.
904
- */
905
- export interface ReferenceDataSetListResponse {
906
- /**
907
- * Result of the List Reference Data Sets operation.
908
- */
909
- value?: ReferenceDataSetResource[];
910
- }
911
-
912
- /**
913
- * An interface representing AccessPolicyCreateOrUpdateParameters.
914
- */
915
- export interface AccessPolicyCreateOrUpdateParameters {
916
711
  /**
917
- * The objectId of the principal in Azure Active Directory.
712
+ * An id used to access the environment data, e.g. to query the environment's events or upload reference data for the environment.
713
+ * NOTE: This property will not be serialized. It can only be populated by the server.
918
714
  */
919
- principalObjectId?: string;
715
+ readonly dataAccessId?: string;
920
716
  /**
921
- * An description of the access policy.
717
+ * The fully qualified domain name used to access the environment data, e.g. to query the environment's events or upload reference data for the environment.
718
+ * NOTE: This property will not be serialized. It can only be populated by the server.
922
719
  */
923
- description?: string;
720
+ readonly dataAccessFqdn?: string;
924
721
  /**
925
- * The list of roles the principal is assigned on the environment.
722
+ * An object that represents the status of the environment, and its internal state in the Time Series Insights service.
723
+ * NOTE: This property will not be serialized. It can only be populated by the server.
926
724
  */
927
- roles?: AccessPolicyRole[];
928
- }
725
+ readonly status?: EnvironmentStatus;
726
+ /** The list of event properties which will be used to define the environment's time series id. */
727
+ timeSeriesIdProperties: TimeSeriesIdProperty[];
728
+ /** The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data. */
729
+ storageConfiguration: Gen2StorageConfigurationOutput;
730
+ /** The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query. */
731
+ warmStoreConfiguration?: WarmStoreConfigurationProperties;
732
+ };
929
733
 
930
- /**
931
- * An interface representing AccessPolicyUpdateParameters.
932
- */
933
- export interface AccessPolicyUpdateParameters {
734
+ /** An event source that receives its data from an Azure EventHub. */
735
+ export type EventHubEventSourceResource = EventSourceResource & {
934
736
  /**
935
- * An description of the access policy.
737
+ * Provisioning state of the resource.
738
+ * NOTE: This property will not be serialized. It can only be populated by the server.
936
739
  */
937
- description?: string;
740
+ readonly provisioningState?: ProvisioningState;
938
741
  /**
939
- * The list of roles the principal is assigned on the environment.
742
+ * The time the resource was created.
743
+ * NOTE: This property will not be serialized. It can only be populated by the server.
940
744
  */
941
- roles?: AccessPolicyRole[];
942
- }
745
+ readonly creationTime?: Date;
746
+ /** The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used. */
747
+ timestampPropertyName?: string;
748
+ /** An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events. */
749
+ localTimestamp?: LocalTimestamp;
750
+ /** The type of the ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime". */
751
+ typePropertiesIngressStartAtType?: IngressStartAtType;
752
+ /** ISO8601 UTC datetime with seconds precision (milliseconds are optional), specifying the date and time that will be the starting point for Events to be consumed. */
753
+ time?: string;
754
+ /** The resource id of the event source in Azure Resource Manager. */
755
+ eventSourceResourceId: string;
756
+ /** The name of the service bus that contains the event hub. */
757
+ serviceBusNamespace: string;
758
+ /** The name of the event hub. */
759
+ eventHubName: string;
760
+ /** The name of the event hub's consumer group that holds the partitions from which events will be read. */
761
+ consumerGroupName: string;
762
+ /** The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access policies for this key must grant 'Listen' permissions to the event hub. */
763
+ keyName: string;
764
+ };
943
765
 
944
- /**
945
- * An access policy is used to grant users and applications access to the environment. Roles are
946
- * assigned to service principals in Azure Active Directory. These roles define the actions the
947
- * principal can perform through the Time Series Insights data plane APIs.
948
- */
949
- export interface AccessPolicyResource extends Resource {
950
- /**
951
- * The objectId of the principal in Azure Active Directory.
952
- */
953
- principalObjectId?: string;
766
+ /** An event source that receives its data from an Azure IoTHub. */
767
+ export type IoTHubEventSourceResource = EventSourceResource & {
954
768
  /**
955
- * An description of the access policy.
769
+ * Provisioning state of the resource.
770
+ * NOTE: This property will not be serialized. It can only be populated by the server.
956
771
  */
957
- description?: string;
772
+ readonly provisioningState?: ProvisioningState;
958
773
  /**
959
- * The list of roles the principal is assigned on the environment.
774
+ * The time the resource was created.
775
+ * NOTE: This property will not be serialized. It can only be populated by the server.
960
776
  */
961
- roles?: AccessPolicyRole[];
777
+ readonly creationTime?: Date;
778
+ /** The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used. */
779
+ timestampPropertyName?: string;
780
+ /** An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events. */
781
+ localTimestamp?: LocalTimestamp;
782
+ /** The type of the ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime". */
783
+ typePropertiesIngressStartAtType?: IngressStartAtType;
784
+ /** ISO8601 UTC datetime with seconds precision (milliseconds are optional), specifying the date and time that will be the starting point for Events to be consumed. */
785
+ time?: string;
786
+ /** The resource id of the event source in Azure Resource Manager. */
787
+ eventSourceResourceId: string;
788
+ /** The name of the iot hub. */
789
+ iotHubName: string;
790
+ /** The name of the iot hub's consumer group that holds the partitions from which events will be read. */
791
+ consumerGroupName: string;
792
+ /** The name of the Shared Access Policy key that grants the Time Series Insights service access to the iot hub. This shared access policy key must grant 'service connect' permissions to the iot hub. */
793
+ keyName: string;
794
+ };
795
+
796
+ /** Properties of the EventHub event source. */
797
+ export type EventHubEventSourceCommonProperties = AzureEventSourceProperties & {
798
+ /** The name of the service bus that contains the event hub. */
799
+ serviceBusNamespace: string;
800
+ /** The name of the event hub. */
801
+ eventHubName: string;
802
+ /** The name of the event hub's consumer group that holds the partitions from which events will be read. */
803
+ consumerGroupName: string;
804
+ /** The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access policies for this key must grant 'Listen' permissions to the event hub. */
805
+ keyName: string;
806
+ };
807
+
808
+ /** Properties of the IoTHub event source. */
809
+ export type IoTHubEventSourceCommonProperties = AzureEventSourceProperties & {
810
+ /** The name of the iot hub. */
811
+ iotHubName: string;
812
+ /** The name of the iot hub's consumer group that holds the partitions from which events will be read. */
813
+ consumerGroupName: string;
814
+ /** The name of the Shared Access Policy key that grants the Time Series Insights service access to the iot hub. This shared access policy key must grant 'service connect' permissions to the iot hub. */
815
+ keyName: string;
816
+ };
817
+
818
+ /** Properties of the EventHub event source that are required on create or update requests. */
819
+ export type EventHubEventSourceCreationProperties = EventHubEventSourceCommonProperties & {
820
+ /** The value of the shared access key that grants the Time Series Insights service read access to the event hub. This property is not shown in event source responses. */
821
+ sharedAccessKey: string;
822
+ };
823
+
824
+ /** Properties of the EventHub event source resource. */
825
+ export type EventHubEventSourceResourceProperties = EventHubEventSourceCommonProperties & {};
826
+
827
+ /** Properties of the IoTHub event source that are required on create or update requests. */
828
+ export type IoTHubEventSourceCreationProperties = IoTHubEventSourceCommonProperties & {
829
+ /** The value of the Shared Access Policy key that grants the Time Series Insights service read access to the iot hub. This property is not shown in event source responses. */
830
+ sharedAccessKey: string;
831
+ };
832
+
833
+ /** Properties of the IoTHub event source resource. */
834
+ export type IoTHubEventSourceResourceProperties = IoTHubEventSourceCommonProperties & {};
835
+
836
+ /** Known values of {@link EnvironmentKind} that the service accepts. */
837
+ export enum KnownEnvironmentKind {
838
+ Gen1 = "Gen1",
839
+ Gen2 = "Gen2"
962
840
  }
963
841
 
964
842
  /**
965
- * The response of the List access policies operation.
843
+ * Defines values for EnvironmentKind. \
844
+ * {@link KnownEnvironmentKind} can be used interchangeably with EnvironmentKind,
845
+ * this enum contains the known values that the service supports.
846
+ * ### Known values supported by the service
847
+ * **Gen1** \
848
+ * **Gen2**
966
849
  */
967
- export interface AccessPolicyListResponse {
968
- /**
969
- * Result of the List access policies operation.
970
- */
971
- value?: AccessPolicyResource[];
850
+ export type EnvironmentKind = string;
851
+
852
+ /** Known values of {@link SkuName} that the service accepts. */
853
+ export enum KnownSkuName {
854
+ S1 = "S1",
855
+ S2 = "S2",
856
+ P1 = "P1",
857
+ L1 = "L1"
972
858
  }
973
859
 
974
860
  /**
975
- * Optional Parameters.
861
+ * Defines values for SkuName. \
862
+ * {@link KnownSkuName} can be used interchangeably with SkuName,
863
+ * this enum contains the known values that the service supports.
864
+ * ### Known values supported by the service
865
+ * **S1** \
866
+ * **S2** \
867
+ * **P1** \
868
+ * **L1**
976
869
  */
977
- export interface EnvironmentsGetOptionalParams extends msRest.RequestOptionsBase {
978
- /**
979
- * Setting $expand=status will include the status of the internal services of the environment in
980
- * the Time Series Insights service.
981
- */
982
- expand?: string;
870
+ export type SkuName = string;
871
+
872
+ /** Known values of {@link EnvironmentResourceKind} that the service accepts. */
873
+ export enum KnownEnvironmentResourceKind {
874
+ Gen1 = "Gen1",
875
+ Gen2 = "Gen2"
983
876
  }
984
877
 
985
878
  /**
986
- * An interface representing TimeSeriesInsightsClientOptions.
879
+ * Defines values for EnvironmentResourceKind. \
880
+ * {@link KnownEnvironmentResourceKind} can be used interchangeably with EnvironmentResourceKind,
881
+ * this enum contains the known values that the service supports.
882
+ * ### Known values supported by the service
883
+ * **Gen1** \
884
+ * **Gen2**
987
885
  */
988
- export interface TimeSeriesInsightsClientOptions extends AzureServiceClientOptions {
989
- baseUri?: string;
886
+ export type EnvironmentResourceKind = string;
887
+
888
+ /** Known values of {@link EventSourceKind} that the service accepts. */
889
+ export enum KnownEventSourceKind {
890
+ MicrosoftEventHub = "Microsoft.EventHub",
891
+ MicrosoftIoTHub = "Microsoft.IoTHub"
990
892
  }
991
893
 
992
894
  /**
993
- * @interface
994
- * Result of the request to list Time Series Insights operations. It contains a list of operations
995
- * and a URL link to get the next set of results.
996
- * @extends Array<Operation>
895
+ * Defines values for EventSourceKind. \
896
+ * {@link KnownEventSourceKind} can be used interchangeably with EventSourceKind,
897
+ * this enum contains the known values that the service supports.
898
+ * ### Known values supported by the service
899
+ * **Microsoft.EventHub** \
900
+ * **Microsoft.IoTHub**
997
901
  */
998
- export interface OperationListResult extends Array<Operation> {
999
- /**
1000
- * URL to get the next set of operation list results if there are any.
1001
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1002
- */
1003
- readonly nextLink?: string;
902
+ export type EventSourceKind = string;
903
+
904
+ /** Known values of {@link LocalTimestampFormat} that the service accepts. */
905
+ export enum KnownLocalTimestampFormat {
906
+ Embedded = "Embedded"
1004
907
  }
1005
908
 
1006
909
  /**
1007
- * Defines values for ProvisioningState.
1008
- * Possible values include: 'Accepted', 'Creating', 'Updating', 'Succeeded', 'Failed', 'Deleting'
1009
- * @readonly
1010
- * @enum {string}
910
+ * Defines values for LocalTimestampFormat. \
911
+ * {@link KnownLocalTimestampFormat} can be used interchangeably with LocalTimestampFormat,
912
+ * this enum contains the known values that the service supports.
913
+ * ### Known values supported by the service
914
+ * **Embedded**
1011
915
  */
1012
- export type ProvisioningState = 'Accepted' | 'Creating' | 'Updating' | 'Succeeded' | 'Failed' | 'Deleting';
916
+ export type LocalTimestampFormat = string;
1013
917
 
1014
- /**
1015
- * Defines values for SkuName.
1016
- * Possible values include: 'S1', 'S2'
1017
- * @readonly
1018
- * @enum {string}
1019
- */
1020
- export type SkuName = 'S1' | 'S2';
918
+ /** Known values of {@link EventSourceResourceKind} that the service accepts. */
919
+ export enum KnownEventSourceResourceKind {
920
+ MicrosoftEventHub = "Microsoft.EventHub",
921
+ MicrosoftIoTHub = "Microsoft.IoTHub"
922
+ }
1021
923
 
1022
924
  /**
1023
- * Defines values for StorageLimitExceededBehavior.
1024
- * Possible values include: 'PurgeOldData', 'PauseIngress'
1025
- * @readonly
1026
- * @enum {string}
925
+ * Defines values for EventSourceResourceKind. \
926
+ * {@link KnownEventSourceResourceKind} can be used interchangeably with EventSourceResourceKind,
927
+ * this enum contains the known values that the service supports.
928
+ * ### Known values supported by the service
929
+ * **Microsoft.EventHub** \
930
+ * **Microsoft.IoTHub**
1027
931
  */
1028
- export type StorageLimitExceededBehavior = 'PurgeOldData' | 'PauseIngress';
932
+ export type EventSourceResourceKind = string;
1029
933
 
1030
- /**
1031
- * Defines values for PropertyType.
1032
- * Possible values include: 'String'
1033
- * @readonly
1034
- * @enum {string}
1035
- */
1036
- export type PropertyType = 'String';
934
+ /** Known values of {@link ReferenceDataKeyPropertyType} that the service accepts. */
935
+ export enum KnownReferenceDataKeyPropertyType {
936
+ String = "String",
937
+ Double = "Double",
938
+ Bool = "Bool",
939
+ DateTime = "DateTime"
940
+ }
1037
941
 
1038
942
  /**
1039
- * Defines values for IngressState.
1040
- * Possible values include: 'Disabled', 'Ready', 'Running', 'Paused', 'Unknown'
1041
- * @readonly
1042
- * @enum {string}
943
+ * Defines values for ReferenceDataKeyPropertyType. \
944
+ * {@link KnownReferenceDataKeyPropertyType} can be used interchangeably with ReferenceDataKeyPropertyType,
945
+ * this enum contains the known values that the service supports.
946
+ * ### Known values supported by the service
947
+ * **String** \
948
+ * **Double** \
949
+ * **Bool** \
950
+ * **DateTime**
1043
951
  */
1044
- export type IngressState = 'Disabled' | 'Ready' | 'Running' | 'Paused' | 'Unknown';
952
+ export type ReferenceDataKeyPropertyType = string;
1045
953
 
1046
- /**
1047
- * Defines values for LocalTimestampFormat.
1048
- * Possible values include: 'Embedded', 'Iana', 'TimeSpan'
1049
- * @readonly
1050
- * @enum {string}
1051
- */
1052
- export type LocalTimestampFormat = 'Embedded' | 'Iana' | 'TimeSpan';
954
+ /** Known values of {@link DataStringComparisonBehavior} that the service accepts. */
955
+ export enum KnownDataStringComparisonBehavior {
956
+ Ordinal = "Ordinal",
957
+ OrdinalIgnoreCase = "OrdinalIgnoreCase"
958
+ }
1053
959
 
1054
960
  /**
1055
- * Defines values for ReferenceDataKeyPropertyType.
1056
- * Possible values include: 'String', 'Double', 'Bool', 'DateTime'
1057
- * @readonly
1058
- * @enum {string}
961
+ * Defines values for DataStringComparisonBehavior. \
962
+ * {@link KnownDataStringComparisonBehavior} can be used interchangeably with DataStringComparisonBehavior,
963
+ * this enum contains the known values that the service supports.
964
+ * ### Known values supported by the service
965
+ * **Ordinal** \
966
+ * **OrdinalIgnoreCase**
1059
967
  */
1060
- export type ReferenceDataKeyPropertyType = 'String' | 'Double' | 'Bool' | 'DateTime';
968
+ export type DataStringComparisonBehavior = string;
1061
969
 
1062
- /**
1063
- * Defines values for DataStringComparisonBehavior.
1064
- * Possible values include: 'Ordinal', 'OrdinalIgnoreCase'
1065
- * @readonly
1066
- * @enum {string}
1067
- */
1068
- export type DataStringComparisonBehavior = 'Ordinal' | 'OrdinalIgnoreCase';
970
+ /** Known values of {@link ProvisioningState} that the service accepts. */
971
+ export enum KnownProvisioningState {
972
+ Accepted = "Accepted",
973
+ Creating = "Creating",
974
+ Updating = "Updating",
975
+ Succeeded = "Succeeded",
976
+ Failed = "Failed",
977
+ Deleting = "Deleting"
978
+ }
1069
979
 
1070
980
  /**
1071
- * Defines values for AccessPolicyRole.
1072
- * Possible values include: 'Reader', 'Contributor'
1073
- * @readonly
1074
- * @enum {string}
981
+ * Defines values for ProvisioningState. \
982
+ * {@link KnownProvisioningState} can be used interchangeably with ProvisioningState,
983
+ * this enum contains the known values that the service supports.
984
+ * ### Known values supported by the service
985
+ * **Accepted** \
986
+ * **Creating** \
987
+ * **Updating** \
988
+ * **Succeeded** \
989
+ * **Failed** \
990
+ * **Deleting**
1075
991
  */
1076
- export type AccessPolicyRole = 'Reader' | 'Contributor';
992
+ export type ProvisioningState = string;
1077
993
 
1078
- /**
1079
- * Contains response data for the list operation.
1080
- */
1081
- export type OperationsListResponse = OperationListResult & {
1082
- /**
1083
- * The underlying HTTP response.
1084
- */
1085
- _response: msRest.HttpResponse & {
1086
- /**
1087
- * The response body as text (string format)
1088
- */
1089
- bodyAsText: string;
1090
-
1091
- /**
1092
- * The response body as parsed JSON or XML
1093
- */
1094
- parsedBody: OperationListResult;
1095
- };
1096
- };
994
+ /** Known values of {@link AccessPolicyRole} that the service accepts. */
995
+ export enum KnownAccessPolicyRole {
996
+ Reader = "Reader",
997
+ Contributor = "Contributor"
998
+ }
1097
999
 
1098
1000
  /**
1099
- * Contains response data for the listNext operation.
1001
+ * Defines values for AccessPolicyRole. \
1002
+ * {@link KnownAccessPolicyRole} can be used interchangeably with AccessPolicyRole,
1003
+ * this enum contains the known values that the service supports.
1004
+ * ### Known values supported by the service
1005
+ * **Reader** \
1006
+ * **Contributor**
1100
1007
  */
1101
- export type OperationsListNextResponse = OperationListResult & {
1102
- /**
1103
- * The underlying HTTP response.
1104
- */
1105
- _response: msRest.HttpResponse & {
1106
- /**
1107
- * The response body as text (string format)
1108
- */
1109
- bodyAsText: string;
1110
-
1111
- /**
1112
- * The response body as parsed JSON or XML
1113
- */
1114
- parsedBody: OperationListResult;
1115
- };
1116
- };
1008
+ export type AccessPolicyRole = string;
1117
1009
 
1118
- /**
1119
- * Contains response data for the createOrUpdate operation.
1120
- */
1121
- export type EnvironmentsCreateOrUpdateResponse = EnvironmentResource & {
1122
- /**
1123
- * The underlying HTTP response.
1124
- */
1125
- _response: msRest.HttpResponse & {
1126
- /**
1127
- * The response body as text (string format)
1128
- */
1129
- bodyAsText: string;
1130
-
1131
- /**
1132
- * The response body as parsed JSON or XML
1133
- */
1134
- parsedBody: EnvironmentResource;
1135
- };
1136
- };
1010
+ /** Known values of {@link StorageLimitExceededBehavior} that the service accepts. */
1011
+ export enum KnownStorageLimitExceededBehavior {
1012
+ PurgeOldData = "PurgeOldData",
1013
+ PauseIngress = "PauseIngress"
1014
+ }
1137
1015
 
1138
1016
  /**
1139
- * Contains response data for the get operation.
1017
+ * Defines values for StorageLimitExceededBehavior. \
1018
+ * {@link KnownStorageLimitExceededBehavior} can be used interchangeably with StorageLimitExceededBehavior,
1019
+ * this enum contains the known values that the service supports.
1020
+ * ### Known values supported by the service
1021
+ * **PurgeOldData** \
1022
+ * **PauseIngress**
1140
1023
  */
1141
- export type EnvironmentsGetResponse = EnvironmentResource & {
1142
- /**
1143
- * The underlying HTTP response.
1144
- */
1145
- _response: msRest.HttpResponse & {
1146
- /**
1147
- * The response body as text (string format)
1148
- */
1149
- bodyAsText: string;
1150
-
1151
- /**
1152
- * The response body as parsed JSON or XML
1153
- */
1154
- parsedBody: EnvironmentResource;
1155
- };
1156
- };
1024
+ export type StorageLimitExceededBehavior = string;
1157
1025
 
1158
- /**
1159
- * Contains response data for the update operation.
1160
- */
1161
- export type EnvironmentsUpdateResponse = EnvironmentResource & {
1162
- /**
1163
- * The underlying HTTP response.
1164
- */
1165
- _response: msRest.HttpResponse & {
1166
- /**
1167
- * The response body as text (string format)
1168
- */
1169
- bodyAsText: string;
1170
-
1171
- /**
1172
- * The response body as parsed JSON or XML
1173
- */
1174
- parsedBody: EnvironmentResource;
1175
- };
1176
- };
1026
+ /** Known values of {@link PropertyType} that the service accepts. */
1027
+ export enum KnownPropertyType {
1028
+ String = "String"
1029
+ }
1177
1030
 
1178
1031
  /**
1179
- * Contains response data for the listByResourceGroup operation.
1032
+ * Defines values for PropertyType. \
1033
+ * {@link KnownPropertyType} can be used interchangeably with PropertyType,
1034
+ * this enum contains the known values that the service supports.
1035
+ * ### Known values supported by the service
1036
+ * **String**
1180
1037
  */
1181
- export type EnvironmentsListByResourceGroupResponse = EnvironmentListResponse & {
1182
- /**
1183
- * The underlying HTTP response.
1184
- */
1185
- _response: msRest.HttpResponse & {
1186
- /**
1187
- * The response body as text (string format)
1188
- */
1189
- bodyAsText: string;
1190
-
1191
- /**
1192
- * The response body as parsed JSON or XML
1193
- */
1194
- parsedBody: EnvironmentListResponse;
1195
- };
1196
- };
1038
+ export type PropertyType = string;
1197
1039
 
1198
- /**
1199
- * Contains response data for the listBySubscription operation.
1200
- */
1201
- export type EnvironmentsListBySubscriptionResponse = EnvironmentListResponse & {
1202
- /**
1203
- * The underlying HTTP response.
1204
- */
1205
- _response: msRest.HttpResponse & {
1206
- /**
1207
- * The response body as text (string format)
1208
- */
1209
- bodyAsText: string;
1210
-
1211
- /**
1212
- * The response body as parsed JSON or XML
1213
- */
1214
- parsedBody: EnvironmentListResponse;
1215
- };
1216
- };
1040
+ /** Known values of {@link IngressState} that the service accepts. */
1041
+ export enum KnownIngressState {
1042
+ Disabled = "Disabled",
1043
+ Ready = "Ready",
1044
+ Running = "Running",
1045
+ Paused = "Paused",
1046
+ Unknown = "Unknown"
1047
+ }
1217
1048
 
1218
1049
  /**
1219
- * Contains response data for the beginCreateOrUpdate operation.
1050
+ * Defines values for IngressState. \
1051
+ * {@link KnownIngressState} can be used interchangeably with IngressState,
1052
+ * this enum contains the known values that the service supports.
1053
+ * ### Known values supported by the service
1054
+ * **Disabled** \
1055
+ * **Ready** \
1056
+ * **Running** \
1057
+ * **Paused** \
1058
+ * **Unknown**
1220
1059
  */
1221
- export type EnvironmentsBeginCreateOrUpdateResponse = EnvironmentResource & {
1222
- /**
1223
- * The underlying HTTP response.
1224
- */
1225
- _response: msRest.HttpResponse & {
1226
- /**
1227
- * The response body as text (string format)
1228
- */
1229
- bodyAsText: string;
1230
-
1231
- /**
1232
- * The response body as parsed JSON or XML
1233
- */
1234
- parsedBody: EnvironmentResource;
1235
- };
1236
- };
1060
+ export type IngressState = string;
1237
1061
 
1238
- /**
1239
- * Contains response data for the beginUpdate operation.
1240
- */
1241
- export type EnvironmentsBeginUpdateResponse = EnvironmentResource & {
1242
- /**
1243
- * The underlying HTTP response.
1244
- */
1245
- _response: msRest.HttpResponse & {
1246
- /**
1247
- * The response body as text (string format)
1248
- */
1249
- bodyAsText: string;
1250
-
1251
- /**
1252
- * The response body as parsed JSON or XML
1253
- */
1254
- parsedBody: EnvironmentResource;
1255
- };
1256
- };
1062
+ /** Known values of {@link WarmStoragePropertiesState} that the service accepts. */
1063
+ export enum KnownWarmStoragePropertiesState {
1064
+ Ok = "Ok",
1065
+ Error = "Error",
1066
+ Unknown = "Unknown"
1067
+ }
1257
1068
 
1258
1069
  /**
1259
- * Contains response data for the createOrUpdate operation.
1070
+ * Defines values for WarmStoragePropertiesState. \
1071
+ * {@link KnownWarmStoragePropertiesState} can be used interchangeably with WarmStoragePropertiesState,
1072
+ * this enum contains the known values that the service supports.
1073
+ * ### Known values supported by the service
1074
+ * **Ok** \
1075
+ * **Error** \
1076
+ * **Unknown**
1260
1077
  */
1261
- export type EventSourcesCreateOrUpdateResponse = EventSourceResourceUnion & {
1262
- /**
1263
- * The underlying HTTP response.
1264
- */
1265
- _response: msRest.HttpResponse & {
1266
- /**
1267
- * The response body as text (string format)
1268
- */
1269
- bodyAsText: string;
1270
-
1271
- /**
1272
- * The response body as parsed JSON or XML
1273
- */
1274
- parsedBody: EventSourceResourceUnion;
1275
- };
1276
- };
1078
+ export type WarmStoragePropertiesState = string;
1277
1079
 
1278
- /**
1279
- * Contains response data for the get operation.
1280
- */
1281
- export type EventSourcesGetResponse = EventSourceResourceUnion & {
1282
- /**
1283
- * The underlying HTTP response.
1284
- */
1285
- _response: msRest.HttpResponse & {
1286
- /**
1287
- * The response body as text (string format)
1288
- */
1289
- bodyAsText: string;
1290
-
1291
- /**
1292
- * The response body as parsed JSON or XML
1293
- */
1294
- parsedBody: EventSourceResourceUnion;
1295
- };
1296
- };
1080
+ /** Known values of {@link IngressStartAtType} that the service accepts. */
1081
+ export enum KnownIngressStartAtType {
1082
+ EarliestAvailable = "EarliestAvailable",
1083
+ EventSourceCreationTime = "EventSourceCreationTime",
1084
+ CustomEnqueuedTime = "CustomEnqueuedTime"
1085
+ }
1297
1086
 
1298
1087
  /**
1299
- * Contains response data for the update operation.
1088
+ * Defines values for IngressStartAtType. \
1089
+ * {@link KnownIngressStartAtType} can be used interchangeably with IngressStartAtType,
1090
+ * this enum contains the known values that the service supports.
1091
+ * ### Known values supported by the service
1092
+ * **EarliestAvailable** \
1093
+ * **EventSourceCreationTime** \
1094
+ * **CustomEnqueuedTime**
1300
1095
  */
1301
- export type EventSourcesUpdateResponse = EventSourceResourceUnion & {
1302
- /**
1303
- * The underlying HTTP response.
1304
- */
1305
- _response: msRest.HttpResponse & {
1306
- /**
1307
- * The response body as text (string format)
1308
- */
1309
- bodyAsText: string;
1310
-
1311
- /**
1312
- * The response body as parsed JSON or XML
1313
- */
1314
- parsedBody: EventSourceResourceUnion;
1315
- };
1316
- };
1096
+ export type IngressStartAtType = string;
1317
1097
 
1318
- /**
1319
- * Contains response data for the listByEnvironment operation.
1320
- */
1321
- export type EventSourcesListByEnvironmentResponse = EventSourceListResponse & {
1322
- /**
1323
- * The underlying HTTP response.
1324
- */
1325
- _response: msRest.HttpResponse & {
1326
- /**
1327
- * The response body as text (string format)
1328
- */
1329
- bodyAsText: string;
1330
-
1331
- /**
1332
- * The response body as parsed JSON or XML
1333
- */
1334
- parsedBody: EventSourceListResponse;
1335
- };
1336
- };
1098
+ /** Optional parameters. */
1099
+ export interface OperationsListOptionalParams
1100
+ extends coreClient.OperationOptions {}
1337
1101
 
1338
- /**
1339
- * Contains response data for the createOrUpdate operation.
1340
- */
1341
- export type ReferenceDataSetsCreateOrUpdateResponse = ReferenceDataSetResource & {
1342
- /**
1343
- * The underlying HTTP response.
1344
- */
1345
- _response: msRest.HttpResponse & {
1346
- /**
1347
- * The response body as text (string format)
1348
- */
1349
- bodyAsText: string;
1350
-
1351
- /**
1352
- * The response body as parsed JSON or XML
1353
- */
1354
- parsedBody: ReferenceDataSetResource;
1355
- };
1356
- };
1102
+ /** Contains response data for the list operation. */
1103
+ export type OperationsListResponse = OperationListResult;
1357
1104
 
1358
- /**
1359
- * Contains response data for the get operation.
1360
- */
1361
- export type ReferenceDataSetsGetResponse = ReferenceDataSetResource & {
1362
- /**
1363
- * The underlying HTTP response.
1364
- */
1365
- _response: msRest.HttpResponse & {
1366
- /**
1367
- * The response body as text (string format)
1368
- */
1369
- bodyAsText: string;
1370
-
1371
- /**
1372
- * The response body as parsed JSON or XML
1373
- */
1374
- parsedBody: ReferenceDataSetResource;
1375
- };
1376
- };
1105
+ /** Optional parameters. */
1106
+ export interface OperationsListNextOptionalParams
1107
+ extends coreClient.OperationOptions {}
1377
1108
 
1378
- /**
1379
- * Contains response data for the update operation.
1380
- */
1381
- export type ReferenceDataSetsUpdateResponse = ReferenceDataSetResource & {
1382
- /**
1383
- * The underlying HTTP response.
1384
- */
1385
- _response: msRest.HttpResponse & {
1386
- /**
1387
- * The response body as text (string format)
1388
- */
1389
- bodyAsText: string;
1390
-
1391
- /**
1392
- * The response body as parsed JSON or XML
1393
- */
1394
- parsedBody: ReferenceDataSetResource;
1395
- };
1396
- };
1109
+ /** Contains response data for the listNext operation. */
1110
+ export type OperationsListNextResponse = OperationListResult;
1397
1111
 
1398
- /**
1399
- * Contains response data for the listByEnvironment operation.
1400
- */
1401
- export type ReferenceDataSetsListByEnvironmentResponse = ReferenceDataSetListResponse & {
1402
- /**
1403
- * The underlying HTTP response.
1404
- */
1405
- _response: msRest.HttpResponse & {
1406
- /**
1407
- * The response body as text (string format)
1408
- */
1409
- bodyAsText: string;
1410
-
1411
- /**
1412
- * The response body as parsed JSON or XML
1413
- */
1414
- parsedBody: ReferenceDataSetListResponse;
1415
- };
1416
- };
1112
+ /** Optional parameters. */
1113
+ export interface EnvironmentsCreateOrUpdateOptionalParams
1114
+ extends coreClient.OperationOptions {
1115
+ /** Delay to wait until next poll, in milliseconds. */
1116
+ updateIntervalInMs?: number;
1117
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
1118
+ resumeFrom?: string;
1119
+ }
1417
1120
 
1418
- /**
1419
- * Contains response data for the createOrUpdate operation.
1420
- */
1421
- export type AccessPoliciesCreateOrUpdateResponse = AccessPolicyResource & {
1422
- /**
1423
- * The underlying HTTP response.
1424
- */
1425
- _response: msRest.HttpResponse & {
1426
- /**
1427
- * The response body as text (string format)
1428
- */
1429
- bodyAsText: string;
1430
-
1431
- /**
1432
- * The response body as parsed JSON or XML
1433
- */
1434
- parsedBody: AccessPolicyResource;
1435
- };
1436
- };
1121
+ /** Contains response data for the createOrUpdate operation. */
1122
+ export type EnvironmentsCreateOrUpdateResponse = EnvironmentResourceUnion;
1437
1123
 
1438
- /**
1439
- * Contains response data for the get operation.
1440
- */
1441
- export type AccessPoliciesGetResponse = AccessPolicyResource & {
1442
- /**
1443
- * The underlying HTTP response.
1444
- */
1445
- _response: msRest.HttpResponse & {
1446
- /**
1447
- * The response body as text (string format)
1448
- */
1449
- bodyAsText: string;
1450
-
1451
- /**
1452
- * The response body as parsed JSON or XML
1453
- */
1454
- parsedBody: AccessPolicyResource;
1455
- };
1456
- };
1124
+ /** Optional parameters. */
1125
+ export interface EnvironmentsGetOptionalParams
1126
+ extends coreClient.OperationOptions {
1127
+ /** Setting $expand=status will include the status of the internal services of the environment in the Time Series Insights service. */
1128
+ expand?: string;
1129
+ }
1457
1130
 
1458
- /**
1459
- * Contains response data for the update operation.
1460
- */
1461
- export type AccessPoliciesUpdateResponse = AccessPolicyResource & {
1462
- /**
1463
- * The underlying HTTP response.
1464
- */
1465
- _response: msRest.HttpResponse & {
1466
- /**
1467
- * The response body as text (string format)
1468
- */
1469
- bodyAsText: string;
1470
-
1471
- /**
1472
- * The response body as parsed JSON or XML
1473
- */
1474
- parsedBody: AccessPolicyResource;
1475
- };
1476
- };
1131
+ /** Contains response data for the get operation. */
1132
+ export type EnvironmentsGetResponse = EnvironmentResourceUnion;
1477
1133
 
1478
- /**
1479
- * Contains response data for the listByEnvironment operation.
1480
- */
1481
- export type AccessPoliciesListByEnvironmentResponse = AccessPolicyListResponse & {
1482
- /**
1483
- * The underlying HTTP response.
1484
- */
1485
- _response: msRest.HttpResponse & {
1486
- /**
1487
- * The response body as text (string format)
1488
- */
1489
- bodyAsText: string;
1490
-
1491
- /**
1492
- * The response body as parsed JSON or XML
1493
- */
1494
- parsedBody: AccessPolicyListResponse;
1495
- };
1496
- };
1134
+ /** Optional parameters. */
1135
+ export interface EnvironmentsUpdateOptionalParams
1136
+ extends coreClient.OperationOptions {
1137
+ /** Delay to wait until next poll, in milliseconds. */
1138
+ updateIntervalInMs?: number;
1139
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
1140
+ resumeFrom?: string;
1141
+ }
1142
+
1143
+ /** Contains response data for the update operation. */
1144
+ export type EnvironmentsUpdateResponse = EnvironmentResourceUnion;
1145
+
1146
+ /** Optional parameters. */
1147
+ export interface EnvironmentsDeleteOptionalParams
1148
+ extends coreClient.OperationOptions {}
1149
+
1150
+ /** Optional parameters. */
1151
+ export interface EnvironmentsListByResourceGroupOptionalParams
1152
+ extends coreClient.OperationOptions {}
1153
+
1154
+ /** Contains response data for the listByResourceGroup operation. */
1155
+ export type EnvironmentsListByResourceGroupResponse = EnvironmentListResponse;
1156
+
1157
+ /** Optional parameters. */
1158
+ export interface EnvironmentsListBySubscriptionOptionalParams
1159
+ extends coreClient.OperationOptions {}
1160
+
1161
+ /** Contains response data for the listBySubscription operation. */
1162
+ export type EnvironmentsListBySubscriptionResponse = EnvironmentListResponse;
1163
+
1164
+ /** Optional parameters. */
1165
+ export interface EventSourcesCreateOrUpdateOptionalParams
1166
+ extends coreClient.OperationOptions {}
1167
+
1168
+ /** Contains response data for the createOrUpdate operation. */
1169
+ export type EventSourcesCreateOrUpdateResponse = EventSourceResourceUnion;
1170
+
1171
+ /** Optional parameters. */
1172
+ export interface EventSourcesGetOptionalParams
1173
+ extends coreClient.OperationOptions {}
1174
+
1175
+ /** Contains response data for the get operation. */
1176
+ export type EventSourcesGetResponse = EventSourceResourceUnion;
1177
+
1178
+ /** Optional parameters. */
1179
+ export interface EventSourcesUpdateOptionalParams
1180
+ extends coreClient.OperationOptions {}
1181
+
1182
+ /** Contains response data for the update operation. */
1183
+ export type EventSourcesUpdateResponse = EventSourceResourceUnion;
1184
+
1185
+ /** Optional parameters. */
1186
+ export interface EventSourcesDeleteOptionalParams
1187
+ extends coreClient.OperationOptions {}
1188
+
1189
+ /** Optional parameters. */
1190
+ export interface EventSourcesListByEnvironmentOptionalParams
1191
+ extends coreClient.OperationOptions {}
1192
+
1193
+ /** Contains response data for the listByEnvironment operation. */
1194
+ export type EventSourcesListByEnvironmentResponse = EventSourceListResponse;
1195
+
1196
+ /** Optional parameters. */
1197
+ export interface ReferenceDataSetsCreateOrUpdateOptionalParams
1198
+ extends coreClient.OperationOptions {}
1199
+
1200
+ /** Contains response data for the createOrUpdate operation. */
1201
+ export type ReferenceDataSetsCreateOrUpdateResponse = ReferenceDataSetResource;
1202
+
1203
+ /** Optional parameters. */
1204
+ export interface ReferenceDataSetsGetOptionalParams
1205
+ extends coreClient.OperationOptions {}
1206
+
1207
+ /** Contains response data for the get operation. */
1208
+ export type ReferenceDataSetsGetResponse = ReferenceDataSetResource;
1209
+
1210
+ /** Optional parameters. */
1211
+ export interface ReferenceDataSetsUpdateOptionalParams
1212
+ extends coreClient.OperationOptions {}
1213
+
1214
+ /** Contains response data for the update operation. */
1215
+ export type ReferenceDataSetsUpdateResponse = ReferenceDataSetResource;
1216
+
1217
+ /** Optional parameters. */
1218
+ export interface ReferenceDataSetsDeleteOptionalParams
1219
+ extends coreClient.OperationOptions {}
1220
+
1221
+ /** Optional parameters. */
1222
+ export interface ReferenceDataSetsListByEnvironmentOptionalParams
1223
+ extends coreClient.OperationOptions {}
1224
+
1225
+ /** Contains response data for the listByEnvironment operation. */
1226
+ export type ReferenceDataSetsListByEnvironmentResponse = ReferenceDataSetListResponse;
1227
+
1228
+ /** Optional parameters. */
1229
+ export interface AccessPoliciesCreateOrUpdateOptionalParams
1230
+ extends coreClient.OperationOptions {}
1231
+
1232
+ /** Contains response data for the createOrUpdate operation. */
1233
+ export type AccessPoliciesCreateOrUpdateResponse = AccessPolicyResource;
1234
+
1235
+ /** Optional parameters. */
1236
+ export interface AccessPoliciesGetOptionalParams
1237
+ extends coreClient.OperationOptions {}
1238
+
1239
+ /** Contains response data for the get operation. */
1240
+ export type AccessPoliciesGetResponse = AccessPolicyResource;
1241
+
1242
+ /** Optional parameters. */
1243
+ export interface AccessPoliciesUpdateOptionalParams
1244
+ extends coreClient.OperationOptions {}
1245
+
1246
+ /** Contains response data for the update operation. */
1247
+ export type AccessPoliciesUpdateResponse = AccessPolicyResource;
1248
+
1249
+ /** Optional parameters. */
1250
+ export interface AccessPoliciesDeleteOptionalParams
1251
+ extends coreClient.OperationOptions {}
1252
+
1253
+ /** Optional parameters. */
1254
+ export interface AccessPoliciesListByEnvironmentOptionalParams
1255
+ extends coreClient.OperationOptions {}
1256
+
1257
+ /** Contains response data for the listByEnvironment operation. */
1258
+ export type AccessPoliciesListByEnvironmentResponse = AccessPolicyListResponse;
1259
+
1260
+ /** Optional parameters. */
1261
+ export interface TimeSeriesInsightsClientOptionalParams
1262
+ extends coreClient.ServiceClientOptions {
1263
+ /** server parameter */
1264
+ $host?: string;
1265
+ /** Api Version */
1266
+ apiVersion?: string;
1267
+ /** Overrides client endpoint. */
1268
+ endpoint?: string;
1269
+ }