Package com.azure.resourcemanager.apimanagement.fluent

Interface NotificationRecipientUsersClient

public interface NotificationRecipientUsersClient

An instance of this class provides access to all the operations defined in NotificationRecipientUsersClient.

Method Summary

Modifier and Type	Method	Description
boolean	checkEntityExists(String resourceGroupName, String serviceName, NotificationName notificationName, String userId)	Determine if the Notification Recipient User is subscribed to the notification.
com.azure.core.http.rest.Response<Boolean>	checkEntityExistsWithResponse(String resourceGroupName, String serviceName, NotificationName notificationName, String userId, com.azure.core.util.Context context)	Determine if the Notification Recipient User is subscribed to the notification.
RecipientUserContractInner	createOrUpdate(String resourceGroupName, String serviceName, NotificationName notificationName, String userId)	Adds the API Management User to the list of Recipients for the Notification.
com.azure.core.http.rest.Response<RecipientUserContractInner>	createOrUpdateWithResponse(String resourceGroupName, String serviceName, NotificationName notificationName, String userId, com.azure.core.util.Context context)	Adds the API Management User to the list of Recipients for the Notification.
void	delete(String resourceGroupName, String serviceName, NotificationName notificationName, String userId)	Removes the API Management user from the list of Notification.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, NotificationName notificationName, String userId, com.azure.core.util.Context context)	Removes the API Management user from the list of Notification.
RecipientUserCollectionInner	listByNotification(String resourceGroupName, String serviceName, NotificationName notificationName)	Gets the list of the Notification Recipient User subscribed to the notification.
com.azure.core.http.rest.Response<RecipientUserCollectionInner>	listByNotificationWithResponse(String resourceGroupName, String serviceName, NotificationName notificationName, com.azure.core.util.Context context)	Gets the list of the Notification Recipient User subscribed to the notification.

Method Detail

listByNotification

RecipientUserCollectionInner listByNotification(String resourceGroupName,
                                                String serviceName,
                                                NotificationName notificationName)

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

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

notificationName - Notification Name Identifier.

Returns:

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByNotificationWithResponse

com.azure.core.http.rest.Response<RecipientUserCollectionInner> listByNotificationWithResponse(String resourceGroupName,
                                                                                               String serviceName,
                                                                                               NotificationName notificationName,
                                                                                               com.azure.core.util.Context context)

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

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

notificationName - Notification Name Identifier.

context - The context to associate with this operation.

Returns:

the list of the Notification Recipient User subscribed to the notification along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

checkEntityExists

boolean checkEntityExists(String resourceGroupName,
                          String serviceName,
                          NotificationName notificationName,
                          String userId)

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

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

notificationName - Notification Name Identifier.

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

Returns:

whether resource exists.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

checkEntityExistsWithResponse

com.azure.core.http.rest.Response<Boolean> checkEntityExistsWithResponse(String resourceGroupName,
                                                                         String serviceName,
                                                                         NotificationName notificationName,
                                                                         String userId,
                                                                         com.azure.core.util.Context context)

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

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

notificationName - Notification Name Identifier.

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

context - The context to associate with this operation.

Returns:

whether resource exists along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

RecipientUserContractInner createOrUpdate(String resourceGroupName,
                                          String serviceName,
                                          NotificationName notificationName,
                                          String userId)

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

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

notificationName - Notification Name Identifier.

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

Returns:

recipient User details.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdateWithResponse

com.azure.core.http.rest.Response<RecipientUserContractInner> createOrUpdateWithResponse(String resourceGroupName,
                                                                                         String serviceName,
                                                                                         NotificationName notificationName,
                                                                                         String userId,
                                                                                         com.azure.core.util.Context context)

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

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

notificationName - Notification Name Identifier.

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

context - The context to associate with this operation.

Returns:

recipient User details along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String serviceName,
            NotificationName notificationName,
            String userId)

Removes the API Management user from the list of Notification.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

notificationName - Notification Name Identifier.

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteWithResponse

com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName,
                                                           String serviceName,
                                                           NotificationName notificationName,
                                                           String userId,
                                                           com.azure.core.util.Context context)

Removes the API Management user from the list of Notification.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

notificationName - Notification Name Identifier.

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

context - The context to associate with this operation.

Returns:

the Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.