Package com.azure.resourcemanager.apimanagement.fluent

Interface WorkspaceNotificationRecipientEmailsClient

public interface WorkspaceNotificationRecipientEmailsClient
An instance of this class provides access to all the operations defined in WorkspaceNotificationRecipientEmailsClient.

  • Method Details

    • listByNotificationWithResponse

      com.azure.core.http.rest.Response<RecipientEmailCollectionInner> listByNotificationWithResponse(String resourceGroupName, String serviceName, String workspaceId, 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. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      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.

    • listByNotification

      RecipientEmailCollectionInner listByNotification(String resourceGroupName, String serviceName, String workspaceId, NotificationName notificationName)
      Gets the list of the Notification Recipient Emails subscribed to a notification.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      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.

    • checkEntityExistsWithResponse

      com.azure.core.http.rest.Response<Boolean> checkEntityExistsWithResponse(String resourceGroupName, String serviceName, String workspaceId, 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. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      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.

    • checkEntityExists

      boolean checkEntityExists(String resourceGroupName, String serviceName, String workspaceId, NotificationName notificationName, String email)
      Determine if Notification Recipient Email subscribed to the notification.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      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.

    • createOrUpdateWithResponse

      com.azure.core.http.rest.Response<RecipientEmailContractInner> createOrUpdateWithResponse(String resourceGroupName, String serviceName, String workspaceId, 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. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      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.

    • createOrUpdate

      RecipientEmailContractInner createOrUpdate(String resourceGroupName, String serviceName, String workspaceId, NotificationName notificationName, String email)
      Adds the Email address to the list of Recipients for the Notification.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      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.

    • deleteWithResponse

      com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String serviceName, String workspaceId, 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. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      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.

    • delete

      void delete(String resourceGroupName, String serviceName, String workspaceId, NotificationName notificationName, String email)
      Removes the email from the list of Notification.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      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.