NotificationRecipientEmail interface

Package:

@azure/arm-apimanagement

Interface representing a NotificationRecipientEmail.

Methods

checkEntityExists(string, string, string, string, NotificationRecipientEmailCheckEntityExistsOptionalParams)	Determine if Notification Recipient Email subscribed to the notification.
createOrUpdate(string, string, string, string, NotificationRecipientEmailCreateOrUpdateOptionalParams)	Adds the Email address to the list of Recipients for the Notification.
delete(string, string, string, string, NotificationRecipientEmailDeleteOptionalParams)	Removes the email from the list of Notification.
listByNotification(string, string, string, NotificationRecipientEmailListByNotificationOptionalParams)	Gets the list of the Notification Recipient Emails subscribed to a notification.

Method Details

checkEntityExists(string, string, string, string, NotificationRecipientEmailCheckEntityExistsOptionalParams)

Determine if Notification Recipient Email subscribed to the notification.

function checkEntityExists(resourceGroupName: string, serviceName: string, notificationName: string, email: string, options?: NotificationRecipientEmailCheckEntityExistsOptionalParams): Promise<NotificationRecipientEmailCheckEntityExistsResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

notificationName

string

Notification Name Identifier.

email

string

Email identifier.

options

NotificationRecipientEmailCheckEntityExistsOptionalParams

The options parameters.

Returns

Promise<NotificationRecipientEmailCheckEntityExistsResponse>

createOrUpdate(string, string, string, string, NotificationRecipientEmailCreateOrUpdateOptionalParams)

Adds the Email address to the list of Recipients for the Notification.

function createOrUpdate(resourceGroupName: string, serviceName: string, notificationName: string, email: string, options?: NotificationRecipientEmailCreateOrUpdateOptionalParams): Promise<RecipientEmailContract>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

notificationName

string

Notification Name Identifier.

email

string

Email identifier.

options

NotificationRecipientEmailCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<RecipientEmailContract>

delete(string, string, string, string, NotificationRecipientEmailDeleteOptionalParams)

Removes the email from the list of Notification.

function delete(resourceGroupName: string, serviceName: string, notificationName: string, email: string, options?: NotificationRecipientEmailDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

notificationName

string

Notification Name Identifier.

email

string

Email identifier.

options

NotificationRecipientEmailDeleteOptionalParams

The options parameters.

Returns

Promise<void>

listByNotification(string, string, string, NotificationRecipientEmailListByNotificationOptionalParams)

Gets the list of the Notification Recipient Emails subscribed to a notification.

function listByNotification(resourceGroupName: string, serviceName: string, notificationName: string, options?: NotificationRecipientEmailListByNotificationOptionalParams): Promise<RecipientEmailCollection>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

notificationName

string

Notification Name Identifier.

options

NotificationRecipientEmailListByNotificationOptionalParams

The options parameters.

Returns

Promise<RecipientEmailCollection>