BaselinesOperationsExtensions.ListAsync Method

Definition

Namespace:

Microsoft.Azure.Management.Monitor

Assembly:

Microsoft.Azure.Management.Monitor.dll

Package:

Microsoft.Azure.Management.Monitor v0.28.0-preview

Lists the metric baseline values for a resource.

public static System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.Azure.Management.Monitor.Models.SingleMetricBaseline>> ListAsync (this Microsoft.Azure.Management.Monitor.IBaselinesOperations operations, string resourceUri, string metricnames = default, string metricnamespace = default, string timespan = default, TimeSpan? interval = default, string aggregation = default, string sensitivities = default, string filter = default, Microsoft.Azure.Management.Monitor.Models.ResultType? resultType = default, System.Threading.CancellationToken cancellationToken = default);

static member ListAsync : Microsoft.Azure.Management.Monitor.IBaselinesOperations * string * string * string * string * Nullable<TimeSpan> * string * string * string * Nullable<Microsoft.Azure.Management.Monitor.Models.ResultType> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Microsoft.Azure.Management.Monitor.Models.SingleMetricBaseline>>

<Extension()>
Public Function ListAsync (operations As IBaselinesOperations, 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 Task(Of IEnumerable(Of SingleMetricBaseline))

Parameters

operations

IBaselinesOperations

The operations group for this extension method.

resourceUri

String

The identifier of the resource.

metricnames

String

The names of the metrics (comma separated) to retrieve. Special case: If a metricname itself has a comma in it then use %2 to indicate it. Eg: 'Metric,Name1' should be 'Metric%2Name1'

metricnamespace

String

Metric namespace to query metric definitions for.

timespan

String

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

interval

Nullable<TimeSpan>

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

aggregation

String

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

sensitivities

String

The list of sensitivities (comma separated) to retrieve.

filter

String

The $filter is used to reduce the set of metric data returned. Example: Metric contains metadata A, B and C. - Return all time series of C where A = a1 and B = b1 or b2 $filter=A eq 'a1' and B eq 'b1' or B eq 'b2' and C eq '*' - Invalid variant: $filter=A eq 'a1' and B eq 'b1' and C eq '*' or B = 'b2' This is invalid because the logical or operator cannot separate two different metadata names. - Return all time series where A = a1, B = b1 and C = c1: $filter=A eq 'a1' and B eq 'b1' and C eq 'c1' - Return all time series where A = a1 $filter=A eq 'a1' and B eq '' and C eq ''. Special case: When dimension name or dimension value uses round brackets. Eg: When dimension name is dim (test) 1 Instead of using $filter= "dim (test) 1 eq '' " use **$filter= "dim %2528test%2529 1 eq '' "** When dimension name is dim (test) 3 and dimension value is dim3 (test) val Instead of using $filter= "dim (test) 3 eq 'dim3 (test) val' " use $filter= "dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' "

resultType

Nullable<ResultType>

Allows retrieving only metadata of the baseline. On data request all information is retrieved. Possible values include: 'Data', 'Metadata'

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<IEnumerable<SingleMetricBaseline>>