Package com.azure.resourcemanager.datamigration.models

Interface Services

public interface Services
Resource collection API of Services.

  • Method Details

    • getByResourceGroupWithResponse

      com.azure.core.http.rest.Response<DataMigrationService> getByResourceGroupWithResponse(String groupName, String serviceName, com.azure.core.util.Context context)
      Get DMS Service Instance

      The services resource is the top-level resource that represents the Database Migration Service. The GET method retrieves information about a service instance.

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

    • getByResourceGroup

      DataMigrationService getByResourceGroup(String groupName, String serviceName)
      Get DMS Service Instance

      The services resource is the top-level resource that represents the Database Migration Service. The GET method retrieves information about a service instance.

      Parameters:
      groupName - Name of the resource group.
      serviceName - Name of the service.
      Returns:
      a Database Migration Service 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.

    • delete

      void delete(String groupName, String serviceName)
      Delete DMS Service Instance

      The services resource is the top-level resource that represents the Database Migration Service. The DELETE method deletes a service. Any running tasks will be canceled.

      Parameters:
      groupName - Name of the resource group.
      serviceName - Name of the service.
      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, Boolean deleteRunningTasks, com.azure.core.util.Context context)
      Delete DMS Service Instance

      The services resource is the top-level resource that represents the Database Migration Service. The DELETE method deletes a service. Any running tasks will be canceled.

      Parameters:
      groupName - Name of the resource group.
      serviceName - Name of the service.
      deleteRunningTasks - Delete the resource even if it contains running tasks.
      context - The context to associate with this operation.
      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.

    • checkStatusWithResponse

      com.azure.core.http.rest.Response<DataMigrationServiceStatusResponse> checkStatusWithResponse(String groupName, String serviceName, com.azure.core.util.Context context)
      Check service health status

      The services resource is the top-level resource that represents the Database Migration Service. This action performs a health check and returns the status of the service and virtual machine size.

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

    • checkStatus

      DataMigrationServiceStatusResponse checkStatus(String groupName, String serviceName)
      Check service health status

      The services resource is the top-level resource that represents the Database Migration Service. This action performs a health check and returns the status of the service and virtual machine size.

      Parameters:
      groupName - Name of the resource group.
      serviceName - Name of the service.
      Returns:
      service health status.
      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.

    • start

      void start(String groupName, String serviceName)
      Start service

      The services resource is the top-level resource that represents the Database Migration Service. This action starts the service and the service can be used for data migration.

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

    • start

      void start(String groupName, String serviceName, com.azure.core.util.Context context)
      Start service

      The services resource is the top-level resource that represents the Database Migration Service. This action starts the service and the service can be used for data migration.

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

    • stop

      void stop(String groupName, String serviceName)
      Stop service

      The services resource is the top-level resource that represents the Database Migration Service. This action stops the service and the service cannot be used for data migration. The service owner won't be billed when the service is stopped.

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

    • stop

      void stop(String groupName, String serviceName, com.azure.core.util.Context context)
      Stop service

      The services resource is the top-level resource that represents the Database Migration Service. This action stops the service and the service cannot be used for data migration. The service owner won't be billed when the service is stopped.

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

    • listSkus

      com.azure.core.http.rest.PagedIterable<AvailableServiceSku> listSkus(String groupName, String serviceName)
      Get compatible SKUs

      The services resource is the top-level resource that represents the Database Migration Service. The skus action returns the list of SKUs that a service resource can be updated to.

      Parameters:
      groupName - Name of the resource group.
      serviceName - Name of the service.
      Returns:
      oData page of available SKUs 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.

    • listSkus

      com.azure.core.http.rest.PagedIterable<AvailableServiceSku> listSkus(String groupName, String serviceName, com.azure.core.util.Context context)
      Get compatible SKUs

      The services resource is the top-level resource that represents the Database Migration Service. The skus action returns the list of SKUs that a service resource can be updated to.

      Parameters:
      groupName - Name of the resource group.
      serviceName - Name of the service.
      context - The context to associate with this operation.
      Returns:
      oData page of available SKUs 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.

    • nestedCheckNameAvailabilityWithResponse

      com.azure.core.http.rest.Response<NameAvailabilityResponse> nestedCheckNameAvailabilityWithResponse(String groupName, String serviceName, NameAvailabilityRequest parameters, com.azure.core.util.Context context)
      Check nested resource name validity and availability

      This method checks whether a proposed nested resource name is valid and available.

      Parameters:
      groupName - Name of the resource group.
      serviceName - Name of the service.
      parameters - Requested name to validate.
      context - The context to associate with this operation.
      Returns:
      indicates whether a proposed resource name is available 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.

    • nestedCheckNameAvailability

      NameAvailabilityResponse nestedCheckNameAvailability(String groupName, String serviceName, NameAvailabilityRequest parameters)
      Check nested resource name validity and availability

      This method checks whether a proposed nested resource name is valid and available.

      Parameters:
      groupName - Name of the resource group.
      serviceName - Name of the service.
      parameters - Requested name to validate.
      Returns:
      indicates whether a proposed resource name is available.
      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<DataMigrationService> listByResourceGroup(String groupName)
      Get services in resource group

      The Services resource is the top-level resource that represents the Database Migration Service. This method returns a list of service resources in a resource group.

      Parameters:
      groupName - Name of the resource group.
      Returns:
      oData page of service objects 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<DataMigrationService> listByResourceGroup(String groupName, com.azure.core.util.Context context)
      Get services in resource group

      The Services resource is the top-level resource that represents the Database Migration Service. This method returns a list of service resources in a resource group.

      Parameters:
      groupName - Name of the resource group.
      context - The context to associate with this operation.
      Returns:
      oData page of service objects 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.

    • list

      com.azure.core.http.rest.PagedIterable<DataMigrationService> list()
      Get services in subscription

      The services resource is the top-level resource that represents the Database Migration Service. This method returns a list of service resources in a subscription.

      Returns:
      oData page of service objects 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<DataMigrationService> list(com.azure.core.util.Context context)
      Get services in subscription

      The services resource is the top-level resource that represents the Database Migration Service. This method returns a list of service resources in a subscription.

      Parameters:
      context - The context to associate with this operation.
      Returns:
      oData page of service objects 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.

    • checkNameAvailabilityWithResponse

      com.azure.core.http.rest.Response<NameAvailabilityResponse> checkNameAvailabilityWithResponse(String location, NameAvailabilityRequest parameters, com.azure.core.util.Context context)
      Check name validity and availability

      This method checks whether a proposed top-level resource name is valid and available.

      Parameters:
      location - The Azure region of the operation.
      parameters - Requested name to validate.
      context - The context to associate with this operation.
      Returns:
      indicates whether a proposed resource name is available 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.

    • checkNameAvailability

      NameAvailabilityResponse checkNameAvailability(String location, NameAvailabilityRequest parameters)
      Check name validity and availability

      This method checks whether a proposed top-level resource name is valid and available.

      Parameters:
      location - The Azure region of the operation.
      parameters - Requested name to validate.
      Returns:
      indicates whether a proposed resource name is available.
      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

      DataMigrationService getById(String id)
      Get DMS Service Instance

      The services resource is the top-level resource that represents the Database Migration Service. The GET method retrieves information about a service instance.

      Parameters:
      id - the resource ID.
      Returns:
      a Database Migration Service 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<DataMigrationService> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Get DMS Service Instance

      The services resource is the top-level resource that represents the Database Migration Service. The GET method retrieves information about a service instance.

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

      The services resource is the top-level resource that represents the Database Migration Service. The DELETE method deletes a service. Any running tasks will be canceled.

      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

      void deleteByIdWithResponse(String id, Boolean deleteRunningTasks, com.azure.core.util.Context context)
      Delete DMS Service Instance

      The services resource is the top-level resource that represents the Database Migration Service. The DELETE method deletes a service. Any running tasks will be canceled.

      Parameters:
      id - the resource ID.
      deleteRunningTasks - Delete the resource even if it contains running tasks.
      context - The context to associate with this operation.
      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

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