MetricsAdvisorClient.GetAnomaliesForAlertAsync Method

Definition

Namespace:

Azure.AI.MetricsAdvisor

Assembly:

Azure.AI.MetricsAdvisor.dll

Package:

Azure.AI.MetricsAdvisor v1.1.0

Source:

MetricsAdvisorClient.cs

Gets the collection of anomalies that triggered a specified alert. The associated AnomalyAlertConfiguration must also be specified.

public virtual Azure.AsyncPageable<Azure.AI.MetricsAdvisor.Models.DataPointAnomaly> GetAnomaliesForAlertAsync (string alertConfigurationId, string alertId, Azure.AI.MetricsAdvisor.GetAnomaliesForAlertOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetAnomaliesForAlertAsync : string * string * Azure.AI.MetricsAdvisor.GetAnomaliesForAlertOptions * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.AI.MetricsAdvisor.Models.DataPointAnomaly>
override this.GetAnomaliesForAlertAsync : string * string * Azure.AI.MetricsAdvisor.GetAnomaliesForAlertOptions * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.AI.MetricsAdvisor.Models.DataPointAnomaly>

Public Overridable Function GetAnomaliesForAlertAsync (alertConfigurationId As String, alertId As String, Optional options As GetAnomaliesForAlertOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of DataPointAnomaly)

Parameters

alertConfigurationId

String

The unique identifier of the AnomalyAlertConfiguration.

alertId

String

The unique identifier of the alert.

options

GetAnomaliesForAlertOptions

An optional set of options used to configure the request's behavior.

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

AsyncPageable<DataPointAnomaly>

An AsyncPageable<T> containing the collection of DataPointAnomaly instances.

Exceptions

ArgumentNullException

alertConfigurationId or alertId is null.

ArgumentException

alertConfigurationId or alertId is empty; or alertConfigurationId is not a valid GUID.