MetricsAdvisorClient.GetAlertsAsync Method

Definition

Gets a collection of items describing the alerts triggered by a given AnomalyAlertConfiguration.

public virtual Azure.AsyncPageable<Azure.AI.MetricsAdvisor.Models.AnomalyAlert> GetAlertsAsync (string alertConfigurationId, Azure.AI.MetricsAdvisor.GetAlertsOptions options, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAlertsAsync : string * Azure.AI.MetricsAdvisor.GetAlertsOptions * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.AI.MetricsAdvisor.Models.AnomalyAlert>
override this.GetAlertsAsync : string * Azure.AI.MetricsAdvisor.GetAlertsOptions * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.AI.MetricsAdvisor.Models.AnomalyAlert>
Public Overridable Function GetAlertsAsync (alertConfigurationId As String, options As GetAlertsOptions, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of AnomalyAlert)

Parameters

alertConfigurationId
String

The unique identifier of the AnomalyAlertConfiguration.

options
GetAlertsOptions

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

cancellationToken
CancellationToken

A CancellationToken controlling the request lifetime.

Returns

An AsyncPageable<T> containing the collection of AnomalyAlerts.

Exceptions

alertConfigurationId or options is null.

alertConfigurationId is empty or not a valid GUID.

Applies to