Share via

NotificationChannel Class

  • Reference

A notification.

Variables are only populated by the server, and will be ignored when sending a request.

Constructor

NotificationChannel(*, location: str | None = None, tags: Dict[str, str] | None = None, web_hook_url: str | None = None, email_recipient: str | None = None, notification_locale: str | None = None, description: str | None = None, events: List[Event] | None = None, **kwargs)

Parameters

Name Description
location
Required
str

The location of the resource.
tags
Required
dict[str, str]

A set of tags. The tags of the resource.
web_hook_url
Required
str

The webhook URL to send notifications to.
email_recipient
Required
str

The email recipient to send notifications to (can be a list of semi- colon separated email addresses).
notification_locale
Required
str

The locale to use when sending a notification (fallback for unsupported languages is EN).
description
Required
str

Description of notification.
events
Required
list[Event]

The list of event for which this notification is enabled.

Keyword-Only Parameters

Name Description
location
Default value: None
tags
Default value: None
web_hook_url
Default value: None
email_recipient
Default value: None
notification_locale
Default value: None
description
Default value: None
events
Default value: None

Variables

Name Description
id
str

The identifier of the resource.
name
str

The name of the resource.
type
str

The type of the resource.
created_date
datetime

The creation date of the notification channel.
provisioning_state
str

The provisioning status of the resource.
unique_identifier
str

The unique immutable identifier of a resource (Guid).