Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricFilter

Package version

interface

An interface representing MetricFilter. The OData filters to be used for metrics.

Hierarchy

  • MetricFilter

Index

Properties

category

category: string
member

{string} category Specifies the category of the metrics to be filtered. E.g., "CapacityUtilization". Valid values are the ones returned as the field "category" in the ListMetricDefinitions call. Only 'Equality' operator is supported for this property.

Optional dimensions

dimensions: DimensionFilter
member

{DimensionFilter} [dimensions] Specifies the source(the dimension) of the metrics to be filtered. Only 'Equality' operator is supported for this property.

Optional endTime

endTime: Date
member

{Date} [endTime] Specifies the end time of the time range to be queried. Only 'Less Than Or Equal To' operator is supported for this property.

Optional name

member

{MetricNameFilter} [name] Specifies the metric name filter specifying the name of the metric to be filtered on. Only 'Equality' operator is supported for this property.

Optional startTime

startTime: Date
member

{Date} [startTime] Specifies the start time of the time range to be queried. Only 'Greater Than Or Equal To' operator is supported for this property.

Optional timeGrain

timeGrain: undefined | string
member

{string} [timeGrain] Specifies the time granularity of the metrics to be returned. E.g., "P1D". Valid values are the ones returned as the field "timeGrain" in the ListMetricDefinitions call. Only 'Equality' operator is supported for this property.

Generated using TypeDoc