-
Notifications
You must be signed in to change notification settings - Fork 255
/
Metrics.xml
763 lines (763 loc) · 64 KB
/
Metrics.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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
<Type Name="Metrics" FullName="Microsoft.Azure.ApplicationInsights.Query.Metrics">
<TypeSignature Language="C#" Value="public class Metrics : Microsoft.Azure.ApplicationInsights.Query.IMetrics, Microsoft.Rest.IServiceOperations<Microsoft.Azure.ApplicationInsights.Query.ApplicationInsightsDataClient>" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Metrics extends System.Object implements class Microsoft.Azure.ApplicationInsights.Query.IMetrics, class Microsoft.Rest.IServiceOperations`1<class Microsoft.Azure.ApplicationInsights.Query.ApplicationInsightsDataClient>" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.ApplicationInsights.Query.Metrics" />
<TypeSignature Language="VB.NET" Value="Public Class Metrics
Implements IMetrics, IServiceOperations(Of ApplicationInsightsDataClient)" />
<TypeSignature Language="F#" Value="type Metrics = class
 interface IServiceOperations<ApplicationInsightsDataClient>
 interface IMetrics" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ApplicationInsights.Query</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Azure.ApplicationInsights.Query.IMetrics</InterfaceName>
</Interface>
<Interface>
<InterfaceName>Microsoft.Rest.IServiceOperations<Microsoft.Azure.ApplicationInsights.Query.ApplicationInsightsDataClient></InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Metrics operations.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Metrics (Microsoft.Azure.ApplicationInsights.Query.ApplicationInsightsDataClient client);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Azure.ApplicationInsights.Query.ApplicationInsightsDataClient client) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ApplicationInsights.Query.Metrics.#ctor(Microsoft.Azure.ApplicationInsights.Query.ApplicationInsightsDataClient)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (client As ApplicationInsightsDataClient)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.ApplicationInsights.Query.Metrics : Microsoft.Azure.ApplicationInsights.Query.ApplicationInsightsDataClient -> Microsoft.Azure.ApplicationInsights.Query.Metrics" Usage="new Microsoft.Azure.ApplicationInsights.Query.Metrics client" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ApplicationInsights.Query</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="client" Type="Microsoft.Azure.ApplicationInsights.Query.ApplicationInsightsDataClient" />
</Parameters>
<Docs>
<param name="client">
Reference to the service client.
</param>
<summary>
Initializes a new instance of the Metrics class.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
Thrown when a required parameter is null
</exception>
</Docs>
</Member>
<Member MemberName="Client">
<MemberSignature Language="C#" Value="public Microsoft.Azure.ApplicationInsights.Query.ApplicationInsightsDataClient Client { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.ApplicationInsights.Query.ApplicationInsightsDataClient Client" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ApplicationInsights.Query.Metrics.Client" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Client As ApplicationInsightsDataClient" />
<MemberSignature Language="F#" Value="member this.Client : Microsoft.Azure.ApplicationInsights.Query.ApplicationInsightsDataClient" Usage="Microsoft.Azure.ApplicationInsights.Query.Metrics.Client" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ApplicationInsights.Query</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.ApplicationInsights.Query.ApplicationInsightsDataClient</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets a reference to the ApplicationInsightsDataClient
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetIntervaledMetricWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsIntervaledResult>> GetIntervaledMetricWithHttpMessagesAsync (string appId, string metricId, string timespan = default, TimeSpan? interval = default, System.Collections.Generic.IList<string> aggregation = default, System.Collections.Generic.IList<string> segment = default, int? top = default, string orderby = default, string filter = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse`1<class Microsoft.Azure.ApplicationInsights.Query.Models.MetricsIntervaledResult>> GetIntervaledMetricWithHttpMessagesAsync(string appId, string metricId, string timespan, valuetype System.Nullable`1<valuetype System.TimeSpan> interval, class System.Collections.Generic.IList`1<string> aggregation, class System.Collections.Generic.IList`1<string> segment, valuetype System.Nullable`1<int32> top, string orderby, string filter, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ApplicationInsights.Query.Metrics.GetIntervaledMetricWithHttpMessagesAsync(System.String,System.String,System.String,System.Nullable{System.TimeSpan},System.Collections.Generic.IList{System.String},System.Collections.Generic.IList{System.String},System.Nullable{System.Int32},System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetIntervaledMetricWithHttpMessagesAsync (appId As String, metricId As String, Optional timespan As String = Nothing, Optional interval As Nullable(Of TimeSpan) = Nothing, Optional aggregation As IList(Of String) = Nothing, Optional segment As IList(Of String) = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional orderby As String = Nothing, Optional filter As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of MetricsIntervaledResult))" />
<MemberSignature Language="F#" Value="abstract member GetIntervaledMetricWithHttpMessagesAsync : string * string * string * Nullable<TimeSpan> * System.Collections.Generic.IList<string> * System.Collections.Generic.IList<string> * Nullable<int> * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsIntervaledResult>>
override this.GetIntervaledMetricWithHttpMessagesAsync : string * string * string * Nullable<TimeSpan> * System.Collections.Generic.IList<string> * System.Collections.Generic.IList<string> * Nullable<int> * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsIntervaledResult>>" Usage="metrics.GetIntervaledMetricWithHttpMessagesAsync (appId, metricId, timespan, interval, aggregation, segment, top, orderby, filter, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.ApplicationInsights.Query.IMetrics.GetIntervaledMetricWithHttpMessagesAsync(System.String,System.String,System.String,System.Nullable{System.TimeSpan},System.Collections.Generic.IList{System.String},System.Collections.Generic.IList{System.String},System.Nullable{System.Int32},System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ApplicationInsights.Query</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsIntervaledResult>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="appId" Type="System.String" />
<Parameter Name="metricId" Type="System.String" />
<Parameter Name="timespan" Type="System.String" />
<Parameter Name="interval" Type="System.Nullable<System.TimeSpan>" />
<Parameter Name="aggregation" Type="System.Collections.Generic.IList<System.String>" />
<Parameter Name="segment" Type="System.Collections.Generic.IList<System.String>" />
<Parameter Name="top" Type="System.Nullable<System.Int32>" />
<Parameter Name="orderby" Type="System.String" />
<Parameter Name="filter" Type="System.String" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="appId">
ID of the application. This is Application ID from the API Access settings
blade in the Azure portal.
</param>
<param name="metricId">
ID of the metric. This is either a standard AI metric, or an
application-specific custom metric. Possible values include:
'requests/count', 'requests/duration', 'requests/failed',
'users/count', 'users/authenticated', 'pageViews/count',
'pageViews/duration', 'client/processingDuration',
'client/receiveDuration', 'client/networkDuration',
'client/sendDuration', 'client/totalDuration',
'dependencies/count', 'dependencies/failed',
'dependencies/duration', 'exceptions/count', 'exceptions/browser',
'exceptions/server', 'sessions/count',
'performanceCounters/requestExecutionTime',
'performanceCounters/requestsPerSecond',
'performanceCounters/requestsInQueue',
'performanceCounters/memoryAvailableBytes',
'performanceCounters/exceptionsPerSecond',
'performanceCounters/processCpuPercentage',
'performanceCounters/processIOBytesPerSecond',
'performanceCounters/processPrivateBytes',
'performanceCounters/processorCpuPercentage',
'availabilityResults/availabilityPercentage',
'availabilityResults/duration', 'billing/telemetryCount',
'customEvents/count'
</param>
<param name="timespan">
The timespan over which to retrieve metric values. This is an
ISO8601 time period value. If timespan is omitted, a default time
range of `PT12H` ("last 12 hours") is used. The actual timespan
that is queried may be adjusted by the server based. In all cases,
the actual time span used for the query is included in the
response.
</param>
<param name="interval">
The time interval to use when retrieving metric values. This is an
ISO8601 duration. If interval is omitted, the metric value is
aggregated across the entire timespan. If interval is supplied, the
server may adjust the interval to a more appropriate size based on
the timespan used for the query. In all cases, the actual interval
used for the query is included in the response.
</param>
<param name="aggregation">
The aggregation to use when computing the metric values. To
retrieve more than one aggregation at a time, separate them with a
comma. If no aggregation is specified, then the default aggregation
for the metric is used.
</param>
<param name="segment">
The name of the dimension to segment the metric values by. This
dimension must be applicable to the metric you are retrieving. To
segment by more than one dimension at a time, separate them with a
comma (,). In this case, the metric data will be segmented in the
order the dimensions are listed in the parameter.
</param>
<param name="top">
The number of segments to return. This value is only valid when
segment is specified.
</param>
<param name="orderby">
The aggregation function and direction to sort the segments by.
This value is only valid when segment is specified.
</param>
<param name="filter">
An expression used to filter the results. This value should be a
valid OData filter expression where the keys of each clause should
be applicable dimensions for the metric you are retrieving.
</param>
<param name="customHeaders">
The headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Retrieve metric data
</summary>
<returns>To be added.</returns>
<remarks>
Gets metric values for a single metric
</remarks>
</Docs>
</Member>
<Member MemberName="GetIntervaledSegmentedMetricWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsIntervaledSegmentedResult>> GetIntervaledSegmentedMetricWithHttpMessagesAsync (string appId, string metricId, string timespan = default, TimeSpan? interval = default, System.Collections.Generic.IList<string> aggregation = default, System.Collections.Generic.IList<string> segment = default, int? top = default, string orderby = default, string filter = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse`1<class Microsoft.Azure.ApplicationInsights.Query.Models.MetricsIntervaledSegmentedResult>> GetIntervaledSegmentedMetricWithHttpMessagesAsync(string appId, string metricId, string timespan, valuetype System.Nullable`1<valuetype System.TimeSpan> interval, class System.Collections.Generic.IList`1<string> aggregation, class System.Collections.Generic.IList`1<string> segment, valuetype System.Nullable`1<int32> top, string orderby, string filter, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ApplicationInsights.Query.Metrics.GetIntervaledSegmentedMetricWithHttpMessagesAsync(System.String,System.String,System.String,System.Nullable{System.TimeSpan},System.Collections.Generic.IList{System.String},System.Collections.Generic.IList{System.String},System.Nullable{System.Int32},System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetIntervaledSegmentedMetricWithHttpMessagesAsync (appId As String, metricId As String, Optional timespan As String = Nothing, Optional interval As Nullable(Of TimeSpan) = Nothing, Optional aggregation As IList(Of String) = Nothing, Optional segment As IList(Of String) = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional orderby As String = Nothing, Optional filter As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of MetricsIntervaledSegmentedResult))" />
<MemberSignature Language="F#" Value="abstract member GetIntervaledSegmentedMetricWithHttpMessagesAsync : string * string * string * Nullable<TimeSpan> * System.Collections.Generic.IList<string> * System.Collections.Generic.IList<string> * Nullable<int> * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsIntervaledSegmentedResult>>
override this.GetIntervaledSegmentedMetricWithHttpMessagesAsync : string * string * string * Nullable<TimeSpan> * System.Collections.Generic.IList<string> * System.Collections.Generic.IList<string> * Nullable<int> * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsIntervaledSegmentedResult>>" Usage="metrics.GetIntervaledSegmentedMetricWithHttpMessagesAsync (appId, metricId, timespan, interval, aggregation, segment, top, orderby, filter, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.ApplicationInsights.Query.IMetrics.GetIntervaledSegmentedMetricWithHttpMessagesAsync(System.String,System.String,System.String,System.Nullable{System.TimeSpan},System.Collections.Generic.IList{System.String},System.Collections.Generic.IList{System.String},System.Nullable{System.Int32},System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ApplicationInsights.Query</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsIntervaledSegmentedResult>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="appId" Type="System.String" />
<Parameter Name="metricId" Type="System.String" />
<Parameter Name="timespan" Type="System.String" />
<Parameter Name="interval" Type="System.Nullable<System.TimeSpan>" />
<Parameter Name="aggregation" Type="System.Collections.Generic.IList<System.String>" />
<Parameter Name="segment" Type="System.Collections.Generic.IList<System.String>" />
<Parameter Name="top" Type="System.Nullable<System.Int32>" />
<Parameter Name="orderby" Type="System.String" />
<Parameter Name="filter" Type="System.String" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="appId">
ID of the application. This is Application ID from the API Access settings
blade in the Azure portal.
</param>
<param name="metricId">
ID of the metric. This is either a standard AI metric, or an
application-specific custom metric. Possible values include:
'requests/count', 'requests/duration', 'requests/failed',
'users/count', 'users/authenticated', 'pageViews/count',
'pageViews/duration', 'client/processingDuration',
'client/receiveDuration', 'client/networkDuration',
'client/sendDuration', 'client/totalDuration',
'dependencies/count', 'dependencies/failed',
'dependencies/duration', 'exceptions/count', 'exceptions/browser',
'exceptions/server', 'sessions/count',
'performanceCounters/requestExecutionTime',
'performanceCounters/requestsPerSecond',
'performanceCounters/requestsInQueue',
'performanceCounters/memoryAvailableBytes',
'performanceCounters/exceptionsPerSecond',
'performanceCounters/processCpuPercentage',
'performanceCounters/processIOBytesPerSecond',
'performanceCounters/processPrivateBytes',
'performanceCounters/processorCpuPercentage',
'availabilityResults/availabilityPercentage',
'availabilityResults/duration', 'billing/telemetryCount',
'customEvents/count'
</param>
<param name="timespan">
The timespan over which to retrieve metric values. This is an
ISO8601 time period value. If timespan is omitted, a default time
range of `PT12H` ("last 12 hours") is used. The actual timespan
that is queried may be adjusted by the server based. In all cases,
the actual time span used for the query is included in the
response.
</param>
<param name="interval">
The time interval to use when retrieving metric values. This is an
ISO8601 duration. If interval is omitted, the metric value is
aggregated across the entire timespan. If interval is supplied, the
server may adjust the interval to a more appropriate size based on
the timespan used for the query. In all cases, the actual interval
used for the query is included in the response.
</param>
<param name="aggregation">
The aggregation to use when computing the metric values. To
retrieve more than one aggregation at a time, separate them with a
comma. If no aggregation is specified, then the default aggregation
for the metric is used.
</param>
<param name="segment">
The name of the dimension to segment the metric values by. This
dimension must be applicable to the metric you are retrieving. To
segment by more than one dimension at a time, separate them with a
comma (,). In this case, the metric data will be segmented in the
order the dimensions are listed in the parameter.
</param>
<param name="top">
The number of segments to return. This value is only valid when
segment is specified.
</param>
<param name="orderby">
The aggregation function and direction to sort the segments by.
This value is only valid when segment is specified.
</param>
<param name="filter">
An expression used to filter the results. This value should be a
valid OData filter expression where the keys of each clause should
be applicable dimensions for the metric you are retrieving.
</param>
<param name="customHeaders">
The headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Retrieve metric data
</summary>
<returns>To be added.</returns>
<remarks>
Gets metric values for a single metric
</remarks>
</Docs>
</Member>
<Member MemberName="GetMetadataWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<object>> GetMetadataWithHttpMessagesAsync (string appId, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse`1<object>> GetMetadataWithHttpMessagesAsync(string appId, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ApplicationInsights.Query.Metrics.GetMetadataWithHttpMessagesAsync(System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetMetadataWithHttpMessagesAsync (appId As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of Object))" />
<MemberSignature Language="F#" Value="abstract member GetMetadataWithHttpMessagesAsync : string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<obj>>
override this.GetMetadataWithHttpMessagesAsync : string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<obj>>" Usage="metrics.GetMetadataWithHttpMessagesAsync (appId, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.ApplicationInsights.Query.IMetrics.GetMetadataWithHttpMessagesAsync(System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ApplicationInsights.Query</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<System.Object>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="appId" Type="System.String" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="appId">
ID of the application. This is Application ID from the API Access settings
blade in the Azure portal.
</param>
<param name="customHeaders">
Headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Retrieve metric metatadata
</summary>
<returns>To be added.</returns>
<remarks>
Gets metadata describing the available metrics
</remarks>
<exception cref="T:Microsoft.Azure.ApplicationInsights.Query.Models.ErrorResponseException">
Thrown when the operation returned an invalid status code
</exception>
<exception cref="T:Microsoft.Rest.SerializationException">
Thrown when unable to deserialize the response
</exception>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown when a required parameter is null
</exception>
<exception cref="T:System.ArgumentNullException">
Thrown when a required parameter is null
</exception>
<return>
A response object containing the response body and response headers.
</return>
</Docs>
</Member>
<Member MemberName="GetMetricSummaryWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsSummaryResult>> GetMetricSummaryWithHttpMessagesAsync (string appId, string metricId, string timespan = default, System.Collections.Generic.IList<string> aggregation = default, int? top = default, string orderby = default, string filter = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse`1<class Microsoft.Azure.ApplicationInsights.Query.Models.MetricsSummaryResult>> GetMetricSummaryWithHttpMessagesAsync(string appId, string metricId, string timespan, class System.Collections.Generic.IList`1<string> aggregation, valuetype System.Nullable`1<int32> top, string orderby, string filter, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ApplicationInsights.Query.Metrics.GetMetricSummaryWithHttpMessagesAsync(System.String,System.String,System.String,System.Collections.Generic.IList{System.String},System.Nullable{System.Int32},System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetMetricSummaryWithHttpMessagesAsync (appId As String, metricId As String, Optional timespan As String = Nothing, Optional aggregation As IList(Of String) = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional orderby As String = Nothing, Optional filter As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of MetricsSummaryResult))" />
<MemberSignature Language="F#" Value="abstract member GetMetricSummaryWithHttpMessagesAsync : string * string * string * System.Collections.Generic.IList<string> * Nullable<int> * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsSummaryResult>>
override this.GetMetricSummaryWithHttpMessagesAsync : string * string * string * System.Collections.Generic.IList<string> * Nullable<int> * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsSummaryResult>>" Usage="metrics.GetMetricSummaryWithHttpMessagesAsync (appId, metricId, timespan, aggregation, top, orderby, filter, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.ApplicationInsights.Query.IMetrics.GetMetricSummaryWithHttpMessagesAsync(System.String,System.String,System.String,System.Collections.Generic.IList{System.String},System.Nullable{System.Int32},System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ApplicationInsights.Query</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsSummaryResult>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="appId" Type="System.String" />
<Parameter Name="metricId" Type="System.String" />
<Parameter Name="timespan" Type="System.String" />
<Parameter Name="aggregation" Type="System.Collections.Generic.IList<System.String>" />
<Parameter Name="top" Type="System.Nullable<System.Int32>" />
<Parameter Name="orderby" Type="System.String" />
<Parameter Name="filter" Type="System.String" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="appId">
ID of the application. This is Application ID from the API Access settings
blade in the Azure portal.
</param>
<param name="metricId">
ID of the metric. This is either a standard AI metric, or an
application-specific custom metric. Possible values include:
'requests/count', 'requests/duration', 'requests/failed',
'users/count', 'users/authenticated', 'pageViews/count',
'pageViews/duration', 'client/processingDuration',
'client/receiveDuration', 'client/networkDuration',
'client/sendDuration', 'client/totalDuration',
'dependencies/count', 'dependencies/failed',
'dependencies/duration', 'exceptions/count', 'exceptions/browser',
'exceptions/server', 'sessions/count',
'performanceCounters/requestExecutionTime',
'performanceCounters/requestsPerSecond',
'performanceCounters/requestsInQueue',
'performanceCounters/memoryAvailableBytes',
'performanceCounters/exceptionsPerSecond',
'performanceCounters/processCpuPercentage',
'performanceCounters/processIOBytesPerSecond',
'performanceCounters/processPrivateBytes',
'performanceCounters/processorCpuPercentage',
'availabilityResults/availabilityPercentage',
'availabilityResults/duration', 'billing/telemetryCount',
'customEvents/count'
</param>
<param name="timespan">
The timespan over which to retrieve metric values. This is an
ISO8601 time period value. If timespan is omitted, a default time
range of `PT12H` ("last 12 hours") is used. The actual timespan
that is queried may be adjusted by the server based. In all cases,
the actual time span used for the query is included in the
response.
</param>
<param name="aggregation">
The aggregation to use when computing the metric values. To
retrieve more than one aggregation at a time, separate them with a
comma. If no aggregation is specified, then the default aggregation
for the metric is used.
</param>
<param name="top">
The number of segments to return. This value is only valid when
segment is specified.
</param>
<param name="orderby">
The aggregation function and direction to sort the segments by.
This value is only valid when segment is specified.
</param>
<param name="filter">
An expression used to filter the results. This value should be a
valid OData filter expression where the keys of each clause should
be applicable dimensions for the metric you are retrieving.
</param>
<param name="customHeaders">
The headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Retrieve summary metric data
</summary>
<returns>To be added.</returns>
<remarks>
Gets summary metric values for a single metric
</remarks>
</Docs>
</Member>
<Member MemberName="GetMultipleWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<System.Collections.Generic.IList<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsResultsItem>>> GetMultipleWithHttpMessagesAsync (string appId, System.Collections.Generic.IList<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsPostBodySchema> body, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse`1<class System.Collections.Generic.IList`1<class Microsoft.Azure.ApplicationInsights.Query.Models.MetricsResultsItem>>> GetMultipleWithHttpMessagesAsync(string appId, class System.Collections.Generic.IList`1<class Microsoft.Azure.ApplicationInsights.Query.Models.MetricsPostBodySchema> body, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ApplicationInsights.Query.Metrics.GetMultipleWithHttpMessagesAsync(System.String,System.Collections.Generic.IList{Microsoft.Azure.ApplicationInsights.Query.Models.MetricsPostBodySchema},System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetMultipleWithHttpMessagesAsync (appId As String, body As IList(Of MetricsPostBodySchema), Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of IList(Of MetricsResultsItem)))" />
<MemberSignature Language="F#" Value="abstract member GetMultipleWithHttpMessagesAsync : string * System.Collections.Generic.IList<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsPostBodySchema> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<System.Collections.Generic.IList<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsResultsItem>>>
override this.GetMultipleWithHttpMessagesAsync : string * System.Collections.Generic.IList<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsPostBodySchema> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<System.Collections.Generic.IList<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsResultsItem>>>" Usage="metrics.GetMultipleWithHttpMessagesAsync (appId, body, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.ApplicationInsights.Query.IMetrics.GetMultipleWithHttpMessagesAsync(System.String,System.Collections.Generic.IList{Microsoft.Azure.ApplicationInsights.Query.Models.MetricsPostBodySchema},System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ApplicationInsights.Query</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<System.Collections.Generic.IList<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsResultsItem>>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="appId" Type="System.String" />
<Parameter Name="body" Type="System.Collections.Generic.IList<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsPostBodySchema>" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="appId">
ID of the application. This is Application ID from the API Access settings
blade in the Azure portal.
</param>
<param name="body">
The batched metrics query.
</param>
<param name="customHeaders">
Headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Retrieve metric data
</summary>
<returns>To be added.</returns>
<remarks>
Gets metric values for multiple metrics
</remarks>
<exception cref="T:Microsoft.Azure.ApplicationInsights.Query.Models.ErrorResponseException">
Thrown when the operation returned an invalid status code
</exception>
<exception cref="T:Microsoft.Rest.SerializationException">
Thrown when unable to deserialize the response
</exception>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown when a required parameter is null
</exception>
<exception cref="T:System.ArgumentNullException">
Thrown when a required parameter is null
</exception>
<return>
A response object containing the response body and response headers.
</return>
</Docs>
</Member>
<Member MemberName="GetSegmentedMetricWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsSegmentedResult>> GetSegmentedMetricWithHttpMessagesAsync (string appId, string metricId, string timespan = default, System.Collections.Generic.IList<string> aggregation = default, System.Collections.Generic.IList<string> segment = default, int? top = default, string orderby = default, string filter = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse`1<class Microsoft.Azure.ApplicationInsights.Query.Models.MetricsSegmentedResult>> GetSegmentedMetricWithHttpMessagesAsync(string appId, string metricId, string timespan, class System.Collections.Generic.IList`1<string> aggregation, class System.Collections.Generic.IList`1<string> segment, valuetype System.Nullable`1<int32> top, string orderby, string filter, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ApplicationInsights.Query.Metrics.GetSegmentedMetricWithHttpMessagesAsync(System.String,System.String,System.String,System.Collections.Generic.IList{System.String},System.Collections.Generic.IList{System.String},System.Nullable{System.Int32},System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetSegmentedMetricWithHttpMessagesAsync (appId As String, metricId As String, Optional timespan As String = Nothing, Optional aggregation As IList(Of String) = Nothing, Optional segment As IList(Of String) = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional orderby As String = Nothing, Optional filter As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of MetricsSegmentedResult))" />
<MemberSignature Language="F#" Value="abstract member GetSegmentedMetricWithHttpMessagesAsync : string * string * string * System.Collections.Generic.IList<string> * System.Collections.Generic.IList<string> * Nullable<int> * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsSegmentedResult>>
override this.GetSegmentedMetricWithHttpMessagesAsync : string * string * string * System.Collections.Generic.IList<string> * System.Collections.Generic.IList<string> * Nullable<int> * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsSegmentedResult>>" Usage="metrics.GetSegmentedMetricWithHttpMessagesAsync (appId, metricId, timespan, aggregation, segment, top, orderby, filter, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.ApplicationInsights.Query.IMetrics.GetSegmentedMetricWithHttpMessagesAsync(System.String,System.String,System.String,System.Collections.Generic.IList{System.String},System.Collections.Generic.IList{System.String},System.Nullable{System.Int32},System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ApplicationInsights.Query</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsSegmentedResult>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="appId" Type="System.String" />
<Parameter Name="metricId" Type="System.String" />
<Parameter Name="timespan" Type="System.String" />
<Parameter Name="aggregation" Type="System.Collections.Generic.IList<System.String>" />
<Parameter Name="segment" Type="System.Collections.Generic.IList<System.String>" />
<Parameter Name="top" Type="System.Nullable<System.Int32>" />
<Parameter Name="orderby" Type="System.String" />
<Parameter Name="filter" Type="System.String" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="appId">
ID of the application. This is Application ID from the API Access settings
blade in the Azure portal.
</param>
<param name="metricId">
ID of the metric. This is either a standard AI metric, or an
application-specific custom metric. Possible values include:
'requests/count', 'requests/duration', 'requests/failed',
'users/count', 'users/authenticated', 'pageViews/count',
'pageViews/duration', 'client/processingDuration',
'client/receiveDuration', 'client/networkDuration',
'client/sendDuration', 'client/totalDuration',
'dependencies/count', 'dependencies/failed',
'dependencies/duration', 'exceptions/count', 'exceptions/browser',
'exceptions/server', 'sessions/count',
'performanceCounters/requestExecutionTime',
'performanceCounters/requestsPerSecond',
'performanceCounters/requestsInQueue',
'performanceCounters/memoryAvailableBytes',
'performanceCounters/exceptionsPerSecond',
'performanceCounters/processCpuPercentage',
'performanceCounters/processIOBytesPerSecond',
'performanceCounters/processPrivateBytes',
'performanceCounters/processorCpuPercentage',
'availabilityResults/availabilityPercentage',
'availabilityResults/duration', 'billing/telemetryCount',
'customEvents/count'
</param>
<param name="timespan">
The timespan over which to retrieve metric values. This is an
ISO8601 time period value. If timespan is omitted, a default time
range of `PT12H` ("last 12 hours") is used. The actual timespan
that is queried may be adjusted by the server based. In all cases,
the actual time span used for the query is included in the
response.
</param>
<param name="aggregation">
The aggregation to use when computing the metric values. To
retrieve more than one aggregation at a time, separate them with a
comma. If no aggregation is specified, then the default aggregation
for the metric is used.
</param>
<param name="segment">
The name of the dimension to segment the metric values by. This
dimension must be applicable to the metric you are retrieving. To
segment by more than one dimension at a time, separate them with a
comma (,). In this case, the metric data will be segmented in the
order the dimensions are listed in the parameter.
</param>
<param name="top">
The number of segments to return. This value is only valid when
segment is specified.
</param>
<param name="orderby">
The aggregation function and direction to sort the segments by.
This value is only valid when segment is specified.
</param>
<param name="filter">
An expression used to filter the results. This value should be a
valid OData filter expression where the keys of each clause should
be applicable dimensions for the metric you are retrieving.
</param>
<param name="customHeaders">
The headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Retrieve metric data
</summary>
<returns>To be added.</returns>
<remarks>
Gets metric values for a single metric
</remarks>
</Docs>
</Member>
<Member MemberName="GetWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsResult>> GetWithHttpMessagesAsync (string appId, string metricId, string timespan = default, TimeSpan? interval = default, System.Collections.Generic.IList<string> aggregation = default, System.Collections.Generic.IList<string> segment = default, int? top = default, string orderby = default, string filter = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse`1<class Microsoft.Azure.ApplicationInsights.Query.Models.MetricsResult>> GetWithHttpMessagesAsync(string appId, string metricId, string timespan, valuetype System.Nullable`1<valuetype System.TimeSpan> interval, class System.Collections.Generic.IList`1<string> aggregation, class System.Collections.Generic.IList`1<string> segment, valuetype System.Nullable`1<int32> top, string orderby, string filter, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ApplicationInsights.Query.Metrics.GetWithHttpMessagesAsync(System.String,System.String,System.String,System.Nullable{System.TimeSpan},System.Collections.Generic.IList{System.String},System.Collections.Generic.IList{System.String},System.Nullable{System.Int32},System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetWithHttpMessagesAsync (appId As String, metricId As String, Optional timespan As String = Nothing, Optional interval As Nullable(Of TimeSpan) = Nothing, Optional aggregation As IList(Of String) = Nothing, Optional segment As IList(Of String) = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional orderby As String = Nothing, Optional filter As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of MetricsResult))" />
<MemberSignature Language="F#" Value="abstract member GetWithHttpMessagesAsync : string * string * string * Nullable<TimeSpan> * System.Collections.Generic.IList<string> * System.Collections.Generic.IList<string> * Nullable<int> * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsResult>>
override this.GetWithHttpMessagesAsync : string * string * string * Nullable<TimeSpan> * System.Collections.Generic.IList<string> * System.Collections.Generic.IList<string> * Nullable<int> * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsResult>>" Usage="metrics.GetWithHttpMessagesAsync (appId, metricId, timespan, interval, aggregation, segment, top, orderby, filter, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.ApplicationInsights.Query.IMetrics.GetWithHttpMessagesAsync(System.String,System.String,System.String,System.Nullable{System.TimeSpan},System.Collections.Generic.IList{System.String},System.Collections.Generic.IList{System.String},System.Nullable{System.Int32},System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ApplicationInsights.Query</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.ApplicationInsights.Query.Models.MetricsResult>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="appId" Type="System.String" />
<Parameter Name="metricId" Type="System.String" />
<Parameter Name="timespan" Type="System.String" />
<Parameter Name="interval" Type="System.Nullable<System.TimeSpan>" />
<Parameter Name="aggregation" Type="System.Collections.Generic.IList<System.String>" />
<Parameter Name="segment" Type="System.Collections.Generic.IList<System.String>" />
<Parameter Name="top" Type="System.Nullable<System.Int32>" />
<Parameter Name="orderby" Type="System.String" />
<Parameter Name="filter" Type="System.String" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="appId">
ID of the application. This is Application ID from the API Access settings
blade in the Azure portal.
</param>
<param name="metricId">
ID of the metric. This is either a standard AI metric, or an
application-specific custom metric. Possible values include:
'requests/count', 'requests/duration', 'requests/failed', 'users/count',
'users/authenticated', 'pageViews/count', 'pageViews/duration',
'client/processingDuration', 'client/receiveDuration',
'client/networkDuration', 'client/sendDuration', 'client/totalDuration',
'dependencies/count', 'dependencies/failed', 'dependencies/duration',
'exceptions/count', 'exceptions/browser', 'exceptions/server',
'sessions/count', 'performanceCounters/requestExecutionTime',
'performanceCounters/requestsPerSecond',
'performanceCounters/requestsInQueue',
'performanceCounters/memoryAvailableBytes',
'performanceCounters/exceptionsPerSecond',
'performanceCounters/processCpuPercentage',
'performanceCounters/processIOBytesPerSecond',
'performanceCounters/processPrivateBytes',
'performanceCounters/processorCpuPercentage',
'availabilityResults/availabilityPercentage',
'availabilityResults/duration', 'billing/telemetryCount',
'customEvents/count'
</param>
<param name="timespan">
The timespan over which to retrieve metric values. This is an ISO8601 time
period value. If timespan is omitted, a default time range of `PT12H`
("last 12 hours") is used. The actual timespan that is queried may be
adjusted by the server based. In all cases, the actual time span used for
the query is included in the response.
</param>
<param name="interval">
The time interval to use when retrieving metric values. This is an ISO8601
duration. If interval is omitted, the metric value is aggregated across the
entire timespan. If interval is supplied, the server may adjust the
interval to a more appropriate size based on the timespan used for the
query. In all cases, the actual interval used for the query is included in
the response.
</param>
<param name="aggregation">
The aggregation to use when computing the metric values. To retrieve more
than one aggregation at a time, separate them with a comma. If no
aggregation is specified, then the default aggregation for the metric is
used.
</param>
<param name="segment">
The name of the dimension to segment the metric values by. This dimension
must be applicable to the metric you are retrieving. To segment by more
than one dimension at a time, separate them with a comma (,). In this case,
the metric data will be segmented in the order the dimensions are listed in
the parameter.
</param>
<param name="top">
The number of segments to return. This value is only valid when segment is
specified.
</param>
<param name="orderby">
The aggregation function and direction to sort the segments by. This value
is only valid when segment is specified.
</param>
<param name="filter">
An expression used to filter the results. This value should be a valid
OData filter expression where the keys of each clause should be applicable
dimensions for the metric you are retrieving.
</param>
<param name="customHeaders">
Headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Retrieve metric data
</summary>
<returns>To be added.</returns>
<remarks>
Gets metric values for a single metric
</remarks>
<exception cref="T:Microsoft.Azure.ApplicationInsights.Query.Models.ErrorResponseException">
Thrown when the operation returned an invalid status code
</exception>
<exception cref="T:Microsoft.Rest.SerializationException">
Thrown when unable to deserialize the response
</exception>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown when a required parameter is null
</exception>
<exception cref="T:System.ArgumentNullException">
Thrown when a required parameter is null
</exception>
<return>
A response object containing the response body and response headers.
</return>
</Docs>
</Member>
</Members>
</Type>