Alerts interface

Interface representing a Alerts.

Methods

clear(string, string, ClearAlertRequest, AlertsClearOptionalParams)

Clear the alerts.

listByManager(string, string, AlertsListByManagerOptionalParams)

Retrieves all the alerts in a manager.

sendTestEmail(string, string, string, SendTestAlertEmailRequest, AlertsSendTestEmailOptionalParams)

Sends a test alert email.

Method Details

clear(string, string, ClearAlertRequest, AlertsClearOptionalParams)

Clear the alerts.

function clear(resourceGroupName: string, managerName: string, request: ClearAlertRequest, options?: AlertsClearOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The resource group name

managerName

string

The manager name

request
ClearAlertRequest

The clear alert request.

options
AlertsClearOptionalParams

The options parameters.

Returns

Promise<void>

listByManager(string, string, AlertsListByManagerOptionalParams)

Retrieves all the alerts in a manager.

function listByManager(resourceGroupName: string, managerName: string, options?: AlertsListByManagerOptionalParams): PagedAsyncIterableIterator<Alert, Alert[], PageSettings>

Parameters

resourceGroupName

string

The resource group name

managerName

string

The manager name

options
AlertsListByManagerOptionalParams

The options parameters.

Returns

sendTestEmail(string, string, string, SendTestAlertEmailRequest, AlertsSendTestEmailOptionalParams)

Sends a test alert email.

function sendTestEmail(deviceName: string, resourceGroupName: string, managerName: string, request: SendTestAlertEmailRequest, options?: AlertsSendTestEmailOptionalParams): Promise<void>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name

managerName

string

The manager name

request
SendTestAlertEmailRequest

The send test alert email request.

options
AlertsSendTestEmailOptionalParams

The options parameters.

Returns

Promise<void>