Interface Migrations

public interface Migrations
Resource collection API of Migrations.

  • Method Details

    • getWithResponse

      com.azure.core.http.rest.Response<Migration> getWithResponse(String resourceGroupName, String serverName, String migrationName, com.azure.core.util.Context context)
      Gets information about a migration.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serverName - The name of the server.
      migrationName - Name of migration.
      context - The context to associate with this operation.
      Returns:
      information about a migration 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

      Migration get(String resourceGroupName, String serverName, String migrationName)
      Gets information about a migration.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serverName - The name of the server.
      migrationName - Name of migration.
      Returns:
      information about a migration.
      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.

    • cancelWithResponse

      com.azure.core.http.rest.Response<Migration> cancelWithResponse(String resourceGroupName, String serverName, String migrationName, com.azure.core.util.Context context)
      Cancels an active migration.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serverName - The name of the server.
      migrationName - Name of migration.
      context - The context to associate with this operation.
      Returns:
      properties of a migration 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.

    • cancel

      Migration cancel(String resourceGroupName, String serverName, String migrationName)
      Cancels an active migration.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serverName - The name of the server.
      migrationName - Name of migration.
      Returns:
      properties of a migration.
      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.

    • listByTargetServer

      com.azure.core.http.rest.PagedIterable<Migration> listByTargetServer(String resourceGroupName, String serverName)
      Lists all migrations of a target flexible server.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serverName - The name of the server.
      Returns:
      list of migrations 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.

    • listByTargetServer

      com.azure.core.http.rest.PagedIterable<Migration> listByTargetServer(String resourceGroupName, String serverName, MigrationListFilter migrationListFilter, com.azure.core.util.Context context)
      Lists all migrations of a target flexible server.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serverName - The name of the server.
      migrationListFilter - Migration list filter. Indicates if the request should retrieve only active migrations or all migrations. Defaults to Active.
      context - The context to associate with this operation.
      Returns:
      list of migrations 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<MigrationNameAvailability> checkNameAvailabilityWithResponse(String resourceGroupName, String serverName, MigrationNameAvailabilityInner parameters, com.azure.core.util.Context context)
      Check the validity and availability of the given name, to assign it to a new migration. Checks if a proposed migration name is valid and available.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serverName - The name of the server.
      parameters - Parameters required to check if a migration name is valid and available.
      context - The context to associate with this operation.
      Returns:
      availability of a migration name 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

      MigrationNameAvailability checkNameAvailability(String resourceGroupName, String serverName, MigrationNameAvailabilityInner parameters)
      Check the validity and availability of the given name, to assign it to a new migration. Checks if a proposed migration name is valid and available.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serverName - The name of the server.
      parameters - Parameters required to check if a migration name is valid and available.
      Returns:
      availability of a migration name.
      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

      Migration getById(String id)
      Gets information about a migration.
      Parameters:
      id - the resource ID.
      Returns:
      information about a migration 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<Migration> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Gets information about a migration.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      information about a migration 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.

    • define

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