ApplicationInsightsDataClientExtensions.GetMetricSummaryAsync Method

Definition

Namespace:

Microsoft.Azure.ApplicationInsights

Assembly:

Microsoft.Azure.ApplicationInsights.dll

Package:

Microsoft.Azure.ApplicationInsights v0.9.0-preview

Retrieve summary metric data

public static System.Threading.Tasks.Task<Microsoft.Azure.ApplicationInsights.Models.MetricsSummaryResult> GetMetricSummaryAsync (this Microsoft.Azure.ApplicationInsights.IApplicationInsightsDataClient operations, string metricId, TimeSpan? timespan = default, System.Collections.Generic.IList<string> aggregation = default, int? top = default, string orderby = default, string filter = default, System.Threading.CancellationToken cancellationToken = default);

static member GetMetricSummaryAsync : Microsoft.Azure.ApplicationInsights.IApplicationInsightsDataClient * string * Nullable<TimeSpan> * System.Collections.Generic.IList<string> * Nullable<int> * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.ApplicationInsights.Models.MetricsSummaryResult>

<Extension()>
Public Function GetMetricSummaryAsync (operations As IApplicationInsightsDataClient, metricId As String, Optional timespan As Nullable(Of TimeSpan) = 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 cancellationToken As CancellationToken = Nothing) As Task(Of MetricsSummaryResult)

Parameters

operations

IApplicationInsightsDataClient

The operations group for this extension method.

metricId

String

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'

timespan

Nullable<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.

aggregation

IList<String>

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.

top

Nullable<Int32>

The number of segments to return. This value is only valid when segment is specified.

orderby

String

The aggregation function and direction to sort the segments by. This value is only valid when segment is specified.

filter

String

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.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<MetricsSummaryResult>

Remarks

Gets summary metric values for a single metric