MetricsAdvisorClient.GetAlertsAsync Method

Definition

Namespace:

Azure.AI.MetricsAdvisor

Assembly:

Azure.AI.MetricsAdvisor.dll

Package:

Azure.AI.MetricsAdvisor v1.1.0

Source:

MetricsAdvisorClient.cs

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

AsyncPageable<AnomalyAlert>

An AsyncPageable<T> containing the collection of AnomalyAlerts.

Exceptions

ArgumentNullException

alertConfigurationId or options is null.

ArgumentException

alertConfigurationId is empty or not a valid GUID.