Package com.azure.resourcemanager.apimanagement.models

Interface NotificationRecipientEmails

public interface NotificationRecipientEmails

Resource collection API of NotificationRecipientEmails.

Method Summary

Modifier and Type	Method	Description
boolean	checkEntityExists(String resourceGroupName, String serviceName, NotificationName notificationName, String email)	Determine if Notification Recipient Email subscribed to the notification.
com.azure.core.http.rest.Response<Boolean>	checkEntityExistsWithResponse(String resourceGroupName, String serviceName, NotificationName notificationName, String email, com.azure.core.util.Context context)	Determine if Notification Recipient Email subscribed to the notification.
RecipientEmailContract	createOrUpdate(String resourceGroupName, String serviceName, NotificationName notificationName, String email)	Adds the Email address to the list of Recipients for the Notification.
com.azure.core.http.rest.Response<RecipientEmailContract>	createOrUpdateWithResponse(String resourceGroupName, String serviceName, NotificationName notificationName, String email, com.azure.core.util.Context context)	Adds the Email address to the list of Recipients for the Notification.
void	delete(String resourceGroupName, String serviceName, NotificationName notificationName, String email)	Removes the email from the list of Notification.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, NotificationName notificationName, String email, com.azure.core.util.Context context)	Removes the email from the list of Notification.
RecipientEmailCollection	listByNotification(String resourceGroupName, String serviceName, NotificationName notificationName)	Gets the list of the Notification Recipient Emails subscribed to a notification.
com.azure.core.http.rest.Response<RecipientEmailCollection>	listByNotificationWithResponse(String resourceGroupName, String serviceName, NotificationName notificationName, com.azure.core.util.Context context)	Gets the list of the Notification Recipient Emails subscribed to a notification.

Method Detail

listByNotification

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

Gets the list of the Notification Recipient Emails subscribed to a 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 Emails subscribed to a 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<RecipientEmailCollection> listByNotificationWithResponse(String resourceGroupName,
                                                                                           String serviceName,
                                                                                           NotificationName notificationName,
                                                                                           com.azure.core.util.Context context)

Gets the list of the Notification Recipient Emails subscribed to a 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 Emails subscribed to a 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 email)

Determine if Notification Recipient Email subscribed to the notification.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

notificationName - Notification Name Identifier.

email - Email identifier.

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 email,
                                                                         com.azure.core.util.Context context)

Determine if Notification Recipient Email subscribed to the notification.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

notificationName - Notification Name Identifier.

email - Email identifier.

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

RecipientEmailContract createOrUpdate(String resourceGroupName,
                                      String serviceName,
                                      NotificationName notificationName,
                                      String email)

Adds the Email address 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.

email - Email identifier.

Returns:

recipient Email 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<RecipientEmailContract> createOrUpdateWithResponse(String resourceGroupName,
                                                                                     String serviceName,
                                                                                     NotificationName notificationName,
                                                                                     String email,
                                                                                     com.azure.core.util.Context context)

Adds the Email address 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.

email - Email identifier.

context - The context to associate with this operation.

Returns:

recipient Email 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 email)

Removes the email 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.

email - Email identifier.

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 email,
                                                           com.azure.core.util.Context context)

Removes the email 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.

email - Email identifier.

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.