NotificationChannels interface
Interface representing a NotificationChannels.
Methods
| create |
Create or replace an existing notification channel. |
| delete(string, string, string, Notification |
Delete notification channel. |
| get(string, string, string, Notification |
Get notification channel. |
| list(string, string, Notification |
List notification channels in a given lab. |
| notify(string, string, string, Notify |
Send notification to provided channel. |
| update(string, string, string, Notification |
Allows modifying tags of notification channels. All other properties will be ignored. |
Method Details
createOrUpdate(string, string, string, NotificationChannel, NotificationChannelsCreateOrUpdateOptionalParams)
Create or replace an existing notification channel.
function createOrUpdate(resourceGroupName: string, labName: string, name: string, notificationChannel: NotificationChannel, options?: NotificationChannelsCreateOrUpdateOptionalParams): Promise<NotificationChannel>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the notification channel.
- notificationChannel
- NotificationChannel
A notification.
The options parameters.
Returns
Promise<NotificationChannel>
delete(string, string, string, NotificationChannelsDeleteOptionalParams)
Delete notification channel.
function delete(resourceGroupName: string, labName: string, name: string, options?: NotificationChannelsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the notification channel.
The options parameters.
Returns
Promise<void>
get(string, string, string, NotificationChannelsGetOptionalParams)
Get notification channel.
function get(resourceGroupName: string, labName: string, name: string, options?: NotificationChannelsGetOptionalParams): Promise<NotificationChannel>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the notification channel.
The options parameters.
Returns
Promise<NotificationChannel>
list(string, string, NotificationChannelsListOptionalParams)
List notification channels in a given lab.
function list(resourceGroupName: string, labName: string, options?: NotificationChannelsListOptionalParams): PagedAsyncIterableIterator<NotificationChannel, NotificationChannel[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
The options parameters.
Returns
notify(string, string, string, NotifyParameters, NotificationChannelsNotifyOptionalParams)
Send notification to provided channel.
function notify(resourceGroupName: string, labName: string, name: string, notifyParameters: NotifyParameters, options?: NotificationChannelsNotifyOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the notification channel.
- notifyParameters
- NotifyParameters
Properties for generating a Notification.
The options parameters.
Returns
Promise<void>
update(string, string, string, NotificationChannelFragment, NotificationChannelsUpdateOptionalParams)
Allows modifying tags of notification channels. All other properties will be ignored.
function update(resourceGroupName: string, labName: string, name: string, notificationChannel: NotificationChannelFragment, options?: NotificationChannelsUpdateOptionalParams): Promise<NotificationChannel>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- name
-
string
The name of the notification channel.
- notificationChannel
- NotificationChannelFragment
A notification.
The options parameters.
Returns
Promise<NotificationChannel>