Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Alerts

Package version

Class representing a Alerts.

Hierarchy

  • Alerts

Index

Constructors

Methods

Constructors

constructor

Methods

clear

  • clear(request: ClearAlertRequest, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • clear(request: ClearAlertRequest, resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<void>): void
  • clear(request: ClearAlertRequest, resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • Clear the alerts.

    Parameters

    • request: ClearAlertRequest

      The clear alert request.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • request: ClearAlertRequest

      The clear alert request.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • request: ClearAlertRequest

      The clear alert request.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

listByManager

  • listByManager(resourceGroupName: string, managerName: string, options?: Models.AlertsListByManagerOptionalParams): Promise<Models.AlertsListByManagerResponse>
  • listByManager(resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<AlertList>): void
  • listByManager(resourceGroupName: string, managerName: string, options: AlertsListByManagerOptionalParams, callback: msRest.ServiceCallback<AlertList>): void

  • Retrieves all the alerts in a manager.

    Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: Models.AlertsListByManagerOptionalParams

    Returns Promise<Models.AlertsListByManagerResponse>

    Promise<Models.AlertsListByManagerResponse>

  • Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<AlertList>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • options: AlertsListByManagerOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<AlertList>

      The callback

    Returns void

listByManagerNext

  • listByManagerNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.AlertsListByManagerNextResponse>
  • listByManagerNext(nextPageLink: string, callback: msRest.ServiceCallback<AlertList>): void
  • listByManagerNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AlertList>): void

  • Retrieves all the alerts in a manager.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.AlertsListByManagerNextResponse>

    Promise<Models.AlertsListByManagerNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<AlertList>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<AlertList>

      The callback

    Returns void

sendTestEmail

  • sendTestEmail(deviceName: string, request: SendTestAlertEmailRequest, resourceGroupName: string, managerName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • sendTestEmail(deviceName: string, request: SendTestAlertEmailRequest, resourceGroupName: string, managerName: string, callback: msRest.ServiceCallback<void>): void
  • sendTestEmail(deviceName: string, request: SendTestAlertEmailRequest, resourceGroupName: string, managerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • Sends a test alert email.

    Parameters

    • deviceName: string

      The device name.

    • request: SendTestAlertEmailRequest

      The send test alert email request.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • deviceName: string

      The device name.

    • request: SendTestAlertEmailRequest

      The send test alert email request.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • deviceName: string

      The device name.

    • request: SendTestAlertEmailRequest

      The send test alert email request.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

Generated using TypeDoc