Share via


MetricsQueryResourcesOptions Class

Definition

public class MetricsQueryResourcesOptions
type MetricsQueryResourcesOptions = class
Public Class MetricsQueryResourcesOptions
Inheritance
MetricsQueryResourcesOptions

Constructors

MetricsQueryResourcesOptions()

Properties

Aggregations

Gets the list of metric aggregations to retrieve.

Although this collection cannot be set, it can be modified. See Object initializers with collection read-only property initialization.

Filter

Gets or sets the filter that is used to refine the set of metric data returned. MetricResult contains metadata A, B, and C.

- Return all time series of C where A = a1 and B = b1 or b2:
A eq 'a1' and B eq 'b1' or B eq 'b2' and C eq ''
- Invalid variant:
A eq 'a1' and B eq 'b1' and C eq '' or B = 'b2'
This is invalid because the logical or operator cannot separate two different metadata names.
- Return all time series where A = a1, B = b1 and C = c1:
A eq 'a1' and B eq 'b1' and C eq 'c1'
- Return all time series where A = a1
A eq 'a1' and B eq '' and C eq ''.

Granularity

Gets or sets the interval at which to sample metrics.

OrderBy

Gets or sets the aggregation to use for sorting results and the direction of the sort. Only one order can be specified. Examples: sum asc.

RollUpBy

Dimension name(s) to rollup results by. Examples: If you only want to see metric values with a filter like 'City eq Seattle or City eq Tacoma' but don't want to see separate values for each city, you can specify 'RollUpBy=City' to see the results for Seattle and Tacoma rolled up into one timeseries.

Size

Gets or sets the maximum number of records to retrieve. Valid only when Filter is specified. Defaults to null.

TimeRange

Gets or sets the timespan over which the metric will be queried.

Applies to