Language

SubscriptionScopeMetricsContent Class

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 class SubscriptionScopeMetricsContent : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Monitor.Models.SubscriptionScopeMetricsContent>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Monitor.Models.SubscriptionScopeMetricsContent>
type SubscriptionScopeMetricsContent = class
    interface IJsonModel<SubscriptionScopeMetricsContent>
    interface IPersistableModel<SubscriptionScopeMetricsContent>
Public Class SubscriptionScopeMetricsContent
Implements IJsonModel(Of SubscriptionScopeMetricsContent), IPersistableModel(Of SubscriptionScopeMetricsContent)
Inheritance
SubscriptionScopeMetricsContent
Implements

Constructors

Name Description
SubscriptionScopeMetricsContent()

Initializes a new instance of SubscriptionScopeMetricsContent.

Properties

Name Description
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 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

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.

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.

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.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<SubscriptionScopeMetricsContent>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<SubscriptionScopeMetricsContent>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<SubscriptionScopeMetricsContent>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<SubscriptionScopeMetricsContent>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<SubscriptionScopeMetricsContent>.Write(ModelReaderWriterOptions)

Applies to