NotificationHook interface

Package:

@azure/ai-metrics-advisor

Represents properties common to hooks.

Properties

admins	The administrators of this NotificationHook. Administrators have total control over a NotificationHook, being allowed to update or delete. 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.
description	hook description
externalLink	hook external link
id	Hook unique id
name	hook unique name

Property Details

admins

The administrators of this NotificationHook. Administrators have total control over a NotificationHook, being allowed to update or delete. 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.

admins?: string[]

Property Value

string[]

description

hook description

description?: string

Property Value

string

externalLink

hook external link

externalLink?: string

Property Value

string

id

Hook unique id

id?: string

Property Value

string

name

hook unique name

name: string

Property Value

string