Package com.azure.resourcemanager.datamigration.models

Interface Projects

public interface Projects
Resource collection API of Projects.

  • Method Details

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<Project> listByResourceGroup(String groupName, String serviceName)
      Get projects in a service

      The project resource is a nested resource representing a stored migration project. This method returns a list of projects owned by a service resource.

      Parameters:
      groupName - Name of the resource group.
      serviceName - Name of the service.
      Returns:
      oData page of project resources 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<Project> listByResourceGroup(String groupName, String serviceName, com.azure.core.util.Context context)
      Get projects in a service

      The project resource is a nested resource representing a stored migration project. This method returns a list of projects owned by a service resource.

      Parameters:
      groupName - Name of the resource group.
      serviceName - Name of the service.
      context - The context to associate with this operation.
      Returns:
      oData page of project resources 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<Project> getWithResponse(String groupName, String serviceName, String projectName, com.azure.core.util.Context context)
      Get project information

      The project resource is a nested resource representing a stored migration project. The GET method retrieves information about a project.

      Parameters:
      groupName - Name of the resource group.
      serviceName - Name of the service.
      projectName - Name of the project.
      context - The context to associate with this operation.
      Returns:
      a project resource 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

      Project get(String groupName, String serviceName, String projectName)
      Get project information

      The project resource is a nested resource representing a stored migration project. The GET method retrieves information about a project.

      Parameters:
      groupName - Name of the resource group.
      serviceName - Name of the service.
      projectName - Name of the project.
      Returns:
      a project resource.
      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 groupName, String serviceName, String projectName, Boolean deleteRunningTasks, com.azure.core.util.Context context)
      Delete project

      The project resource is a nested resource representing a stored migration project. The DELETE method deletes a project.

      Parameters:
      groupName - Name of the resource group.
      serviceName - Name of the service.
      projectName - Name of the project.
      deleteRunningTasks - Delete the resource even if it contains running tasks.
      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 groupName, String serviceName, String projectName)
      Delete project

      The project resource is a nested resource representing a stored migration project. The DELETE method deletes a project.

      Parameters:
      groupName - Name of the resource group.
      serviceName - Name of the service.
      projectName - Name of the project.
      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

      Project getById(String id)
      Get project information

      The project resource is a nested resource representing a stored migration project. The GET method retrieves information about a project.

      Parameters:
      id - the resource ID.
      Returns:
      a project resource 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<Project> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Get project information

      The project resource is a nested resource representing a stored migration project. The GET method retrieves information about a project.

      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      a project resource 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

      void deleteById(String id)
      Delete project

      The project resource is a nested resource representing a stored migration project. The DELETE method deletes a project.

      Parameters:
      id - the resource ID.
      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

      com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id, Boolean deleteRunningTasks, com.azure.core.util.Context context)
      Delete project

      The project resource is a nested resource representing a stored migration project. The DELETE method deletes a project.

      Parameters:
      id - the resource ID.
      deleteRunningTasks - Delete the resource even if it contains running tasks.
      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.

    • define

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