BaselinesOperations.List Method

Definition

Lists the metric baseline values for a resource.

public virtual Azure.Pageable<Azure.ResourceManager.Insights.Models.SingleMetricBaseline> List (string resourceUri, string metricnames = default, string metricnamespace = default, string timespan = default, TimeSpan? interval = default, string aggregation = default, string sensitivities = default, string filter = default, Azure.ResourceManager.Insights.Models.ResultType? resultType = default, System.Threading.CancellationToken cancellationToken = default);
abstract member List : string * string * string * string * Nullable<TimeSpan> * string * string * string * Nullable<Azure.ResourceManager.Insights.Models.ResultType> * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Insights.Models.SingleMetricBaseline>
override this.List : string * string * string * string * Nullable<TimeSpan> * string * string * string * Nullable<Azure.ResourceManager.Insights.Models.ResultType> * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Insights.Models.SingleMetricBaseline>
Public Overridable Function List (resourceUri As String, Optional metricnames As String = Nothing, Optional metricnamespace As String = Nothing, Optional timespan As String = Nothing, Optional interval As Nullable(Of TimeSpan) = Nothing, Optional aggregation As String = Nothing, Optional sensitivities As String = Nothing, Optional filter As String = Nothing, Optional resultType As Nullable(Of ResultType) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of SingleMetricBaseline)

Parameters

resourceUri
System.String

The identifier of the resource.

metricnames
System.String

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

metricnamespace
System.String

Metric namespace to query metric definitions for.

timespan
System.String

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

interval
System.Nullable<System.TimeSpan>

The interval (i.e. timegrain) of the query.

aggregation
System.String

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

sensitivities
System.String

The list of sensitivities (comma separated) to retrieve.

filter
System.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 ‘.

resultType
System.Nullable<ResultType>

Allows retrieving only metadata of the baseline. On data request all information is retrieved.

cancellationToken
System.Threading.CancellationToken

The cancellation token to use.

Returns

Pageable<SingleMetricBaseline>

Exceptions

System.ArgumentNullException

resourceUri is null.

Applies to