ArmResourceGetMonitorMetricsOptions Class
Definition
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.
The ArmResourceGetMonitorMetricsOptions.
public class ArmResourceGetMonitorMetricsOptions
type ArmResourceGetMonitorMetricsOptions = class
Public Class ArmResourceGetMonitorMetricsOptions
- Inheritance
-
ArmResourceGetMonitorMetricsOptions
Constructors
ArmResourceGetMonitorMetricsOptions() |
Initializes a new instance of ArmResourceGetMonitorMetricsOptions. |
Properties
Aggregation |
The list of aggregation types (comma separated) to retrieve. |
AutoAdjustTimegrain |
When set to true, if the timespan passed in is not supported by this metric, the API will return the result using the closest supported timespan. When set to false, an error is returned for invalid timespan parameters. Defaults to false. |
Filter |
The $filter is used to reduce the set of metric data returned.<br>Example:<br>Metric contains metadata A, B and C.<br>- Return all time series of C where A = a1 and B = b1 or b2<br>$filter=A eq ‘a1’ and B eq ‘b1’ or B eq ‘b2’ and C eq ‘*’<br>- Invalid variant:<br>$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘*’ or B = ‘b2’<br>This is invalid because the logical or operator cannot separate two different metadata names.<br>- Return all time series where A = a1, B = b1 and C = c1:<br>$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘c1’<br>- Return all time series where A = a1<br>$filter=A eq ‘a1’ and B eq ‘’ and C eq ‘’. |
Interval |
The interval (i.e. timegrain) of the query. |
Metricnames |
The names of the metrics (comma separated) to retrieve. |
Metricnamespace |
Metric namespace where the metrics you want reside. |
Orderby |
The aggregation to use for sorting results and the direction of the sort. Only one order can be specified. Examples: sum asc. |
ResultType |
Reduces the set of data collected. The syntax allowed depends on the operation. See the operation's description for details. |
Timespan |
The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'. |
Top |
The maximum number of records to retrieve. Valid only if $filter is specified. Defaults to 10. |
ValidateDimensions |
When set to false, invalid filter parameter values will be ignored. When set to true, an error is returned for invalid filter parameters. Defaults to true. |