WebNotificationHook Class

Definition

Namespace:

Azure.AI.MetricsAdvisor.Administration

Assembly:

Azure.AI.MetricsAdvisor.dll

Package:

Azure.AI.MetricsAdvisor v1.1.0

Source:

WebNotificationHook.cs

The WebhookHookInfo.

public class WebNotificationHook : Azure.AI.MetricsAdvisor.Administration.NotificationHook

type WebNotificationHook = class
    inherit NotificationHook

Public Class WebNotificationHook
Inherits NotificationHook

Inheritance

Object

NotificationHook

WebNotificationHook

Remarks

In order to create a web hook, you must pass this instance to the method CreateHookAsync(NotificationHook, CancellationToken). When a web hook is created or modified, the Endpoint will be called as a test with an empty request body. Your API needs to return a 200 HTTP code to successfully pass the validation.

Constructors

WebNotificationHook(String, Uri)

Initializes a new instance of the WebNotificationHook 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)
CertificateKey	The certificate key for authenticating to the API address. Leave this blank if authentication isn't needed. Defaults to an empty string.
CertificatePassword	The certificate password for authenticating to the API address. Leave this blank if authentication isn't needed. Defaults to an empty string.
Description	A description of this NotificationHook. Defaults to an empty string. (Inherited from NotificationHook)
Endpoint	The API address to be called when an alert is triggered.
ExternalUri	Optional field which enables a customized redirect, such as for troubleshooting notes. Defaults to an empty string. (Inherited from NotificationHook)
Headers	Custom headers to send in the API call.
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)
Password	The password for authenticating to the API address. Leave this blank if authentication isn't needed. Defaults to an empty string.
Username	The username for authenticating to the API address. Leave this blank if authentication isn't needed. Defaults to an empty string.