WorkspaceNotificationRecipientEmail interface
Interface representing a WorkspaceNotificationRecipientEmail.
Methods
| check |
Determine if Notification Recipient Email subscribed to the notification. |
| create |
Adds the Email address to the list of Recipients for the Notification. |
| delete(string, string, string, string, string, Workspace |
Removes the email from the list of Notification. |
| list |
Gets the list of the Notification Recipient Emails subscribed to a notification. |
Method Details
checkEntityExists(string, string, string, string, string, WorkspaceNotificationRecipientEmailCheckEntityExistsOptionalParams)
Determine if Notification Recipient Email subscribed to the notification.
function checkEntityExists(resourceGroupName: string, serviceName: string, workspaceId: string, notificationName: string, email: string, options?: WorkspaceNotificationRecipientEmailCheckEntityExistsOptionalParams): Promise<WorkspaceNotificationRecipientEmailCheckEntityExistsResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- notificationName
-
string
Notification Name Identifier.
-
string
Email identifier.
The options parameters.
Returns
createOrUpdate(string, string, string, string, string, WorkspaceNotificationRecipientEmailCreateOrUpdateOptionalParams)
Adds the Email address to the list of Recipients for the Notification.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, notificationName: string, email: string, options?: WorkspaceNotificationRecipientEmailCreateOrUpdateOptionalParams): 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.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- notificationName
-
string
Notification Name Identifier.
-
string
Email identifier.
The options parameters.
Returns
Promise<RecipientEmailContract>
delete(string, string, string, string, string, WorkspaceNotificationRecipientEmailDeleteOptionalParams)
Removes the email from the list of Notification.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, notificationName: string, email: string, options?: WorkspaceNotificationRecipientEmailDeleteOptionalParams): 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.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- notificationName
-
string
Notification Name Identifier.
-
string
Email identifier.
The options parameters.
Returns
Promise<void>
listByNotification(string, string, string, string, WorkspaceNotificationRecipientEmailListByNotificationOptionalParams)
Gets the list of the Notification Recipient Emails subscribed to a notification.
function listByNotification(resourceGroupName: string, serviceName: string, workspaceId: string, notificationName: string, options?: WorkspaceNotificationRecipientEmailListByNotificationOptionalParams): 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.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- notificationName
-
string
Notification Name Identifier.
The options parameters.
Returns
Promise<RecipientEmailCollection>