Tasks class

Create a Tasks.

new Tasks(client: DataMigrationServiceClientContext)

Parameters

The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. This method cancels a task if it's currently queued or running.

function cancel(groupName: string, serviceName: string, projectName: string, taskName: string, options?: RequestOptionsBase): Promise<TasksCancelResponse>

Parameters

Returns

Promise<Models.TasksCancelResponse>

function cancel(groupName: string, serviceName: string, projectName: string, taskName: string, options: RequestOptionsBase, callback: ServiceCallback<ProjectTask>)

Parameters

function cancel(groupName: string, serviceName: string, projectName: string, taskName: string, callback: ServiceCallback<ProjectTask>)

Parameters

The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. This method executes a command on a running task.

function command(groupName: string, serviceName: string, projectName: string, taskName: string, parameters: CommandPropertiesUnion, options?: RequestOptionsBase): Promise<TasksCommandResponse>

Parameters

Returns

Promise<Models.TasksCommandResponse>

function command(groupName: string, serviceName: string, projectName: string, taskName: string, parameters: CommandPropertiesUnion, options: RequestOptionsBase, callback: ServiceCallback<CommandPropertiesUnion>)

Parameters

function command(groupName: string, serviceName: string, projectName: string, taskName: string, parameters: CommandPropertiesUnion, callback: ServiceCallback<CommandPropertiesUnion>)

Parameters

The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PUT method creates a new task or updates an existing one, although since tasks have no mutable custom properties, there is little reason to update an existing one.

function createOrUpdate(parameters: ProjectTask, groupName: string, serviceName: string, projectName: string, taskName: string, options?: RequestOptionsBase): Promise<TasksCreateOrUpdateResponse>

Parameters

Returns

Promise<Models.TasksCreateOrUpdateResponse>

function createOrUpdate(parameters: ProjectTask, groupName: string, serviceName: string, projectName: string, taskName: string, options: RequestOptionsBase, callback: ServiceCallback<ProjectTask>)

Parameters

function createOrUpdate(parameters: ProjectTask, groupName: string, serviceName: string, projectName: string, taskName: string, callback: ServiceCallback<ProjectTask>)

Parameters

function deleteMethod(groupName: string, serviceName: string, projectName: string, taskName: string, callback: ServiceCallback<void>)

Parameters

The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The DELETE method deletes a task, canceling it first if it's running.

function deleteMethod(groupName: string, serviceName: string, projectName: string, taskName: string, options?: TasksDeleteMethodOptionalParams): Promise<RestResponse>

Parameters

Returns

Promise<msRest.RestResponse>

function deleteMethod(groupName: string, serviceName: string, projectName: string, taskName: string, options: TasksDeleteMethodOptionalParams, callback: ServiceCallback<void>)

Parameters

function get(groupName: string, serviceName: string, projectName: string, taskName: string, callback: ServiceCallback<ProjectTask>)

Parameters

The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The GET method retrieves information about a task.

function get(groupName: string, serviceName: string, projectName: string, taskName: string, options?: TasksGetOptionalParams): Promise<TasksGetResponse>

Parameters

Returns

Promise<Models.TasksGetResponse>

function get(groupName: string, serviceName: string, projectName: string, taskName: string, options: TasksGetOptionalParams, callback: ServiceCallback<ProjectTask>)

Parameters

function list(groupName: string, serviceName: string, projectName: string, callback: ServiceCallback<TaskList>)

Parameters

The services resource is the top-level resource that represents the Database Migration Service. This method returns a list of tasks owned by a service resource. Some tasks may have a status of Unknown, which indicates that an error occurred while querying the status of that task.

function list(groupName: string, serviceName: string, projectName: string, options?: TasksListOptionalParams): Promise<TasksListResponse>

Parameters

Returns

Promise<Models.TasksListResponse>

function list(groupName: string, serviceName: string, projectName: string, options: TasksListOptionalParams, callback: ServiceCallback<TaskList>)

Parameters

The services resource is the top-level resource that represents the Database Migration Service. This method returns a list of tasks owned by a service resource. Some tasks may have a status of Unknown, which indicates that an error occurred while querying the status of that task.

function listNext(nextPageLink: string, options?: RequestOptionsBase): Promise<TasksListNextResponse>

Parameters

Returns

Promise<Models.TasksListNextResponse>

function listNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<TaskList>)

Parameters

function listNext(nextPageLink: string, callback: ServiceCallback<TaskList>)

Parameters

The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PATCH method updates an existing task, but since tasks have no mutable custom properties, there is little reason to do so.

function update(parameters: ProjectTask, groupName: string, serviceName: string, projectName: string, taskName: string, options?: RequestOptionsBase): Promise<TasksUpdateResponse>

Parameters

Returns

Promise<Models.TasksUpdateResponse>

function update(parameters: ProjectTask, groupName: string, serviceName: string, projectName: string, taskName: string, options: RequestOptionsBase, callback: ServiceCallback<ProjectTask>)

Parameters

function update(parameters: ProjectTask, groupName: string, serviceName: string, projectName: string, taskName: string, callback: ServiceCallback<ProjectTask>)

Parameters