Idioma

MockableMonitorArmClient.GetMonitorMetricBaselinesAsync Method

Definition

Lists the metric baseline values for a resource.

  • Request Path. : /{resourceUri}/providers/Microsoft.Insights/metricBaselines.
  • Operation Id. : BaselinesOperationGroup_List.
  • Default Api Version. : 2019-03-01.
public virtual Azure.AsyncPageable<Azure.ResourceManager.Monitor.Models.MonitorSingleMetricBaseline> GetMonitorMetricBaselinesAsync(Azure.Core.ResourceIdentifier scope, string metricnames = default, string metricnamespace = default, string timespan = default, TimeSpan? interval = default, string aggregation = default, string sensitivities = default, string filter = default, Azure.ResourceManager.Monitor.Models.MonitorResultType? resultType = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetMonitorMetricBaselinesAsync : Azure.Core.ResourceIdentifier * string * string * string * Nullable<TimeSpan> * string * string * string * Nullable<Azure.ResourceManager.Monitor.Models.MonitorResultType> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Monitor.Models.MonitorSingleMetricBaseline>
override this.GetMonitorMetricBaselinesAsync : Azure.Core.ResourceIdentifier * string * string * string * Nullable<TimeSpan> * string * string * string * Nullable<Azure.ResourceManager.Monitor.Models.MonitorResultType> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Monitor.Models.MonitorSingleMetricBaseline>
Public Overridable Function GetMonitorMetricBaselinesAsync (scope As ResourceIdentifier, 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 MonitorResultType) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of MonitorSingleMetricBaseline)

Parameters

scope
ResourceIdentifier

The scope that the resource will apply against.

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 that contains the requested metric names.

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<MonitorResultType>

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

cancellationToken
CancellationToken

The cancellation token to use.

Returns

A collection of MonitorSingleMetricBaseline that may take multiple service requests to iterate over.

Exceptions

scope is null.

Applies to