Share via


EmailNotificationHook Class

Definition

The EmailHookInfo.

public class EmailNotificationHook : Azure.AI.MetricsAdvisor.Administration.NotificationHook
type EmailNotificationHook = class
    inherit NotificationHook
Public Class EmailNotificationHook
Inherits NotificationHook
Inheritance
EmailNotificationHook

Remarks

In order to create an e-mail hook, you must add at least one e-mail address to EmailsToAlert, and pass this instance to the method CreateHookAsync(NotificationHook, CancellationToken).

Constructors

EmailNotificationHook(String)

Initializes a new instance of the EmailNotificationHook class.

Properties

Administrators

The list of users with administrative rights to manage this hook. Each element in this list represents a user with administrator access, but the value of each string element depends on the type of authentication to be used by this administrator when communicating with the service. If MetricsAdvisorKeyCredential authentication will be used, the string must be the user's email address. If AAD authentication will be used instead, the string must uniquely identify the user's principal. For instance, for a ClientSecretCredential, the string must be the client ID.

(Inherited from NotificationHook)
Description

A description of this NotificationHook. Defaults to an empty string.

(Inherited from NotificationHook)
EmailsToAlert

The list of e-mail addresses to alert.

ExternalUri

Optional field which enables a customized redirect, such as for troubleshooting notes. Defaults to an empty string.

(Inherited from NotificationHook)
HookKind

The hook kind.

(Inherited from NotificationHook)
Id

The unique identifier of this NotificationHook.

(Inherited from NotificationHook)
Name

A custom name for this NotificationHook to be displayed on the web portal. Hook names must be unique across the same Metris Advisor resource.

(Inherited from NotificationHook)

Applies to