Tasks interface

Package:

@azure/arm-datamigration

Interface representing a Tasks.

Methods

cancel(string, string, string, string, TasksCancelOptionalParams)	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.
command(string, string, string, string, CommandPropertiesUnion, TasksCommandOptionalParams)	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.
createOrUpdate(string, string, string, string, ProjectTask, TasksCreateOrUpdateOptionalParams)	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.
delete(string, string, string, string, TasksDeleteOptionalParams)	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.
get(string, string, string, string, TasksGetOptionalParams)	The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The GET method retrieves information about a task.
list(string, string, string, TasksListOptionalParams)	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.
update(string, string, string, string, ProjectTask, TasksUpdateOptionalParams)	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.

Method Details

cancel(string, string, string, string, TasksCancelOptionalParams)

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?: TasksCancelOptionalParams): Promise<ProjectTask>

Parameters

groupName

string

Name of the resource group

serviceName

string

Name of the service

projectName

string

Name of the project

taskName

string

Name of the Task

options

TasksCancelOptionalParams

The options parameters.

Returns

Promise<ProjectTask>

command(string, string, string, string, CommandPropertiesUnion, TasksCommandOptionalParams)

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?: TasksCommandOptionalParams): Promise<CommandPropertiesUnion>

Parameters

groupName

string

Name of the resource group

serviceName

string

Name of the service

projectName

string

Name of the project

taskName

string

Name of the Task

parameters

CommandPropertiesUnion

Command to execute

options

TasksCommandOptionalParams

The options parameters.

Returns

Promise<CommandPropertiesUnion>

createOrUpdate(string, string, string, string, ProjectTask, TasksCreateOrUpdateOptionalParams)

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(groupName: string, serviceName: string, projectName: string, taskName: string, parameters: ProjectTask, options?: TasksCreateOrUpdateOptionalParams): Promise<ProjectTask>

Parameters

groupName

string

Name of the resource group

serviceName

string

Name of the service

projectName

string

Name of the project

taskName

string

Name of the Task

parameters

ProjectTask

Information about the task

options

TasksCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ProjectTask>

delete(string, string, string, string, TasksDeleteOptionalParams)

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 delete(groupName: string, serviceName: string, projectName: string, taskName: string, options?: TasksDeleteOptionalParams): Promise<void>

Parameters

groupName

string

Name of the resource group

serviceName

string

Name of the service

projectName

string

Name of the project

taskName

string

Name of the Task

options

TasksDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, TasksGetOptionalParams)

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<ProjectTask>

Parameters

groupName

string

Name of the resource group

serviceName

string

Name of the service

projectName

string

Name of the project

taskName

string

Name of the Task

options

TasksGetOptionalParams

The options parameters.

Returns

Promise<ProjectTask>

list(string, string, string, TasksListOptionalParams)

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): PagedAsyncIterableIterator<ProjectTask, ProjectTask[], PageSettings>

Parameters

groupName

string

Name of the resource group

serviceName

string

Name of the service

projectName

string

Name of the project

options

TasksListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ProjectTask, ProjectTask[], PageSettings>

update(string, string, string, string, ProjectTask, TasksUpdateOptionalParams)

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(groupName: string, serviceName: string, projectName: string, taskName: string, parameters: ProjectTask, options?: TasksUpdateOptionalParams): Promise<ProjectTask>

Parameters

groupName

string

Name of the resource group

serviceName

string

Name of the service

projectName

string

Name of the project

taskName

string

Name of the Task

parameters

ProjectTask

Information about the task

options

TasksUpdateOptionalParams

The options parameters.

Returns

Promise<ProjectTask>