MetricsAdvisorClient.GetMetricEnrichedSeriesDataAsync Method

Definition

Namespace:

Azure.AI.MetricsAdvisor

Assembly:

Azure.AI.MetricsAdvisor.dll

Package:

Azure.AI.MetricsAdvisor v1.1.0

Source:

MetricsAdvisorClient.cs

Query series enriched by anomaly detection.

public virtual Azure.AsyncPageable<Azure.AI.MetricsAdvisor.Models.MetricEnrichedSeriesData> GetMetricEnrichedSeriesDataAsync (string detectionConfigurationId, System.Collections.Generic.IEnumerable<Azure.AI.MetricsAdvisor.Models.DimensionKey> seriesKeys, DateTimeOffset startsOn, DateTimeOffset endsOn, System.Threading.CancellationToken cancellationToken = default);

abstract member GetMetricEnrichedSeriesDataAsync : string * seq<Azure.AI.MetricsAdvisor.Models.DimensionKey> * DateTimeOffset * DateTimeOffset * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.AI.MetricsAdvisor.Models.MetricEnrichedSeriesData>
override this.GetMetricEnrichedSeriesDataAsync : string * seq<Azure.AI.MetricsAdvisor.Models.DimensionKey> * DateTimeOffset * DateTimeOffset * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.AI.MetricsAdvisor.Models.MetricEnrichedSeriesData>

Public Overridable Function GetMetricEnrichedSeriesDataAsync (detectionConfigurationId As String, seriesKeys As IEnumerable(Of DimensionKey), startsOn As DateTimeOffset, endsOn As DateTimeOffset, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of MetricEnrichedSeriesData)

Parameters

detectionConfigurationId

String

The unique identifier of the AnomalyAlertConfiguration.

seriesKeys

IEnumerable<DimensionKey>

Filters the result by time series. Each element in this enumerable represents a single time series, and only anomalies detected in one of these series will be returned. For every element, all possible dimensions must be set.

startsOn

DateTimeOffset

Filters the result. Only data points after this point in time, in UTC, will be returned.

endsOn

DateTimeOffset

Filters the result. Only data points after this point in time, in UTC, will be returned.

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

AsyncPageable<MetricEnrichedSeriesData>

An AsyncPageable<T> containing the collection of MetricEnrichedSeriesDatas.

Exceptions

ArgumentNullException

detectionConfigurationId or seriesKeys is null.

ArgumentException

detectionConfigurationId is empty or not a valid GUID.