Package com.azure.resourcemanager.apimanagement.fluent

Interface WorkspaceNotificationRecipientUsersClient

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

  • Method Details

    • listByNotificationWithResponse

      com.azure.core.http.rest.Response<RecipientUserCollectionInner> listByNotificationWithResponse(String resourceGroupName, String serviceName, String workspaceId, 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. 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 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.

    • listByNotification

      RecipientUserCollectionInner listByNotification(String resourceGroupName, String serviceName, String workspaceId, NotificationName notificationName)
      Gets the list of the Notification Recipient User 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.
      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.

    • checkEntityExistsWithResponse

      com.azure.core.http.rest.Response<Boolean> checkEntityExistsWithResponse(String resourceGroupName, String serviceName, String workspaceId, 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. 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.
      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.

    • checkEntityExists

      boolean checkEntityExists(String resourceGroupName, String serviceName, String workspaceId, NotificationName notificationName, String userId)
      Determine if the Notification Recipient User is 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.
      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.

    • createOrUpdateWithResponse

      com.azure.core.http.rest.Response<RecipientUserContractInner> createOrUpdateWithResponse(String resourceGroupName, String serviceName, String workspaceId, 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. 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.
      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.

    • createOrUpdate

      RecipientUserContractInner createOrUpdate(String resourceGroupName, String serviceName, String workspaceId, 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. 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.
      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.

    • deleteWithResponse

      com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String serviceName, String workspaceId, 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. 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.
      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.

    • delete

      void delete(String resourceGroupName, String serviceName, String workspaceId, NotificationName notificationName, String userId)
      Removes the API Management user 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.
      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.