MetricsQueryResourcesOptions interface

Package:

@azure/monitor-query

Optional parameters.

Extends

OperationOptions

Properties

aggregation	The list of aggregation types (comma separated) to retrieve. Examples: average, minimum, maximum
endTime	The end time of the query. It is a string in the format 'yyyy-MM-ddTHH:mm:ss.fffZ'.
filter	The filter is used to reduce the set of metric data returned. Example: Metric contains metadata A, B and C. - Return all time series of C where A = a1 and B = b1 or b2 filter=A eq ‘a1’ and B eq ‘b1’ or B eq ‘b2’ and C eq ‘*’ - Invalid variant: filter=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: filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘c1’ - Return all time series where A = a1 filter=A eq ‘a1’ and B eq ‘’ and C eq ‘’.
interval	The interval (i.e. timegrain) of the query. Examples: PT15M, PT1H, P1D
orderBy	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. For example 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.
startTime	The start time of the query. It is a string in the format 'yyyy-MM-ddTHH:mm:ss.fffZ'. If you have specified the endTime parameter, then this parameter is required. If only startTime is specified, then endTime defaults to the current time. If no time interval is specified, the default is 1 hour.
top	The maximum number of records to retrieve per resource ID in the request. Valid only if filter is specified. Defaults to 10.

Inherited Properties

abortSignal	The signal which can be used to abort requests.
onResponse	A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
requestOptions	Options used when creating and sending HTTP requests for this operation.
serializerOptions	Options to override serialization/de-serialization behavior.
tracingOptions	Options used when tracing is enabled.

Property Details

aggregation

The list of aggregation types (comma separated) to retrieve. Examples: average, minimum, maximum

aggregation?: string

Property Value

string

endTime

The end time of the query. It is a string in the format 'yyyy-MM-ddTHH:mm:ss.fffZ'.

endTime?: Date

Property Value

Date

filter

The filter is used to reduce the set of metric data returned.
Example:
Metric contains metadata A, B and C.
- Return all time series of C where A = a1 and B = b1 or b2
filter=A eq ‘a1’ and B eq ‘b1’ or B eq ‘b2’ and C eq ‘*’
- Invalid variant:
filter=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:
filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘c1’
- Return all time series where A = a1
filter=A eq ‘a1’ and B eq ‘’ and C eq ‘’.

filter?: string

Property Value

string

interval

The interval (i.e. timegrain) of the query. Examples: PT15M, PT1H, P1D

interval?: string

Property Value

string

orderBy

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

orderBy?: string

Property Value

string

rollUpBy

Dimension name(s) to rollup results by. For example 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.

rollUpBy?: string

Property Value

string

startTime

The start time of the query. It is a string in the format 'yyyy-MM-ddTHH:mm:ss.fffZ'. If you have specified the endTime parameter, then this parameter is required. If only startTime is specified, then endTime defaults to the current time. If no time interval is specified, the default is 1 hour.

startTime?: Date

Property Value

Date

top

The maximum number of records to retrieve per resource ID in the request. Valid only if filter is specified. Defaults to 10.

top?: number

Property Value

number

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From coreClient.OperationOptions.abortSignal

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From coreClient.OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From coreClient.OperationOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

Inherited From coreClient.OperationOptions.serializerOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From coreClient.OperationOptions.tracingOptions