Language

ArmMonitorModelFactory.SubscriptionScopeMetricsContent Method

Definition

Query parameters can also be specified in the body, specifying the same parameter in both the body and query parameters will result in an error.

public static Azure.ResourceManager.Monitor.Models.SubscriptionScopeMetricsContent SubscriptionScopeMetricsContent(string timespan = default, string interval = default, string metricNames = default, string aggregation = default, string filter = default, int? top = default, string orderBy = default, string rollUpBy = default, Azure.ResourceManager.Monitor.Models.MonitorMetricResultType? resultType = default, string metricNamespace = default, bool? autoAdjustTimegrain = default, bool? validateDimensions = default);
static member SubscriptionScopeMetricsContent : string * string * string * string * string * Nullable<int> * string * string * Nullable<Azure.ResourceManager.Monitor.Models.MonitorMetricResultType> * string * Nullable<bool> * Nullable<bool> -> Azure.ResourceManager.Monitor.Models.SubscriptionScopeMetricsContent
Public Shared Function SubscriptionScopeMetricsContent (Optional timespan As String = Nothing, Optional interval As String = Nothing, Optional metricNames As String = Nothing, Optional aggregation As String = Nothing, Optional filter As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional orderBy As String = Nothing, Optional rollUpBy As String = Nothing, Optional resultType As Nullable(Of MonitorMetricResultType) = Nothing, Optional metricNamespace As String = Nothing, Optional autoAdjustTimegrain As Nullable(Of Boolean) = Nothing, Optional validateDimensions As Nullable(Of Boolean) = Nothing) As SubscriptionScopeMetricsContent

Parameters

timespan
String

The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'.

interval
String

The interval (i.e. timegrain) of the query in ISO 8601 duration format. Defaults to PT1M. Special case for 'FULL' value that returns single datapoint for entire time span requested. Examples: PT15M, PT1H, P1D, FULL

metricNames
String

The names of the metrics (comma separated) to retrieve.

aggregation
String

The list of aggregation types (comma separated) to retrieve.

filter
String

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 ‘’.

top
Nullable<Int32>

The maximum number of records to retrieve. Valid only if $filter is specified. Defaults to 10.

orderBy
String

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

rollUpBy
String

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.

resultType
Nullable<MonitorMetricResultType>

Reduces the set of data collected. The syntax allowed depends on the operation. See the operation's description for details.

metricNamespace
String

Metric namespace where the metrics you want reside.

autoAdjustTimegrain
Nullable<Boolean>

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.

validateDimensions
Nullable<Boolean>

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.

Returns

A new SubscriptionScopeMetricsContent instance for mocking.

Applies to