通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Tasks interface

包:
@azure/arm-datamigration

表示任务的接口。

方法

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

tasks 资源是嵌套的、仅代理的资源，表示 DMS（经典）实例执行的工作。 如果任务当前已排队或正在运行，此方法将取消该任务。
command(string, string, string, string, CommandPropertiesUnion, TasksCommandOptionalParams)

tasks 资源是嵌套的、仅代理的资源，表示 DMS（经典）实例执行的工作。 此方法对正在运行的任务执行命令。
createOrUpdate(string, string, string, string, ProjectTask, TasksCreateOrUpdateOptionalParams)

tasks 资源是嵌套的、仅代理的资源，表示 DMS（经典）实例执行的工作。 PUT 方法创建新的任务或更新现有任务，尽管由于任务没有可变的自定义属性，因此几乎没有理由更新现有任务。
delete(string, string, string, string, TasksDeleteOptionalParams)

tasks 资源是嵌套的、仅代理的资源，表示 DMS（经典）实例执行的工作。 DELETE 方法删除任务，如果任务正在运行，请先取消它。
get(string, string, string, string, TasksGetOptionalParams)

tasks 资源是嵌套的、仅代理的资源，表示 DMS（经典）实例执行的工作。 GET 方法检索有关任务的信息。
list(string, string, string, TasksListOptionalParams)

服务资源是表示 Azure 数据库迁移服务（经典）的顶级资源。 此方法返回服务资源拥有的任务列表。 某些任务的状态可能为“未知”，这表示查询该任务的状态时出错。
update(string, string, string, string, ProjectTask, TasksUpdateOptionalParams)

tasks 资源是嵌套的、仅代理的资源，表示 DMS（经典）实例执行的工作。 PATCH 方法更新现有任务，但由于任务没有可变的自定义属性，因此没有理由这样做。

方法详细信息

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

tasks 资源是嵌套的、仅代理的资源，表示 DMS（经典）实例执行的工作。 如果任务当前已排队或正在运行，此方法将取消该任务。

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

参数

groupName

string

资源组的名称

serviceName

string

服务的名称

projectName

string

项目的名称

taskName

string

任务的名称

options
TasksCancelOptionalParams

选项参数。

返回

Promise<ProjectTask>

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

tasks 资源是嵌套的、仅代理的资源，表示 DMS（经典）实例执行的工作。 此方法对正在运行的任务执行命令。

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

参数

groupName

string

资源组的名称

serviceName

string

服务的名称

projectName

string

项目的名称

taskName

string

任务的名称

parameters
CommandPropertiesUnion

要执行的命令

options
TasksCommandOptionalParams

选项参数。

返回

Promise<CommandPropertiesUnion>

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

tasks 资源是嵌套的、仅代理的资源，表示 DMS（经典）实例执行的工作。 PUT 方法创建新的任务或更新现有任务，尽管由于任务没有可变的自定义属性，因此几乎没有理由更新现有任务。

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

参数

groupName

string

资源组的名称

serviceName

string

服务的名称

projectName

string

项目的名称

taskName

string

任务的名称

parameters
ProjectTask

有关任务的信息

options
TasksCreateOrUpdateOptionalParams

选项参数。

返回

Promise<ProjectTask>

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

tasks 资源是嵌套的、仅代理的资源，表示 DMS（经典）实例执行的工作。 DELETE 方法删除任务，如果任务正在运行，请先取消它。

function delete(groupName: string, serviceName: string, projectName: string, taskName: string, options?: TasksDeleteOptionalParams): Promise<void>

参数

groupName

string

资源组的名称

serviceName

string

服务的名称

projectName

string

项目的名称

taskName

string

任务的名称

options
TasksDeleteOptionalParams

选项参数。

返回

Promise<void>

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

tasks 资源是嵌套的、仅代理的资源，表示 DMS（经典）实例执行的工作。 GET 方法检索有关任务的信息。

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

参数

groupName

string

资源组的名称

serviceName

string

服务的名称

projectName

string

项目的名称

taskName

string

任务的名称

options
TasksGetOptionalParams

选项参数。

返回

Promise<ProjectTask>

list(string, string, string, TasksListOptionalParams)

服务资源是表示 Azure 数据库迁移服务（经典）的顶级资源。 此方法返回服务资源拥有的任务列表。 某些任务的状态可能为“未知”，这表示查询该任务的状态时出错。

function list(groupName: string, serviceName: string, projectName: string, options?: TasksListOptionalParams): PagedAsyncIterableIterator<ProjectTask, ProjectTask[], PageSettings>

参数

groupName

string

资源组的名称

serviceName

string

服务的名称

projectName

string

项目的名称

options
TasksListOptionalParams

选项参数。

返回

PagedAsyncIterableIterator<ProjectTask, ProjectTask[], PageSettings>

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

tasks 资源是嵌套的、仅代理的资源，表示 DMS（经典）实例执行的工作。 PATCH 方法更新现有任务，但由于任务没有可变的自定义属性，因此没有理由这样做。

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

参数

groupName

string

资源组的名称

serviceName

string

服务的名称

projectName

string

项目的名称

taskName

string

任务的名称

parameters
ProjectTask

有关任务的信息

options
TasksUpdateOptionalParams

选项参数。

返回

Promise<ProjectTask>