Package com.azure.resourcemanager.synapse.models

Interface Workspaces

public interface Workspaces
Resource collection API of Workspaces.

  • Method Details

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<Workspace> listByResourceGroup(String resourceGroupName)
      Returns a list of workspaces in a resource group.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      Returns:
      list of workspaces 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.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<Workspace> listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)
      Returns a list of workspaces in a resource group.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      context - The context to associate with this operation.
      Returns:
      list of workspaces 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.

    • getByResourceGroupWithResponse

      com.azure.core.http.rest.Response<Workspace> getByResourceGroupWithResponse(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)
      Gets a workspace.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      context - The context to associate with this operation.
      Returns:
      a workspace 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.

    • getByResourceGroup

      Workspace getByResourceGroup(String resourceGroupName, String workspaceName)
      Gets a workspace.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      Returns:
      a workspace.
      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.

    • deleteByResourceGroup

      Workspace deleteByResourceGroup(String resourceGroupName, String workspaceName)
      Deletes a workspace.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      Returns:
      a workspace.
      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

      Workspace delete(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)
      Deletes a workspace.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      context - The context to associate with this operation.
      Returns:
      a workspace.
      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.

    • list

      com.azure.core.http.rest.PagedIterable<Workspace> list()
      Returns a list of workspaces in a subscription.
      Returns:
      list of workspaces as paginated response with PagedIterable.
      Throws:
      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.

    • list

      com.azure.core.http.rest.PagedIterable<Workspace> list(com.azure.core.util.Context context)
      Returns a list of workspaces in a subscription.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      list of workspaces 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.

    • getById

      Workspace getById(String id)
      Gets a workspace.
      Parameters:
      id - the resource ID.
      Returns:
      a workspace 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.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<Workspace> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Gets a workspace.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      a workspace 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.

    • deleteById

      Workspace deleteById(String id)
      Deletes a workspace.
      Parameters:
      id - the resource ID.
      Returns:
      a workspace.
      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.

    • deleteByIdWithResponse

      Workspace deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Deletes a workspace.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      a workspace.
      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.

    • define

      Workspace.DefinitionStages.Blank define(String name)
      Begins definition for a new Workspace resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new Workspace definition.