Package com.azure.resourcemanager.apimanagement.fluent

Interface WorkspaceNotificationsClient

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

  • Method Details

    • listByService

      com.azure.core.http.rest.PagedIterable<NotificationContractInner> listByService(String resourceGroupName, String serviceName, String workspaceId)
      Lists a collection of properties defined within a service instance.
      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.
      Returns:
      paged Notification list representation as paginated response with PagedIterable.
      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.

    • listByService

      com.azure.core.http.rest.PagedIterable<NotificationContractInner> listByService(String resourceGroupName, String serviceName, String workspaceId, Integer top, Integer skip, com.azure.core.util.Context context)
      Lists a collection of properties defined within a service instance.
      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.
      top - Number of records to return.
      skip - Number of records to skip.
      context - The context to associate with this operation.
      Returns:
      paged Notification list representation as paginated response with PagedIterable.
      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.

    • getWithResponse

      com.azure.core.http.rest.Response<NotificationContractInner> getWithResponse(String resourceGroupName, String serviceName, String workspaceId, NotificationName notificationName, com.azure.core.util.Context context)
      Gets the details of the Notification specified by its identifier.
      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 details of the Notification specified by its identifier 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.

    • get

      NotificationContractInner get(String resourceGroupName, String serviceName, String workspaceId, NotificationName notificationName)
      Gets the details of the Notification specified by its identifier.
      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 details of the Notification specified by its 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.

    • createOrUpdateWithResponse

      com.azure.core.http.rest.Response<NotificationContractInner> createOrUpdateWithResponse(String resourceGroupName, String serviceName, String workspaceId, NotificationName notificationName, String ifMatch, com.azure.core.util.Context context)
      Create or Update API Management publisher notification for the workspace.
      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.
      ifMatch - ETag of the Entity. Not required when creating an entity, but required when updating an entity.
      context - The context to associate with this operation.
      Returns:
      notification 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

      NotificationContractInner createOrUpdate(String resourceGroupName, String serviceName, String workspaceId, NotificationName notificationName)
      Create or Update API Management publisher notification for the workspace.
      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:
      notification 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.