ApplicationInsightsDataClientExtensions.GetSegmentedMetric(IApplicationInsightsDataClient, String, Nullable<TimeSpan>, IList<String>, IList<String>, Nullable<Int32>, String, String) ApplicationInsightsDataClientExtensions.GetSegmentedMetric(IApplicationInsightsDataClient, String, Nullable<TimeSpan>, IList<String>, IList<String>, Nullable<Int32>, String, String) ApplicationInsightsDataClientExtensions.GetSegmentedMetric(IApplicationInsightsDataClient, String, Nullable<TimeSpan>, IList<String>, IList<String>, Nullable<Int32>, String, String) Method

Definition

Retrieve metric data

public static Microsoft.Azure.ApplicationInsights.Models.MetricsSegmentedResult GetSegmentedMetric (this Microsoft.Azure.ApplicationInsights.IApplicationInsightsDataClient operations, string metricId, Nullable<TimeSpan> timespan = null, System.Collections.Generic.IList<string> aggregation = null, System.Collections.Generic.IList<string> segment = null, Nullable<int> top = null, string orderby = null, string filter = null);
static member GetSegmentedMetric : Microsoft.Azure.ApplicationInsights.IApplicationInsightsDataClient * string * Nullable<TimeSpan> * System.Collections.Generic.IList<string> * System.Collections.Generic.IList<string> * Nullable<int> * string * string -> Microsoft.Azure.ApplicationInsights.Models.MetricsSegmentedResult
<Extension()>
Public Function GetSegmentedMetric (operations As IApplicationInsightsDataClient, metricId As String, Optional timespan As Nullable(Of TimeSpan) = null, Optional aggregation As IList(Of String) = null, Optional segment As IList(Of String) = null, Optional top As Nullable(Of Integer) = null, Optional orderby As String = null, Optional filter As String = null) As MetricsSegmentedResult

Parameters

operations
IApplicationInsightsDataClient IApplicationInsightsDataClient IApplicationInsightsDataClient

The operations group for this extension method.

metricId
String String 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.

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

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

filter
String String 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.

Returns

Remarks

Gets metric values for a single metric

Applies to