WorkspaceNotificationRecipientUser interface
Interface representing a WorkspaceNotificationRecipientUser.
Methods
| check |
Determine if the Notification Recipient User is subscribed to the notification. |
| create |
Adds the API Management User to the list of Recipients for the Notification. |
| delete(string, string, string, string, string, Workspace |
Removes the API Management user from the list of Notification. |
| list |
Gets the list of the Notification Recipient User subscribed to the notification. |
Method Details
checkEntityExists(string, string, string, string, string, WorkspaceNotificationRecipientUserCheckEntityExistsOptionalParams)
Determine if the Notification Recipient User is subscribed to the notification.
function checkEntityExists(resourceGroupName: string, serviceName: string, workspaceId: string, notificationName: string, userId: string, options?: WorkspaceNotificationRecipientUserCheckEntityExistsOptionalParams): Promise<WorkspaceNotificationRecipientUserCheckEntityExistsResponse>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.
- userId
-
string
User identifier. Must be unique in the current API Management service instance.
The options parameters.
Returns
createOrUpdate(string, string, string, string, string, WorkspaceNotificationRecipientUserCreateOrUpdateOptionalParams)
Adds the API Management User to the list of Recipients for the Notification.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, notificationName: string, userId: string, options?: WorkspaceNotificationRecipientUserCreateOrUpdateOptionalParams): 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.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- notificationName
-
string
Notification Name Identifier.
- userId
-
string
User identifier. Must be unique in the current API Management service instance.
The options parameters.
Returns
Promise<RecipientUserContract>
delete(string, string, string, string, string, WorkspaceNotificationRecipientUserDeleteOptionalParams)
Removes the API Management user from the list of Notification.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, notificationName: string, userId: string, options?: WorkspaceNotificationRecipientUserDeleteOptionalParams): 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.
- userId
-
string
User identifier. Must be unique in the current API Management service instance.
The options parameters.
Returns
Promise<void>
listByNotification(string, string, string, string, WorkspaceNotificationRecipientUserListByNotificationOptionalParams)
Gets the list of the Notification Recipient User subscribed to the notification.
function listByNotification(resourceGroupName: string, serviceName: string, workspaceId: string, notificationName: string, options?: WorkspaceNotificationRecipientUserListByNotificationOptionalParams): 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.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- notificationName
-
string
Notification Name Identifier.
The options parameters.
Returns
Promise<RecipientUserCollection>