Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Tasks

Package version

Class representing a Tasks.

Hierarchy

  • Tasks

Index

Constructors

Methods

Constructors

constructor

Methods

cancel

  • cancel(groupName: string, serviceName: string, projectName: string, taskName: string, options?: msRest.RequestOptionsBase): Promise<Models.TasksCancelResponse>
  • cancel(groupName: string, serviceName: string, projectName: string, taskName: string, callback: msRest.ServiceCallback<ProjectTask>): void
  • cancel(groupName: string, serviceName: string, projectName: string, taskName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ProjectTask>): void

  • 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.

    summary

    Cancel a task

    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

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.TasksCancelResponse>

    Promise<Models.TasksCancelResponse>

  • 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

    • callback: msRest.ServiceCallback<ProjectTask>

      The callback

    Returns 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ProjectTask>

      The callback

    Returns void

command

  • command(groupName: string, serviceName: string, projectName: string, taskName: string, parameters: Models.CommandPropertiesUnion, options?: msRest.RequestOptionsBase): Promise<Models.TasksCommandResponse>
  • command(groupName: string, serviceName: string, projectName: string, taskName: string, parameters: Models.CommandPropertiesUnion, callback: msRest.ServiceCallback<Models.CommandPropertiesUnion>): void
  • command(groupName: string, serviceName: string, projectName: string, taskName: string, parameters: Models.CommandPropertiesUnion, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Models.CommandPropertiesUnion>): void

  • 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.

    summary

    Execute a command on a task

    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: Models.CommandPropertiesUnion

      Command to execute

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.TasksCommandResponse>

    Promise<Models.TasksCommandResponse>

  • 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: Models.CommandPropertiesUnion

      Command to execute

    • callback: msRest.ServiceCallback<Models.CommandPropertiesUnion>

      The callback

    Returns 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

    • parameters: Models.CommandPropertiesUnion

      Command to execute

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Models.CommandPropertiesUnion>

      The callback

    Returns void

createOrUpdate

  • createOrUpdate(parameters: ProjectTask, groupName: string, serviceName: string, projectName: string, taskName: string, options?: msRest.RequestOptionsBase): Promise<Models.TasksCreateOrUpdateResponse>
  • createOrUpdate(parameters: ProjectTask, groupName: string, serviceName: string, projectName: string, taskName: string, callback: msRest.ServiceCallback<ProjectTask>): void
  • createOrUpdate(parameters: ProjectTask, groupName: string, serviceName: string, projectName: string, taskName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ProjectTask>): void

  • 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.

    summary

    Create or update task

    Parameters

    • parameters: ProjectTask

      Information about the task

    • 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

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.TasksCreateOrUpdateResponse>

    Promise<Models.TasksCreateOrUpdateResponse>

  • Parameters

    • parameters: ProjectTask

      Information about the task

    • 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

    • callback: msRest.ServiceCallback<ProjectTask>

      The callback

    Returns void

  • Parameters

    • parameters: ProjectTask

      Information about the task

    • 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ProjectTask>

      The callback

    Returns void

deleteMethod

  • deleteMethod(groupName: string, serviceName: string, projectName: string, taskName: string, options?: Models.TasksDeleteMethodOptionalParams): Promise<msRest.RestResponse>
  • deleteMethod(groupName: string, serviceName: string, projectName: string, taskName: string, callback: msRest.ServiceCallback<void>): void
  • deleteMethod(groupName: string, serviceName: string, projectName: string, taskName: string, options: TasksDeleteMethodOptionalParams, callback: msRest.ServiceCallback<void>): void

  • 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.

    summary

    Delete task

    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

    • Optional options: Models.TasksDeleteMethodOptionalParams

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • 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

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns 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: TasksDeleteMethodOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

get

  • get(groupName: string, serviceName: string, projectName: string, taskName: string, options?: Models.TasksGetOptionalParams): Promise<Models.TasksGetResponse>
  • get(groupName: string, serviceName: string, projectName: string, taskName: string, callback: msRest.ServiceCallback<ProjectTask>): void
  • get(groupName: string, serviceName: string, projectName: string, taskName: string, options: TasksGetOptionalParams, callback: msRest.ServiceCallback<ProjectTask>): void

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

    summary

    Get task information

    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

    • Optional options: Models.TasksGetOptionalParams

    Returns Promise<Models.TasksGetResponse>

    Promise<Models.TasksGetResponse>

  • 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

    • callback: msRest.ServiceCallback<ProjectTask>

      The callback

    Returns 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: TasksGetOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<ProjectTask>

      The callback

    Returns void

list

  • list(groupName: string, serviceName: string, projectName: string, options?: Models.TasksListOptionalParams): Promise<Models.TasksListResponse>
  • list(groupName: string, serviceName: string, projectName: string, callback: msRest.ServiceCallback<TaskList>): void
  • list(groupName: string, serviceName: string, projectName: string, options: TasksListOptionalParams, callback: msRest.ServiceCallback<TaskList>): void

  • 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.

    summary

    Get tasks in a service

    Parameters

    • groupName: string

      Name of the resource group

    • serviceName: string

      Name of the service

    • projectName: string

      Name of the project

    • Optional options: Models.TasksListOptionalParams

    Returns Promise<Models.TasksListResponse>

    Promise<Models.TasksListResponse>

  • Parameters

    • groupName: string

      Name of the resource group

    • serviceName: string

      Name of the service

    • projectName: string

      Name of the project

    • callback: msRest.ServiceCallback<TaskList>

      The callback

    Returns void

  • Parameters

    • groupName: string

      Name of the resource group

    • serviceName: string

      Name of the service

    • projectName: string

      Name of the project

    • options: TasksListOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<TaskList>

      The callback

    Returns void

listNext

  • listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.TasksListNextResponse>
  • listNext(nextPageLink: string, callback: msRest.ServiceCallback<TaskList>): void
  • listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<TaskList>): void

  • 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.

    summary

    Get tasks in a service

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.TasksListNextResponse>

    Promise<Models.TasksListNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<TaskList>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<TaskList>

      The callback

    Returns void

update

  • update(parameters: ProjectTask, groupName: string, serviceName: string, projectName: string, taskName: string, options?: msRest.RequestOptionsBase): Promise<Models.TasksUpdateResponse>
  • update(parameters: ProjectTask, groupName: string, serviceName: string, projectName: string, taskName: string, callback: msRest.ServiceCallback<ProjectTask>): void
  • update(parameters: ProjectTask, groupName: string, serviceName: string, projectName: string, taskName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ProjectTask>): void

  • 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.

    summary

    Create or update task

    Parameters

    • parameters: ProjectTask

      Information about the task

    • 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

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.TasksUpdateResponse>

    Promise<Models.TasksUpdateResponse>

  • Parameters

    • parameters: ProjectTask

      Information about the task

    • 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

    • callback: msRest.ServiceCallback<ProjectTask>

      The callback

    Returns void

  • Parameters

    • parameters: ProjectTask

      Information about the task

    • 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ProjectTask>

      The callback

    Returns void

Generated using TypeDoc