NotificationRecipientUser interface

Package:

@azure/arm-apimanagement

Interface representing a NotificationRecipientUser.

Methods

checkEntityExists(string, string, string, string, NotificationRecipientUserCheckEntityExistsOptionalParams)	Determine if the Notification Recipient User is subscribed to the notification.
createOrUpdate(string, string, string, string, NotificationRecipientUserCreateOrUpdateOptionalParams)	Adds the API Management User to the list of Recipients for the Notification.
delete(string, string, string, string, NotificationRecipientUserDeleteOptionalParams)	Removes the API Management user from the list of Notification.
listByNotification(string, string, string, NotificationRecipientUserListByNotificationOptionalParams)	Gets the list of the Notification Recipient User subscribed to the notification.

Method Details

checkEntityExists(string, string, string, string, NotificationRecipientUserCheckEntityExistsOptionalParams)

Determine if the Notification Recipient User is subscribed to the notification.

function checkEntityExists(resourceGroupName: string, serviceName: string, notificationName: string, userId: string, options?: NotificationRecipientUserCheckEntityExistsOptionalParams): Promise<NotificationRecipientUserCheckEntityExistsResponse>

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.

userId

string

User identifier. Must be unique in the current API Management service instance.

options

NotificationRecipientUserCheckEntityExistsOptionalParams

The options parameters.

Returns

Promise<NotificationRecipientUserCheckEntityExistsResponse>

createOrUpdate(string, string, string, string, NotificationRecipientUserCreateOrUpdateOptionalParams)

Adds the API Management User to the list of Recipients for the Notification.

function createOrUpdate(resourceGroupName: string, serviceName: string, notificationName: string, userId: string, options?: NotificationRecipientUserCreateOrUpdateOptionalParams): Promise<RecipientUserContract>

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.

userId

string

User identifier. Must be unique in the current API Management service instance.

options

NotificationRecipientUserCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<RecipientUserContract>

delete(string, string, string, string, NotificationRecipientUserDeleteOptionalParams)

Removes the API Management user from the list of Notification.

function delete(resourceGroupName: string, serviceName: string, notificationName: string, userId: string, options?: NotificationRecipientUserDeleteOptionalParams): 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.

userId

string

User identifier. Must be unique in the current API Management service instance.

options

NotificationRecipientUserDeleteOptionalParams

The options parameters.

Returns

Promise<void>

listByNotification(string, string, string, NotificationRecipientUserListByNotificationOptionalParams)

Gets the list of the Notification Recipient User subscribed to the notification.

function listByNotification(resourceGroupName: string, serviceName: string, notificationName: string, options?: NotificationRecipientUserListByNotificationOptionalParams): Promise<RecipientUserCollection>

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

NotificationRecipientUserListByNotificationOptionalParams

The options parameters.

Returns

Promise<RecipientUserCollection>