IMetrics.GetWithHttpMessagesAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.ApplicationInsights.Query

Assembly:: Microsoft.Azure.ApplicationInsights.Query.dll

Package:: Microsoft.Azure.ApplicationInsights.Query v1.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Retrieve metric data

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);

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

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))

Parameters

appId: String

ID of the application. This is Application ID from the API Access settings blade in the Azure portal.

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: String

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.

interval: Nullable<TimeSpan>

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.

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.

segment: IList<String>

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.

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.