TasksOperations Class

TasksOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

TasksOperations

Constructor

TasksOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

cancel	Cancel a task. 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	Execute a command on a task. 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.
create_or_update	Create or update task. 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	Delete task. 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	Get task information. 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	Get tasks in a service. 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	Create or update task. 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.

cancel

Cancel a task.

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.

cancel(group_name: str, service_name: str, project_name: str, task_name: str, **kwargs: Any) -> _models.ProjectTask

Parameters

group_name

str

Required

Name of the resource group.

service_name

str

Required

Name of the service.

project_name

str

Required

Name of the project.

task_name

str

Required

Name of the Task.

cls

callable

A custom type or function that will be passed the direct response

Returns

ProjectTask, or the result of cls(response)

Return type

ProjectTask

Exceptions

HttpResponseError

command

Execute a command on a task.

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.

command(group_name: str, service_name: str, project_name: str, task_name: str, parameters: _models.CommandProperties, **kwargs: Any) -> _models.CommandProperties

Parameters

group_name

str

Required

Name of the resource group.

service_name

str

Required

Name of the service.

project_name

str

Required

Name of the project.

task_name

str

Required

Name of the Task.

parameters

CommandProperties

Required

Command to execute.

cls

callable

A custom type or function that will be passed the direct response

Returns

CommandProperties, or the result of cls(response)

Return type

CommandProperties

Exceptions

HttpResponseError

create_or_update

Create or update task.

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.

create_or_update(group_name: str, service_name: str, project_name: str, task_name: str, parameters: _models.ProjectTask, **kwargs: Any) -> _models.ProjectTask

Parameters

group_name

str

Required

Name of the resource group.

service_name

str

Required

Name of the service.

project_name

str

Required

Name of the project.

task_name

str

Required

Name of the Task.

parameters

ProjectTask

Required

Information about the task.

cls

callable

A custom type or function that will be passed the direct response

Returns

ProjectTask, or the result of cls(response)

Return type

ProjectTask

Exceptions

HttpResponseError

delete

Delete task.

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.

delete(group_name: str, service_name: str, project_name: str, task_name: str, delete_running_tasks: Optional[bool] = None, **kwargs: Any) -> None

Parameters

group_name

str

Required

Name of the resource group.

service_name

str

Required

Name of the service.

project_name

str

Required

Name of the project.

task_name

str

Required

Name of the Task.

delete_running_tasks

bool

default value: None

Delete the resource even if it contains running tasks.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

Get task information.

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

get(group_name: str, service_name: str, project_name: str, task_name: str, expand: Optional[str] = None, **kwargs: Any) -> _models.ProjectTask

Parameters

group_name

str

Required

Name of the resource group.

service_name

str

Required

Name of the service.

project_name

str

Required

Name of the project.

task_name

str

Required

Name of the Task.

expand

str

default value: None

Expand the response.

cls

callable

A custom type or function that will be passed the direct response

Returns

ProjectTask, or the result of cls(response)

Return type

ProjectTask

Exceptions

HttpResponseError

list

Get tasks in a service.

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.

list(group_name: str, service_name: str, project_name: str, task_type: Optional[str] = None, **kwargs: Any) -> Iterable[_models.TaskList]

Parameters

group_name

str

Required

Name of the resource group.

service_name

str

Required

Name of the service.

project_name

str

Required

Name of the project.

task_type

str

default value: None

Filter tasks by task type.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either TaskList or the result of cls(response)

Return type

ItemPaged[TaskList]

Exceptions

HttpResponseError

update

Create or update task.

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.

update(group_name: str, service_name: str, project_name: str, task_name: str, parameters: _models.ProjectTask, **kwargs: Any) -> _models.ProjectTask

Parameters

group_name

str

Required

Name of the resource group.

service_name

str

Required

Name of the service.

project_name

str

Required

Name of the project.

task_name

str

Required

Name of the Task.

parameters

ProjectTask

Required

Information about the task.

cls

callable

A custom type or function that will be passed the direct response

Returns

ProjectTask, or the result of cls(response)

Return type

ProjectTask

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.datamigration.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\datamigration\\models\\__init__.py'>