-
Notifications
You must be signed in to change notification settings - Fork 256
/
DataPointAnomaly.xml
288 lines (288 loc) · 17.5 KB
/
DataPointAnomaly.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
<Type Name="DataPointAnomaly" FullName="Azure.AI.MetricsAdvisor.Models.DataPointAnomaly">
<TypeSignature Language="C#" Value="public class DataPointAnomaly" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DataPointAnomaly extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.AI.MetricsAdvisor.Models.DataPointAnomaly" />
<TypeSignature Language="VB.NET" Value="Public Class DataPointAnomaly" />
<TypeSignature Language="F#" Value="type DataPointAnomaly = class" />
<AssemblyInfo>
<AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary> The AnomalyResult. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="CreatedOn">
<MemberSignature Language="C#" Value="public DateTimeOffset? CreatedOn { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTimeOffset> CreatedOn" />
<MemberSignature Language="DocId" Value="P:Azure.AI.MetricsAdvisor.Models.DataPointAnomaly.CreatedOn" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CreatedOn As Nullable(Of DateTimeOffset)" />
<MemberSignature Language="F#" Value="member this.CreatedOn : Nullable<DateTimeOffset>" Usage="Azure.AI.MetricsAdvisor.Models.DataPointAnomaly.CreatedOn" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTimeOffset></ReturnType>
</ReturnValue>
<Docs>
<summary>
The date and time, in UTC, in which this anomaly entry has been created. This property is only
populated when calling <see cref="M:Azure.AI.MetricsAdvisor.MetricsAdvisorClient.GetAnomaliesForAlert(System.String,System.String,Azure.AI.MetricsAdvisor.GetAnomaliesForAlertOptions,System.Threading.CancellationToken)" /> or
<see cref="M:Azure.AI.MetricsAdvisor.MetricsAdvisorClient.GetAnomaliesForAlertAsync(System.String,System.String,Azure.AI.MetricsAdvisor.GetAnomaliesForAlertOptions,System.Threading.CancellationToken)" />.
For other overloads, this property will be <c>null</c>.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DataFeedId">
<MemberSignature Language="C#" Value="public string DataFeedId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string DataFeedId" />
<MemberSignature Language="DocId" Value="P:Azure.AI.MetricsAdvisor.Models.DataPointAnomaly.DataFeedId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property DataFeedId As String" />
<MemberSignature Language="F#" Value="member this.DataFeedId : string" Usage="Azure.AI.MetricsAdvisor.Models.DataPointAnomaly.DataFeedId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The unique identifier of the <see cref="T:Azure.AI.MetricsAdvisor.Models.DataFeed" /> in which this anomaly was detected. This property
is only populated when calling
<see cref="M:Azure.AI.MetricsAdvisor.MetricsAdvisorClient.GetAnomaliesForAlert(System.String,System.String,Azure.AI.MetricsAdvisor.GetAnomaliesForAlertOptions,System.Threading.CancellationToken)" /> or
<see cref="M:Azure.AI.MetricsAdvisor.MetricsAdvisorClient.GetAnomaliesForAlertAsync(System.String,System.String,Azure.AI.MetricsAdvisor.GetAnomaliesForAlertOptions,System.Threading.CancellationToken)" />.
For other overloads, this property will be <c>null</c>.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DetectionConfigurationId">
<MemberSignature Language="C#" Value="public string DetectionConfigurationId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string DetectionConfigurationId" />
<MemberSignature Language="DocId" Value="P:Azure.AI.MetricsAdvisor.Models.DataPointAnomaly.DetectionConfigurationId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property DetectionConfigurationId As String" />
<MemberSignature Language="F#" Value="member this.DetectionConfigurationId : string" Usage="Azure.AI.MetricsAdvisor.Models.DataPointAnomaly.DetectionConfigurationId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The unique identifier of the <see cref="T:Azure.AI.MetricsAdvisor.Models.AnomalyDetectionConfiguration" /> that detected
this anomaly. This property is only populated when calling <see cref="M:Azure.AI.MetricsAdvisor.MetricsAdvisorClient.GetAnomaliesForAlert(System.String,System.String,Azure.AI.MetricsAdvisor.GetAnomaliesForAlertOptions,System.Threading.CancellationToken)" />
or <see cref="M:Azure.AI.MetricsAdvisor.MetricsAdvisorClient.GetAnomaliesForAlertAsync(System.String,System.String,Azure.AI.MetricsAdvisor.GetAnomaliesForAlertOptions,System.Threading.CancellationToken)" />.
For other overloads, this property will be <c>null</c>.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExpectedValue">
<MemberSignature Language="C#" Value="public double? ExpectedValue { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<float64> ExpectedValue" />
<MemberSignature Language="DocId" Value="P:Azure.AI.MetricsAdvisor.Models.DataPointAnomaly.ExpectedValue" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ExpectedValue As Nullable(Of Double)" />
<MemberSignature Language="F#" Value="member this.ExpectedValue : Nullable<double>" Usage="Azure.AI.MetricsAdvisor.Models.DataPointAnomaly.ExpectedValue" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Double></ReturnType>
</ReturnValue>
<Docs>
<summary>
The expected value of the data point that generated this anomaly, according to the service's
smart detector. <c>null</c> if the quantity of historical points is not enough to make a prediction,
or if this anomaly was not detected by a <see cref="T:Azure.AI.MetricsAdvisor.Models.SmartDetectionCondition" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LastModified">
<MemberSignature Language="C#" Value="public DateTimeOffset? LastModified { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTimeOffset> LastModified" />
<MemberSignature Language="DocId" Value="P:Azure.AI.MetricsAdvisor.Models.DataPointAnomaly.LastModified" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property LastModified As Nullable(Of DateTimeOffset)" />
<MemberSignature Language="F#" Value="member this.LastModified : Nullable<DateTimeOffset>" Usage="Azure.AI.MetricsAdvisor.Models.DataPointAnomaly.LastModified" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTimeOffset></ReturnType>
</ReturnValue>
<Docs>
<summary>
The date and time, in UTC, in which this anomaly entry has been modified for the last time. This
property is only populated when calling <see cref="M:Azure.AI.MetricsAdvisor.MetricsAdvisorClient.GetAnomaliesForAlert(System.String,System.String,Azure.AI.MetricsAdvisor.GetAnomaliesForAlertOptions,System.Threading.CancellationToken)" />
or <see cref="M:Azure.AI.MetricsAdvisor.MetricsAdvisorClient.GetAnomaliesForAlertAsync(System.String,System.String,Azure.AI.MetricsAdvisor.GetAnomaliesForAlertOptions,System.Threading.CancellationToken)" />.
For other overloads, this property will be <c>null</c>.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MetricId">
<MemberSignature Language="C#" Value="public string MetricId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string MetricId" />
<MemberSignature Language="DocId" Value="P:Azure.AI.MetricsAdvisor.Models.DataPointAnomaly.MetricId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property MetricId As String" />
<MemberSignature Language="F#" Value="member this.MetricId : string" Usage="Azure.AI.MetricsAdvisor.Models.DataPointAnomaly.MetricId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The unique identifier of the <see cref="T:Azure.AI.MetricsAdvisor.Models.DataFeedMetric" /> of the time series in which this
anomaly has been detected. This property is only populated when calling
<see cref="M:Azure.AI.MetricsAdvisor.MetricsAdvisorClient.GetAnomaliesForAlert(System.String,System.String,Azure.AI.MetricsAdvisor.GetAnomaliesForAlertOptions,System.Threading.CancellationToken)" /> or
<see cref="M:Azure.AI.MetricsAdvisor.MetricsAdvisorClient.GetAnomaliesForAlertAsync(System.String,System.String,Azure.AI.MetricsAdvisor.GetAnomaliesForAlertOptions,System.Threading.CancellationToken)" />.
For other overloads, this property will be <c>null</c>.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SeriesKey">
<MemberSignature Language="C#" Value="public Azure.AI.MetricsAdvisor.Models.DimensionKey SeriesKey { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.AI.MetricsAdvisor.Models.DimensionKey SeriesKey" />
<MemberSignature Language="DocId" Value="P:Azure.AI.MetricsAdvisor.Models.DataPointAnomaly.SeriesKey" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property SeriesKey As DimensionKey" />
<MemberSignature Language="F#" Value="member this.SeriesKey : Azure.AI.MetricsAdvisor.Models.DimensionKey" Usage="Azure.AI.MetricsAdvisor.Models.DataPointAnomaly.SeriesKey" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.MetricsAdvisor.Models.DimensionKey</ReturnType>
</ReturnValue>
<Docs>
<summary>
The key that, within a metric, uniquely identifies the time series in which this anomaly has
been detected. In this key, a value is assigned to every possible dimension.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Severity">
<MemberSignature Language="C#" Value="public Azure.AI.MetricsAdvisor.Models.AnomalySeverity Severity { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Azure.AI.MetricsAdvisor.Models.AnomalySeverity Severity" />
<MemberSignature Language="DocId" Value="P:Azure.AI.MetricsAdvisor.Models.DataPointAnomaly.Severity" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Severity As AnomalySeverity" />
<MemberSignature Language="F#" Value="member this.Severity : Azure.AI.MetricsAdvisor.Models.AnomalySeverity" Usage="Azure.AI.MetricsAdvisor.Models.DataPointAnomaly.Severity" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.MetricsAdvisor.Models.AnomalySeverity</ReturnType>
</ReturnValue>
<Docs>
<summary>
The severity of the detected anomaly, as evaluated by the service.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Status">
<MemberSignature Language="C#" Value="public Azure.AI.MetricsAdvisor.Models.AnomalyStatus? Status { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Azure.AI.MetricsAdvisor.Models.AnomalyStatus> Status" />
<MemberSignature Language="DocId" Value="P:Azure.AI.MetricsAdvisor.Models.DataPointAnomaly.Status" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Status As Nullable(Of AnomalyStatus)" />
<MemberSignature Language="F#" Value="member this.Status : Nullable<Azure.AI.MetricsAdvisor.Models.AnomalyStatus>" Usage="Azure.AI.MetricsAdvisor.Models.DataPointAnomaly.Status" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<Azure.AI.MetricsAdvisor.Models.AnomalyStatus></ReturnType>
</ReturnValue>
<Docs>
<summary>
The status of the issue that caused this <see cref="T:Azure.AI.MetricsAdvisor.Models.DataPointAnomaly" />. This property is only populated
when calling <see cref="M:Azure.AI.MetricsAdvisor.MetricsAdvisorClient.GetAnomaliesForAlert(System.String,System.String,Azure.AI.MetricsAdvisor.GetAnomaliesForAlertOptions,System.Threading.CancellationToken)" /> or
<see cref="M:Azure.AI.MetricsAdvisor.MetricsAdvisorClient.GetAnomaliesForAlertAsync(System.String,System.String,Azure.AI.MetricsAdvisor.GetAnomaliesForAlertOptions,System.Threading.CancellationToken)" />.
For other overloads, this property will be <c>null</c>.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Timestamp">
<MemberSignature Language="C#" Value="public DateTimeOffset Timestamp { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTimeOffset Timestamp" />
<MemberSignature Language="DocId" Value="P:Azure.AI.MetricsAdvisor.Models.DataPointAnomaly.Timestamp" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Timestamp As DateTimeOffset" />
<MemberSignature Language="F#" Value="member this.Timestamp : DateTimeOffset" Usage="Azure.AI.MetricsAdvisor.Models.DataPointAnomaly.Timestamp" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTimeOffset</ReturnType>
</ReturnValue>
<Docs>
<summary>
The timestamp, in UTC, of the data point that generated this anomaly, as described by the
<see cref="T:Azure.AI.MetricsAdvisor.Models.DataFeed" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Value">
<MemberSignature Language="C#" Value="public double Value { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 Value" />
<MemberSignature Language="DocId" Value="P:Azure.AI.MetricsAdvisor.Models.DataPointAnomaly.Value" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Value As Double" />
<MemberSignature Language="F#" Value="member this.Value : double" Usage="Azure.AI.MetricsAdvisor.Models.DataPointAnomaly.Value" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>
The value of the data point that generated this anomaly.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>